- Overview
- Reference
- API Structure
- Public API
- Introduction
- Loyalty Club
- Member
- Offers
- Rewards
- Games
- CMS Content
- Management API
- Introduction
- Core
- Applications
- Branding
- Privacy Policy
- Cookie Policy
- Terms
- Domains
- Domain Email Configs
- Domain Web Configs
- TLS Certificates
- Links
- Fonts
- Subunits
- Subunits Scopes
- Contacts
- Translations
- Promotions Policy
- Tracker
- Social Logins
- Billing
- SMS Sender Identities
- Member Authentication Configuration
- Members
- Listing Members
- Member Profile
- Imports
- Groups
- Programs
- Benefits
- Cars
- Webhooks
- Misc
- Receipts
- Messages
- Stores
- Offers
- Rewards
- Triggerer
- CMS
- Introduction
- Venue Info
- Pages
- Website
- Landing Pages
- Articles
- Events
- Job Postings
- Press Releases
- Tags
- Attachments
- Service Messages
- Mixed Content
- Redirections
- Events
- Games
- Scraper
- Files
- Receipts
- Users API
- Operations API
- Introduction
- Manager API
- Introduction
- Settings
- ABM Links
- Members
- Issues
- Articles
- Articles Categories
- Documents
- Resource Types
- Resources
- Revenue Reporting
- Alerts
- Alert Templates
- Footfall Reporting
- Tenant API
- Messaging API
- Data API
- ML API
- Introduction
- Predict Sending KPI v1
- Explain Sending KPI Prediction v1
- Predict Sending KPI In Date Range v1
- Predict Sending Popularity v2
- Predict Sending Text Popularity v2
- Predict Sending Time Series Popularity v2
- Explain Sending Popularity Prediction v2
- Explain Sending Text Popularity Prediction v2
- Explain Sending Time Series Popularity Prediction v2
- Recommend sending time v2
- Detect Receipt Fraud
- Generate Image
- Generate Text
- Generate Sending Text
- Predict Sending KPI v1 Copy
- (Draft) Reporting API
- Other
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
id
integerÂ
required
Example:
1
Header Params
X-Loyalty-Club-Slug
stringÂ
required
Default:
{{LOYALTY_CLUB_SLUG}}
X-Client-Authorization
stringÂ
optional
Default:
{{API_TOKEN}}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
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;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'X-Customer;' \
--header 'Authorization;' \
--header 'X-Client-Authorization: 'Responses
🟢200Success
application/json
Body
object {0}
Example
{}Modified at 2024-05-07 15:49:04