API Reference

Get the campaign recipients by ID

get
https://example.com/api/ext/v3/broadcasts//recipients
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

BSUID Support — Response Enrichment: Broadcast recipient objects now include:

New FieldTypeDescription
bsuidstring/nullBusiness Solution User ID of the recipient
Path Params
string
required

The unique identifier of the broadcast to retrieve.

Query Params
int32
required

Page number (1-based).

int32
required

Number of items per page (max 100).

Responses

401

The request is unauthorized.

429

Too many requests. Either the rate limit has been exceeded or usage limits have been reached.

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago