Sign in

v5

latestOpenAPI 3.1.02026-07-31151195455.5 KB
uars

Returns a list of UAR objects. Deprecated in favor of GET /campaigns.

get/uars

Query parameters

cursorstring

The pagination cursor value.

page_sizeinteger

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

Response

A list of UARs for your organization.

nextstring nullable

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

previousstring nullable

The cursor used to obtain the current result page.

Example response

{
  "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:59Z",
      "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:59Z",
      "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"
        ]
      }
    }
  ]
}