Skip to main content

Get users

Get Bulk Job Users

URL: https://api.courier.com/bulk/:job_id/users

Method: GET

PATH PARAMS

job_idstringrequired
A unique identifier representing the bulk job
RESPONSES:

status: 200 OK

itemsarray
The bulk job user data items
pagingobject
The bulk job user data paging info
+ Show Properties

status: 400 Bad Request

messagestring
A message describing the error that occurred.
typestring
[invalid_request_error] The type of error that occurred.
Request Example
curl --request GET \
--url https://api.courier.com/bulk/1-61e9dd53-b5bb6c863b7ffbe83ad4b28d/users \
--header 'Accept: application/json'
Responses Example
{
"items": [
{
"recipient": "jane-001",
"email": "jane@email.com",
"data": {},
"locale": "en_US",
"preferences": {}
}
],
"paging": {
"cursor": "randomcursor",
"more": true
}
}
{
"message": "Error Message",
"type": "invalid_request_error"
}

Example‚Äč

Method: GET

URL: https://api.courier.com/bulk/1-61e9dd53-b5bb6c863b7ffbe83ad4b28d/users

Was this helpful?