Access Certification

Get campaign template

Returns a campaign template's full configuration and, if one exists, a summary of its current or most recent run (status, review window, progress).

Required permission: accesscertification or accesscertification.readonly

get/access-certification/campaigns/{campaignId}

Request

Path parameters

campaignIdstring required

Campaign public identifier (hex-encoded BSON ObjectID stored as object_id).

Response

Campaign retrieved successfully

idstring required
orgIdstring required
status'scheduled' | 'active' | 'completed' | 'canceled' required

Lifecycle status of a campaign template on read responses. Create and update requests only accept scheduled. Activate transitions to active; close or end-early ends as completed or canceled. When Access Certification is disabled, this status field is unchanged, but create and activate are blocked. Viewing, editing scheduled templates, finalizing runs, and downloading audit reports remain available.

createdAtstring date-time required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.