PUpumpgtm
People search

Read a review batch and its candidates

Changed on

One review batch: batch counts, the targeting summary and each candidate with its current decision (undecided, approved or rejected). batch.status is draft (being prepared), sample_ready (ready to review), approved, imported (finished; good fits queued) or rejected. 404 not_found (resource review).

get/people/reviews/{batchId}

Request

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

Path parameters

batchIdstring 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.

object required

{ batch: { id, status: draft | sample_ready | approved | imported | rejected, planId, planRevision, proposedCount, approvedCount, importedCount, ... }, target, candidates: [{ id, person, title, company, linkedinUrl, location, matchReason, evidence, linkedinVerified, recentActivityAt, decision: undecided | approved | rejected, sequenceId }] }

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