USuseboom
Initiatives

Get participant

Changed on

Get one participant's status and captured answers.

get/api/v1/initiatives/{id}/participants/{participantId}

Request

  • Base URL
    https://www.useboom.ai
  • Auth
    HTTP bearer

Path parameters

idstring required

Initiative id.

participantIdstring required

Participant id, as returned when adding or listing.

Response

Success

participantIdstring required
phoneNumberstring nullable required
emailstring nullable required
namestring nullable required
status'ACTIVE' | 'COMPLETED' | 'STOPPED' | 'EXPIRED' | 'FAILED' required

ACTIVE (conversation may still happen), COMPLETED, STOPPED (messaging halted), EXPIRED, or FAILED.

extractionStatusstring nullable required

PENDING (queued, not yet run), EXTRACTED (ran and wrote), INSUFFICIENT_DATA (nothing extractable here — too few messages or no reply on THIS initiative), FAILED, or null for a participant whose extraction has never been triggered. INSUFFICIENT_DATA does NOT mean the person never replied: check their other initiatives with scope="customer" on the messages endpoint.

Changes

  • 7c7a773b12ceRevision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status