Skip to main content
GET
/
users
{
  "items": [
    {
      "userId": "<string>",
      "name": "<string>",
      "email": "jsmith@example.com",
      "msisdn": "<string>",
      "identity": "<string>",
      "customerIds": [
        "<string>"
      ],
      "customers": [
        {
          "customerId": "<string>",
          "name": "<string>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "pagination": {
    "total": 123,
    "limit": 123,
    "offset": 123,
    "sort": {
      "key": "<string>",
      "direction": "ASC"
    }
  }
}

Authorizations

X-API-Key
string
header
required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Query Parameters

filter
string

A free text search string to filter users by name or email.

customerId
string[]

The unique identifier of the customer to filter by.

limit
integer
default:100

The maximum number of items to return.

Required range: 1 <= x <= 1000
offset
integer
default:0

The number of items to skip before starting to collect the result set.

Required range: x >= 0

Response

A list of users.

items
object[]
pagination
object
I