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

Returns list of DocumentRecipients that are assigned to given Document

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

When successful, returns object containing document recipients and PaginationInfo

{
  "document_recipients": [], // List of document recipients - see 'DocumentRecipient model'
  "pagination_info": {} // Pagination info - see 'Pagination info'
}

Request

Path Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Ruby

curl --location --request GET 'https://api.mpc.dev.placewise.com/v1/operations/documents/1/recipients' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'X-Customer;' \
--header 'Authorization: Bearer ' \
--header 'X-Client-Authorization: '

Responses

🟢200Success

application/json

Body

Example

{}

Show Document

Create Document

List Document Recipients

URL Parameters#

Query Parameters#

Error Responses#

Example#

Request

Request Code Samples

Responses

URL Parameters

Query Parameters

Error Responses

Example