/documents

get

https://instance_name.quable.com/api_1.php/documents

List documents

Query Params

page

integer

Defaults to 1

Page number used while paginating the response

limit

integer

Defaults to 50

Number of items per page (50 maximum).

target_culture

string

Code of the data locale into which attribute's values must be retrieved or pushed If empty, default locale from the account will be used.

document_type_code

string

Specific DocumentType to filter on

medias_included

integer

Defaults to 1

Accepted values ar "0" or "1". If "1", assets will be inserted in the response for every documents

media_fields_included

integer

Defaults to 0

Accepted values ar "0" or "1". If "1", asset fields & values will be inserted in the response

parent_documents

integer

Defaults to 0

Accepted values ar "0" or "1". If "1", parents documents fo the current one will be inserted in the response

target_documents

integer

Defaults to 0

Accepted values ar "0" or "1". If "1", target documents fo the current one will be inserted in the response

updated_at_min

string

Accepted datetime format is "Y-m-d H:i:s". For API, dates are UTC formatted and not Europe/Paris formatted. If any, only documents updated after this value will be rendered in the response.

Headers

quable-codes

string

Defaults to null

List of codes separated by commas in order to filter on those specific documents. Encoding the codes individually before separating them with commas helps prevent abnormal behaviors that can be caused by the presence of special characters.

quable-completenesses

string

Defaults to null

List of completeness codes separated by commas in order to filter on those completenesses

quable-tags

string

Defaults to null

List of tags (aka statuses) codes separated by commas in order to filter on those tags

Response

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success