List candidates | CONFIRM Docs

{
  "data": [
    {
      "id": "cand_5DkW9rTzPe",
      "org_id": "org_4Nv8sJqKfH",
      "job_id": "job_2VbY6mQwXs",
      "external_ref": "cl_app_84321",
      "first_name": "Maria",
      "last_name": "Alvarez",
      "phone": "+18135550172",
      "email": "string",
      "source": "registry-platform",
      "status": "pending_contact",
      "stage": "applied",
      "consent": {
        "tcpa": true,
        "captured_at": "2024-01-15T09:30:00Z",
        "fcra_disclosure": true
      },
      "resume_url": "string",
      "metadata": {
        "county": "Hillsborough",
        "shift_preference": "weekends"
      },
      "withdrawn_at": "2024-01-15T09:30:00Z",
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}

Returns a cursor-paginated list of candidates in the organization, filterable by partner screening status, job, external_ref, and creation-date range.

Authentication

AuthorizationBearer

Partner API key sent as Authorization: Bearer cfk_.... Keys are partner-level — one key reaches every registry linked to your partner account and nothing else. CONFIRM issues and revokes them; a key is shown exactly once at creation because only its hash is stored, and revocation takes effect on the next request. Develop against the sandbox base URL with a sandbox key, where telephony is restricted to an allowlist you provide.

Partner API key sent as `Authorization: Bearer cfk_...`. Keys are partner-level — one key reaches every registry linked to your partner account and nothing else. CONFIRM issues and revokes them; a key is shown exactly once at creation because only its hash is stored, and revocation takes effect on the next request. Develop against the sandbox base URL with a sandbox key, where telephony is restricted to an allowlist you provide.

Path parameters

org_idstringRequired

Organization ID (org_...).

Query parameters

statusenumOptional

Filter by partner screening status.

job_idstringOptional

Only candidates applied to this job.

external_refstringOptional

Exact-match lookup by your platform’s identifier.

created_afterdatetimeOptional

Only candidates created at or after this time (ISO 8601).

created_beforedatetimeOptional

Only candidates created before this time (ISO 8601).

limitintegerOptional1-100Defaults to 20

Page size, 1–100.

cursorstringOptional

Opaque cursor from a previous response’s next_cursor.

Response

Paginated candidate list.

datalist of objectsOptional

has_morebooleanOptional

next_cursorstring or nullOptional

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error

$	curl https://api.confirm.global/partner/v1/organizations/org_4Nv8sJqKfH/candidates \
>	-H "Authorization: Bearer <token>"