GET /experience-assignments

List Experience Assignments

Retrieve a filtered list of Experience Assignments. At least one filter parameter (such as targetType with targetValue, or accountId) must be provided. The filters are applied with a logical AND.

Query examples:

  • ?accountId=<id> — all assignments whose targets belong to the specific account
  • ?accountId=<id>&targetType=PHONE_NUMBER — all phone number target assignments in the account
  • ?targetType=USER&targetValue=<user-id> — all assignments for the specified user

Authentication

OAuth 2.0. Required scope(s): experience-assignments:manage.

Request

Path parameters

None.

Query parameters

Name Type Required Description
accountId string (uuid) no Filter by the account that owns the assignment targets. Returns all assignments whose targets (users, phone numbers or accounts) belong to the specified account.
experienceId string (uuid) no Filter by Experience ID. accountId is required when experienceId is provided; when both are given, returns all assignments for that Experience within the account.
cursor string no The cursor value returned from a previous paginated request. Used to retrieve the next page of results. When not provided, the first page of results is returned.
pageSize integer no The number of items to return per page. Used in conjunction with cursor for pagination. Default is 100, valid range between 1 and 100.
targetType TargetType no Filter by assignment target type. Required when targetValue is provided.
targetValue TargetValue no Filter by the exact target value of the assignment. When provided, targetType is required to interpret the value. Format depends on targetType: - PHONE_NUMBER: E.164 format (e.g., +14155551234) - USER: UUID format (e.g., c07881d7-200f-424e-b760-f24838f31eef) - ACCOUNT: UUID format (e.g., c07881d7-200f-424e-b760-f24838f31eef)

Headers

None.

Responses

200 — Experience Assignments retrieved successfully

Content-Type: application/json

Schema: PagedExperienceAssignmentList

Field Type Required Description
entities array of ExperienceAssignment yes List of Experience Assignments for the current page
cursor string no Cursor value to retrieve the next page of results. Null if there are no more pages.
pageSize integer yes Number of items per page

Spec gap. Cursor token behaviour is not documented — format, expiry, and stale-cursor error handling are unspecified. Treat cursor values as opaque strings; do not parse or cache them beyond the immediate pagination loop.

Gap ID b3512601d078

Example:

{
  "pageSize": 100,
  "entities": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "experienceId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "accountId": "d4e5f6a7-b8c9-0123-def0-234567890123",
      "targetType": "PHONE_NUMBER",
      "targetValue": "+14155551234"
    }
  ],
  "cursor": null
}

400 — Bad Request. Possible causes: - No filter parameter provided (at least accountId or targetType with targetValue is required) - targetValue provided without targetType - accountId is not a valid UUID - targetValue format does not match the expected format for the given targetType

Content-Type: application/problem+json

Schema: ProblemDetails

Example:

{
  "title": "Bad Request",
  "status": 400,
  "detail": "At least one filter parameter must be provided",
  "traceId": "6d4a3a62-0d4b-4b96-9171-8c5070e01c35"
}

401 — Unauthorized - Missing or expired access token. Obtain a new token and retry.

Content-Type: application/problem+json

Schema: ProblemDetails

Example:

{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Access token is missing or has expired",
  "traceId": "6d4a3a62-0d4b-4b96-9171-8c5070e01c35"
}

Errors

This operation may return:

  • 400 — Bad Request. Possible causes: - No filter parameter provided (at least accountId or targetType with targetValue is required) - targetValue provided without targetType - accountId is not a valid UUID - targetValue format does not match the expected format for the given targetType
  • 401 — Unauthorized - Missing or expired access token. Obtain a new token and retry.

See Errors reference for the full catalogue.