Skip to main content
GET
/
users
List users
curl --request GET \
  --url https://apiv2.example.com/users \
  --header 'X-Api-Key: <api-key>'
{
  "items": [
    {
      "userId": "<string>",
      "name": "<string>",
      "email": "[email protected]",
      "msisdn": "<string>",
      "identity": "<string>",
      "customers": [
        {
          "customerId": "<string>",
          "name": "<string>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "pagination": {
    "nextCursor": "<string>"
  }
}

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
​
cursor
string

Opaque pagination token from a previous response's nextCursor.

Response

A list of users.

​
items
object[]
required
​
pagination
object
required