ATattentive
Segments

List segments

Changed on

Lists segments with optional filtering by name, external ID, or update timestamp.

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

Default Rate Limit: 100 requests per second

get/v2/segments

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

Query parameters

namestring

Filter by segment name (partial match). Cannot be empty or whitespace only.

externalIdstring

Filter by external ID. Cannot be empty or whitespace only.

updatedSincestring date-time

Filter by segments updated since this timestamp (ISO 8601 format)

cursorstring

Pagination cursor from previous response. Cannot be empty or whitespace only.

limitinteger

Maximum number of results to return (default 20, max 1000)

Response

List of segments

cursorstring nullable

Cursor for pagination (null if no more results)

hasMoreboolean

Whether there are more results available

Example response

{
  "segments": [
    {
      "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"
    }
  ],
  "cursor": "eyJpZCI6MTIzNDU2fQ=="
}

Changes