Get users

Returns a list of users for your organization.

GET /users

cURL

cURL

curl --request GET \
  --url https://api.opal.dev/v1/users \
  --header 'Authorization: Bearer <token>'

200

{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "user_id": "29827fb8-f2dd-4e80-9576-28e31e9934ac",
      "email": "[e-mail]",
      "full_name": "John Doe",
      "position": "Senior Engineer"
    },
    {
      "user_id": "e8581682-04f7-473a-a419-472f0fb26d46",
      "email": "[e-mail]",
      "full_name": "Jane Smith",
      "position": "Product Marketing Lead"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

cursor · string

The pagination cursor value.

page_size · integer

Number of results to return per page. Default is 200.

Required range: x <= 1000

tag_ids · string<uuid>[]

The IDs of the tags to filter by. Returns only users that have any of these tags applied.

Response

200 - application/json

One page worth users in your organization.

results · object[] · required

Show child attributes

next · string | null

The cursor with which to continue pagination if additional result pages exist.

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"

previous · string | null

The cursor used to obtain the current result page.

Example:

"cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ"