Endpoints

List templates

Return a list of templates

GET

/v1/templates

List templates

curl --request GET \
  --url 'https://public-api.bladepro.io/v1/templates?organisation_id%5BIN%5D=123&organisation_id%5BNOT_IN%5D=123&template_category_id%5BIN%5D=123&template_category_id%5BNOT_IN%5D=123&template_category_code%5BIN%5D=123&template_category_code%5BNOT_IN%5D=123&name%5BLIKE%5D=%3Cstring%3E'

{
  "data": {
    "created": "2019-11-25T14:52:56.000Z",
    "id": 1,
    "modified": "2019-11-25T14:52:56.000Z",
    "name": "Default despatch note",
    "organisation_id": 1,
    "status": "portrait",
    "template_category_code": "DESPATCH_NOTE",
    "template_category_id": 1
  },
  "meta": {
    "request_reference": "233f2gjwz-c893v86"
  }
}

Scope(s): APP::TEMPLATES::READ

Query Parameters

organisation_id[IN]numberquery

Filter for id of the organisation. (IN)

organisation_id[NOT_IN]numberquery

Filter for id of the organisation. (NOT_IN)

template_category_id[IN]numberquery

Filter for id of the template category. (IN)

template_category_id[NOT_IN]numberquery

Filter for id of the template category. (NOT_IN)

template_category_code[IN]numberquery

Filter for code of the template category. (IN)

template_category_code[NOT_IN]numberquery

Filter for code of the template category. (NOT_IN)

name[LIKE]stringquery

Filter for name of the template. (LIKE)

Response

successful operation

createdany

Created date in BladePRO.

idnumber

ID of the template.

modifiedany

Last modified date in BladePRO.

namestring

Name of the template.

organisation_idnumber

ID of the organisation.

statusenum<string>

Orientation.

Available options: portrait, landscape

template_category_codenumber

Code of the template category.

template_category_idnumber

ID of the template category.

Still need help? Share an idea