OPopal
campaigns

List campaign items

Changed on

Returns a paginated list of review items for a campaign — the same rows shown on the admin Reviews tab. Status is derived using the same rules as the UI Status column. Soft-deleted role assignments are still returned with is_target_deleted: true.

get/campaigns/{campaign_id}/items

Request

  • Base URL
    https://api.opal.dev/v1
  • Auth
    HTTP bearer

Path parameters

campaign_idstring uuid required

The ID of the campaign.

Query parameters

cursorstring

The pagination cursor value.

page_sizeinteger

Number of results to return per page. Default is 200; maximum is 500 (the campaign-items list cap).

statusesCampaignItemStatusEnum[]

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

[
  "PENDING"
]
reviewer_user_idstring uuid

Restrict to items assigned to this reviewer user ID.

unassignedboolean

When true, restrict to items with no reviewer assigned.

searchstring

Case-insensitive search over principal name, asset name, and reviewer name.

Response

A page of campaign items.

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.

total_countinteger required

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

Example response

{
  "results": [
    {
      "target_type": "ROLE_ASSIGNMENT",
      "status": "PENDING",
      "principal_type": "GROUP",
      "entity_type": "GROUP",
      "access_level": {
        "access_level_name": "AdminRole",
        "access_level_remote_id": "arn:aws:iam::590304332660:role/AdministratorAccess"
      },
      "reviews": [
        {
          "assignment_source": "MANUAL",
          "decision": "APPROVED"
        }
      ],
      "admin_override": {
        "decision": "APPROVED"
      }
    }
  ]
}

Changes

  • c0ce333f6196Revision changes
    • warning

      added the new EXPIRATION_REDUCED enum value to the // response property for the response status

    • warning

      added the new REDUCE_EXPIRATION enum value to the /////// response property for the response status

    • warning

      added the new REDUCE_EXPIRATION enum value to the //////// response property for the response status

    • info

      added the enum value EXPIRATION_REDUCED to the property items/ of the query request parameter statuses

    • info

      added the optional property //// to the response with the status

  • 9ac628dcda14Revision changes
    • warning

      added the new PRINCIPAL_SELF enum value to the //// response property for the response status