GET
/
v1
/
users
List users
curl --request GET \
  --url https://api.openphone.com/v1/users \
  --header 'Authorization: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "email": "[email protected]",
      "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>"
}

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

Success

​
data
object[]
required
​
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