Skip to main content
GET
List viewer campaign items

Authorizations

Authorization
string
header
required

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

Path Parameters

campaign_id
string<uuid>
required

The ID of the campaign.

Query Parameters

cursor
string

The pagination cursor value.

page_size
integer

Number of results to return per page. Default is 200; maximum is 500.

Required range: x <= 500
sort_field
enum<string>

Sort by. Omit to sort by created_at.

Sort field for viewer campaign items.

Available options:
PRINCIPAL_NAME,
ENTITY_NAME,
EXPIRATION,
LAST_USED
Example:

"PRINCIPAL_NAME"

sort_direction
enum<string>

Sort direction. Sort direction for viewer campaign items.

Available options:
ASC,
DESC
Example:

"ASC"

statuses
enum<string>[]

Filter by review status. When multiple values are provided, items matching any status are returned (OR).

Decision status for a viewer campaign item.

Available options:
APPROVED,
REVOKED,
CHANGE_ROLE,
NO_ACTION,
PENDING,
REASSIGNED
access_level_names
string[]

Filter by access level name.

principal_ids
string<uuid>[]

Filter by principal ID.

entity_ids
string<uuid>[]

Filter by entity ID.

item_ids
string<uuid>[]

Filter to specific campaign item review IDs.

ai_bucket_id
string<uuid>

Restrict to items in this AI-suggestion bucket.

Response

200 - application/json

A page of viewer campaign items.

A paginated list of viewer campaign items.

results
object[]
required
total_count
integer<int64>
required

Total number of items matching the filter (across all pages).

next
string | null

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

previous
string | null

The cursor used to obtain the current result page.

Last modified on September 14, 2026