PUpumpgtm
Plays

List the Play's leads

Changed on

Leads in the selected Play, from its runs or added with POST /plays/{id}/leads, with stable cursor pagination. Use each lead ID to read detailed state or stop its automation.

get/plays/{id}/leads

Request

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

Path parameters

idstring uuid required

Query parameters

limitinteger
afterstring uuid

Pass nextCursor from the previous response until null.

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.

playIdstring uuid required
nextCursorstring uuid nullable required
hasMoreboolean required

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