Provide a paginated list of Documents

get

https://{instance_name}.quable.com/api/documents

Links are limited to 500 items per page

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

integer

Defaults to 1

The collection page number

limit

integer

0 to 50

Defaults to 30

The number of items per page

pagination

boolean

Enable or disable pagination

completenesses.completeness_id_example.locale

number

Filter the results on given completeness ratio and locale

order[completenesses.completeness_example_id]

string

enum

Allowed:

string

Filter the results by searching the given value on "id, name, variant.id" properties

documentLinks.link_type_id_example.origin.id

string

If you use this filter without any order, the results will be ordered by link sequence.

documentLinks.link_type_id_example.origin.id[]

array of strings

If you use this filter without any order, the results will be ordered by link sequence.

documentLinks.link_type_id_example.origin.id[]

documentLinks.link_type_id_example.target.id

string

If you use this filter without any order, the results will be ordered by link sequence.

documentLinks.link_type_id_example.target.id[]

array of strings

If you use this filter without any order, the results will be ordered by link sequence.

documentLinks.link_type_id_example.target.id[]

documentLinks.link_type_id_example.attributes.attribute_id_example

string

documentLinks.link_type_id_example.attributes.attribute_id_example[]

array of strings

documentLinks.link_type_id_example.attributes.attribute_id_example[]

catalogs.id

string

catalogs.id[]

array of strings

catalogs.id[]

classifications.id

string

classifications.id[]

array of strings

classifications.id[]

tags.id

string

tags.id[]

array of strings

tags.id[]

workflowSteps.id

string

workflowSteps.id[]

array of strings

workflowSteps.id[]

order[id]

string

order[dateCreated]

string

order[dateModified]

string

order[name]

string

attributes.attribute_example_id

string

attributes.attribute_example_id[]

array of strings

attributes.attribute_example_id[]

attributes.attribute_example_id[equals]

string

attributes.attribute_example_id[contains]

string

skipDocumentLinks

boolean

skipVariantLinks

boolean

skipAssetLinks

boolean

dateCreated[before]

string

dateCreated[strictly_before]

string

dateCreated[after]

string

dateCreated[strictly_after]

string

dateModified[before]

string

dateModified[strictly_before]

string

dateModified[after]

string

dateModified[strictly_after]

string

active

boolean

active[]

array of booleans

active[]

attributeSet.id

integer

attributeSet.id[]

array of integers

attributeSet.id[]

documentType.id

integer

documentType.id[]

array of integers

documentType.id[]

string

id[]

array of strings

id[]

name

string

name[]

array of strings

name[]

Headers

X-Quable-Locale

string

enum

Defaults to application/ld+json

Generated from available response content types

Allowed:

Response

Language

Credentials

Header

URL

Loading…

Response

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

application/ld+json

application/hal+json

application/json

text/html

200Document collection