List Documents

Pending

GET

https://api.mpc.dev.placewise.com/v1/operations/documents

API Permit:Operations:Api:Documents:Index

API Context:Loyalty Club

Authorizations:UserToken

Returns list of Documents.

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
confirmable	boolean	null	When true, returns only confirmable Documents - and vice versa
search	string	null	When true, returns only Documents that match the given string
recipients_confirmation_status	enum: `['all', 'some', 'none']`	null	When present, returns only Documents having given `recipients_confirmation_status`
access	enum: `['public', 'private']`	null	When present, returns only Documents having given type of access
sort_by	enum: `['title', 'created_at']`	null	Sorting by property
sort_direction	enum: `['asc', 'desc']`	asc	Sort direction

Example

When successful, returns object containing documents and PaginationInfo

{
  "documents": [], // List of documents - see 'Document model'
  "pagination_info": {} // Pagination info - see 'Pagination info'
}

Request

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' \
--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

{}

Introduction

Show Document

List Documents

Query Parameters#

Example#

Request

Request Code Samples

Responses

Query Parameters

Example