Skip to main content
GET
List Reclamation Candidates

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Team-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.
Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Team keys must allow every team checked by the request. OAuth access depends on the user’s roles and resource access.

Authorizations

Authorization
string
header
required

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

Path Parameters

team_id
string
required

Query Parameters

status
enum<string> | null

The lifecycle state of an reclamation-candidate reclamation, derived server-side.

Available options:
RECLAMATION_CANDIDATE_STATUS_UNSPECIFIED,
RECLAMATION_CANDIDATE_STATUS_IN_REVIEW,
RECLAMATION_CANDIDATE_STATUS_RECLAIMING,
RECLAMATION_CANDIDATE_STATUS_REVIEW_DISMISSED,
RECLAMATION_CANDIDATE_STATUS_REVIEW_RECLAIMED,
RECLAMATION_CANDIDATE_STATUS_AUTO_RECLAIMED,
RECLAMATION_CANDIDATE_STATUS_RECLAIM_FAILED
appInstanceIds
string[]

Scope to these app instances (integrations). Empty selects every one.

Case-insensitive substring match on the entitlement or resource name.

pageSize
integer<int32>
pageToken
string

Response

200 - application/json

Success

data
ReclamationCandidate · object[]
nextPageToken
string | null

Cursor for the next page; empty when there are no more results.

stats
stats · object

Team-wide concluded dismiss/reclaim tally, independent of the filters above. Backs the /roles stat widgets.