Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Sequence

sequence.info

Beta

This endpoint is in beta and may not be available for all organizations.

Retrieves a candidate's sourcing sequence enrollment when it is visible to the acting user.

Not-started email stages include resolved, editable subject and HTML body content. Started sequences return stage metadata without message content. Drafts are visible only to the acting user who created them, so requests made with x-on-behalf-of must continue using the same user.

Returns sequence_not_found for missing, inaccessible, or non-sourcing sequences.

Requires the sourcingRead permission.

post/sequence.info

Request body

sequenceIdstring uuid required

The unique identifier for the sequence enrollment

Response

Responses from the sequence.info endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "candidateId": "26906e15-ff36-4ed3-b25b-de806d7852f7",
    "applicationId": "71c2be26-cd82-4b9f-8e61-3ca2ed94c9a7",
    "sequenceTemplateId": "97f36cec-3736-4f14-b1e2-ec60a132efab",
    "status": "NotStarted",
    "createdAt": "2026-07-20T12:34:56.000Z",
    "stages": [
      {
        "id": "cc506f71-e2a3-438e-9130-a90b5f350ce3",
        "type": "Email",
        "from": {
          "email": "gob@example.com",
          "displayName": "Gob Bluth"
        },
        "subject": "A simple subject",
        "bodyHtml": "<p>Hello</p>",
        "sendAfter": {
          "kind": "NoDelay"
        }
      }
    ]
  }
}