List users

Retrieve a paginated list of users in your Quo workspace.

GET /v1/users

List users

cURL

curl --request GET \
  --url https://dev-public-api.openphone.dev/v1/users \
  --header 'Authorization: <api-key>'

200

{
  "data": [
    {
      "id": "US123abc",
      "email": "[e-mail]",
      "firstName": "John",
      "lastName": "Doe",
      "pictureUrl": "https://example.com/picture.jpg",
      "role": "owner",
      "createdAt": "2022-01-01T00:00:00Z",
      "updatedAt": "2022-01-01T00:00:00Z"
    }
  ],
  "totalItems": 123,
  "nextPageToken": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Query Parameters

maxResults · integer · default: 10 · required

Maximum number of results to return per page.

Required range: 1 <= x <= 50

pageToken · string

Response

200

application/json

OK

data · object[] · required

Show child attributes

totalItems · integer · required

Total number of items available. ⚠️ Note: totalItems is not accurately returning the total number of items that can be paginated. We are working on fixing this issue.

nextPageToken · string | null · required