GET
/
bulk
/
{job_id}
/
users
curl --request GET \
  --url https://api.courier.com/bulk/{job_id}/users \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "preferences": {
        "categories": {},
        "notifications": {}
      },
      "profile": "<any>",
      "recipient": "<string>",
      "data": "<any>",
      "to": {
        "account_id": "<string>",
        "context": {
          "tenant_id": "<string>"
        },
        "data": {},
        "email": "<string>",
        "locale": "<string>",
        "user_id": "<string>",
        "phone_number": "<string>",
        "preferences": {
          "categories": {},
          "notifications": {},
          "templateId": "<string>"
        },
        "tenant_id": "<string>"
      },
      "status": "PENDING",
      "messageId": "<string>"
    }
  ],
  "paging": {
    "cursor": "<string>",
    "more": true
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
job_id
string
required

A unique identifier representing the bulk job

Query Parameters

​
cursor
string | null

A unique identifier that allows for fetching the next set of users added to the bulk job

Response

200
application/json

The response is of type object.