ATattentive
Segments

Get segment by external ID

Changed on

Retrieves segment details by external ID.

Scopes Required: [segments:Read OR segments:Write]

Default Rate Limit: 100 requests per second

get/v2/segments/external/{externalId}

Request

  • Base URL
    https://api.attentivemobile.com
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://ui-devel.attentivemobile.com/integrations/oauth-install?client_id={clientId}&redirect_uri={redirectUri}&scope={scope}
      Token URL: https://api.attentivemobile.com/v1/authorization-codes/tokens scopes: segments:read

Path parameters

externalIdstring required

External ID of the segment

Response

Segment details

externalIdstring

The external segment ID (client-facing identifier)

namestring

The name of the segment

descriptionstring

The description of the segment

createdstring date-time

When the segment was created (ISO 8601 format)

updatedstring date-time

When the segment was last updated (ISO 8601 format)

Example response

{
  "externalId": "loyalty_gold_2025",
  "name": "Loyalty Gold Members",
  "description": "Customers with gold loyalty status",
  "created": "2025-01-30T12:00:00Z",
  "updated": "2025-01-30T12:00:00Z"
}

Changes