Skip to main content
GET
/
owners
Get owners
curl --request GET \
  --url https://api.opal.dev/v1/owners \
  --header 'Authorization: Bearer <token>'
{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "owner_id": "f454d283-ca87-4a8a-bdbb-df212eca5353",
      "name": "API Owner",
      "description": "This owner represents the API team owners.",
      "access_request_escalation_period": 120
    },
    {
      "owner_id": "e8581682-04f7-473a-a419-472f0fb26d46",
      "name": "Finance Owner",
      "description": "This owner represents the Finance team owners.",
      "access_request_escalation_period": 120
    }
  ]
}

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
​
name
string

Owner name to filter by.

Response

200 - application/json

One page worth of owners 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"