Skip to main content
GET
/
uars
cURL
curl --request GET \
  --url https://api.opal.dev/v1/uars \
  --header 'Authorization: Bearer <token>'
{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "uar_id": "f454d283-ca87-4a8a-bdbb-df212eca5353",
      "name": "Monthly UAR (July)",
      "send_reviewer_assignment_notification": false,
      "deadline": "2022-07-14T06:59:59.000Z",
      "time_zone": "America/Los_Angeles",
      "self_review_allowed": false,
      "uar_scope": {
        "tags": [
          {
            "key": "uar_scope",
            "value": "high_priority"
          }
        ],
        "names": [
          "demo",
          "api"
        ],
        "admins": [
          "f454d283-ca87-4a8a-bdbb-df212eca5353",
          "8763d283-ca87-4a8a-bdbb-df212ecab139"
        ]
      }
    },
    {
      "uar_id": "39a4d283-ca87-4a8a-bdbb-df212eca5fdb",
      "name": "Monthly UAR (August)",
      "send_reviewer_assignment_notification": true,
      "deadline": "2022-08-14T06:59:59.000Z",
      "time_zone": "America/Los_Angeles",
      "self_review_allowed": false,
      "uar_scope": {
        "tags": [
          {
            "key": "uar_scope",
            "value": "high_priority"
          }
        ],
        "names": [
          "demo",
          "api"
        ],
        "admins": [
          "f454d283-ca87-4a8a-bdbb-df212eca5353",
          "8763d283-ca87-4a8a-bdbb-df212ecab139"
        ]
      }
    }
  ]
}

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

Response

200 - application/json

A list of UARs for your organization.

A list of UARs.

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"