Skip to main content
GET
/
delegations
Get delegations
curl --request GET \
  --url https://api.opal.dev/v1/delegations \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "id": "4aed3e8a-727b-4d72-8010-3b8710c50bec",
      "delegator_user_id": "123e4567-e89b-12d3-a456-426614174000",
      "delegate_user_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
      "start_time": "2023-10-01T12:00:00.000Z",
      "end_time": "2023-10-01T12:00:00.000Z",
      "reason": "I need to be out of the office",
      "created_at": "2023-10-01T12:00:00.000Z",
      "updated_at": "2023-10-01T12:00:00.000Z"
    }
  ],
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "total_count": 2
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
delegator_user_id
string<uuid>

The delegator user ID to filter delegations by the user delegating their access review requests.

​
delegate_user_id
string<uuid>

The delegate user ID to filter delegations by the user being delegated to.

​
cursor
string

A cursor to indicate where to start fetching results.

​
page_size
integer

The maximum number of results to return per page. The default is 200.

Required range: x <= 1000

Response

200 - application/json

A list of delegations for your organization.

​
results
object[]

The delegations in the result set.

​
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"

​
total_count
integer

The total number of items in the result set.

Example:

2