PUpumpgtm
Sequences

Read one sequence with its revision

Changed on

One owned sequence in the full shape (steps use stepIndex and messageTmpl, executionModel included) with its exact revision, needed before PUT. 404 not_found (resource sequence) outside this workspace.

get/sequences/{id}

Request

  • Base URL
    https://app.pumpgtm.com/api/v1
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

Headers

X-PumpGTM-Clientstring uuid

Optional authorized Team workspace ID from GET /workspaces. Omit to use the key's home workspace.

X-PumpGTM-Userstring

Enterprise partners: act on one end user's workspace using the partner key (a workspace or Team owner key; a personal key gets 403 partner_key_required). Requires the outreach capability on the partner account (403 enterprise_required otherwise); the user must exist and be active (404 user_not_found, 403 user_disabled). Never send it together with X-PumpGTM-Client (400 invalid_request). Omit to use the key's own workspace, unless the partner account has rest.requireUserHeader on (PATCH /api/partner/v1/account): then any /api/v1 request without it is 400 user_header_required and nothing runs.

Response

Successful response. Read outcome fields; success does not imply delivery.

sequenceobject required

Full sequence: { id, name, status, revision, approvedAt, approvedRevision, executionBlockReason, executionModel, leadCount, channels, steps: [{ stepIndex, kind, delayDays, subject, messageTmpl, actions, variants, tool }], updatedAt }. Steps use the same names as the request body (stepIndex, messageTmpl), unlike the compact GET /sequences list (index, message).

Changes

  • 06d2e4d0e84bRevision changes
    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

  • 08c80059d483Revision changes
    • info

      endpoint added