USuseboom
Initiatives

List participants

Changed on

List an initiative's participants and the values Boom captured from each, newest first. Each row carries both contact identifiers (phoneNumber, email) — on an email initiative the phone is null for everyone, so read the one the initiative actually sends to. Filter by personExternalId to find one person's runs — including the live one, to stop it before starting another.

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

Request

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

Path parameters

idstring required

Initiative id.

Query parameters

personExternalIdstring

Return only this person's runs, matched on the external id recorded when the run started. Exact match, case-sensitive. Participants enrolled without an external id are never returned, so an empty result means no run carries this id — not that the person has no run.

limitinteger

Page size, up to 1000.

cursorstring

Opaque cursor from a previous page.

Response

Success

next_cursorstring nullable required

Changes

  • 7c7a773b12ceRevision changes
    • info

      added the new optional query request parameter personExternalId

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status