Restaurant - Beneficiary

Export Export beneficiaries data

GET

/restaurant/beneficiaries/export

const url = 'https://api.inspow.tech/api/v1/restaurant/beneficiaries/export?limit=10&offset=0&sortBy=createdAt&sortOrder=asc&sort=%7B%22lastName%22%3A%20-1%2C%20%22email%22%3A%201%7D&format=excel';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.inspow.tech/api/v1/restaurant/beneficiaries/export?limit=10&offset=0&sortBy=createdAt&sortOrder=asc&sort=%7B%22lastName%22%3A%20-1%2C%20%22email%22%3A%201%7D&format=excel' \
  --header 'Authorization: Bearer <token>'

Export Export beneficiaries data in various formats (Excel, CSV, JSON, PDF)

Authorizations

bearer

Parameters

Query Parameters

limit

required

number

Example

Number of items to return

offset

required

number

Example

Number of items to skip

sortBy

string

Example

createdAt

Field to sort the results (Deprecated, use sort instead)

sortOrder

string

Example

asc

Sort direction, either asc or desc (Deprecated, use sort instead)

searchQuery

string

Search query (same as findAll)

query

string

Filters in JSON format (same as findAll)

sort

string

Example

{"lastName": -1, "email": 1}

Sort criteria in JSON format (same as findAll)

format

required

string

Allowed values: excel csv json pdf

Export format

Responses

200

File exported successfully