Skip to main content
GET
/
users
/
remote_users
cURL
curl --request GET \
  --url https://api.opal.dev/v1/users/remote_users \
  --header 'Authorization: Bearer <token>'
{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "user_id": "29827fb8-f2dd-4e80-9576-28e31e9934ac",
      "remote_id": 1234567890,
      "third_party_provider": "GIT_LAB"
    },
    {
      "user_id": "29827fb8-f2dd-4e80-9576-238979927392",
      "remote_id": "remoteid123",
      "third_party_provider": "GIT_HUB"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
third_party_provider
enum<string>[]

Filter remote users by their third party provider.

The third party provider of the remote user.

Available options:
AUTH0,
SLACK,
GOOGLE_CHAT,
JIRA,
LINEAR,
SERVICE_NOW,
FRESH_SERVICE,
SHORTCUT,
PAGER_DUTY,
OPSGENIE,
GIT_HUB,
GIT_LAB,
GIT_LAB_CONNECTION,
TELEPORT,
SLACK
​
user_id
string<uuid>[]

Filter remote users by their user ID.

​
remote_id
string[]

Filter remote users by their remote ID.

​
cursor
string

The pagination cursor value.

​
page_size
integer

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

Required range: x <= 1000

Response

200 - application/json

One page worth users in your organization.

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