GET /experience/connections

List all Experience Connections

Retrieve list of all Experience Connections for the given account. Either accountId or telephoneNumber (or the deprecated tn) is required.

Authentication

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

Request

Path parameters

None.

Query parameters

Name Type Required Description
accountId string (uuid) one of * Filter by account ID. If present, the telephoneNumber/tn filter is ignored; if not present, telephoneNumber (or the deprecated tn) is required.
telephoneNumber string (E.164) one of * Filter by the account associated with the supplied telephone number. Required only when accountId is not provided. Takes precedence over the deprecated tn parameter if both are supplied.
tn string (E.164) no Deprecated — use telephoneNumber instead. Filter by the account associated with the supplied telephone number. Required only when accountId is not provided.
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.
experienceId string (uuid) no Filter by Experience ID
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.

* Either accountId or telephoneNumber (or the deprecated tn) is required. If accountId is present, the telephoneNumber/tn filter is ignored; telephoneNumber takes precedence over the deprecated tn parameter if both are supplied.

Headers

None.

Responses

200 — Experience Connections retrieved successfully

Content-Type: application/json

Schema: PagedExperienceConnectionList

Field Type Required Description
entities array of ExperienceConnection yes List of Experience Connections 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

Example:

{
  "pageSize": 100,
  "entities": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "accountId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "accountName": "Acme Communications",
      "experienceId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "state": "INACTIVE",
      "updatedAt": "2026-05-01T12:00:00Z"
    }
  ],
  "cursor": null
}

400 — Bad Request - A query parameter was set with an invalid value

Content-Type: application/problem+json

Schema: ProblemDetails

Example:

{
  "title": "Bad Request",
  "status": 400,
  "detail": "accountId is required",
  "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 - A query parameter was set with an invalid value
  • 401 — Unauthorized - Missing or expired access token. Obtain a new token and retry.

See Errors reference for the full catalogue.