List Document Recipients
Pending
GET
https://api.mpc.dev.placewise.com/v1/operations/documents/{id}/recipients
API Permit:Operations:Api:DocumentRecipients:List
API Context:Loyalty Club
Authorizations:UserToken
URL Parameters
| Parameter | Type | Description |
|---|---|---|
| id | integer | Document ID |
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| per_page | integer | 100 | Number of results to be returned per request (100 is the maximum) |
| page_no | integer | 1 | Number of results page |
| confirmed | boolean | null | When true, returns only recipients that confirmed - and vice versa |
Error Responses
| Status | Description |
|---|---|
404 | Document not found |
Example
{
"document_recipients": [], // List of document recipients - see 'DocumentRecipient model'
"pagination_info": {} // Pagination info - see 'Pagination info'
}Request
Path Params
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.mpc.dev.placewise.com/v1/operations/documents/1/recipients' \
--header 'X-User-Agent: ApiDog' \
--header 'X-Product-Name: default' \
--header 'X-Loyalty-Club-Slug: infinity-mall' \
--header 'X-Customer: 447' \
--header 'Authorization: Bearer ' \
--header 'X-Client-Authorization: ' \
--header 'Content-Type: application/json'Response Response Example
{}