Get Documents

Query Parameters

sort

string

Pass the name of a top-level field to sort by that field in ascending order. Prefix the name of the field with a minus symbol ("-") to sort in descending order.

limit

number

Limit number of results, default 10

where

object

Search for results fitting criteria, uses qs library for query string parsing

Show child attributes

where.and

array

where.or

array

where.id

object

Show child attributes

where.id.equals

string

The value must be exactly equal.

where.id.not_equals

string

The query will return all documents where the value is not equal.

where.id.like

string

Case-insensitive string must be present. If string of words, all words must be present, in any order.

where.id.contains

string

Must contain the value entered, case-insensitive.

where.id.in

string

The value must be found within the provided comma-delimited list of values.

where.id.not_in

string

The value must NOT be within the provided comma-delimited list of values.

where.id.all

string

The value must contain all values provided in the comma-delimited list.

where.id.exists

boolean

Only return documents where the value either exists (true) or does not exist (false).

where.deal

object

Show child attributes

where.deal.equals

any

The value must be exactly equal.

where.deal.not_equals

any

The query will return all documents where the value is not equal.

where.deal.like

string

Case-insensitive string must be present. If string of words, all words must be present, in any order.

where.deal.contains

string

Must contain the value entered, case-insensitive.

where.deal.in

string

The value must be found within the provided comma-delimited list of values.

where.deal.not_in

string

The value must NOT be within the provided comma-delimited list of values.

where.deal.all

string

The value must contain all values provided in the comma-delimited list.

where.deal.exists

boolean

Only return documents where the value either exists (true) or does not exist (false).

where.data

object

Show child attributes

where.data.equals

object

The value must be exactly equal.

where.data.not_equals

object

The query will return all documents where the value is not equal.

where.data.like

string

Case-insensitive string must be present. If string of words, all words must be present, in any order.

where.data.contains

string

Must contain the value entered, case-insensitive.

where.data.in

string

The value must be found within the provided comma-delimited list of values.

where.data.not_in

string

The value must NOT be within the provided comma-delimited list of values.

where.data.all

string

The value must contain all values provided in the comma-delimited list.

where.data.exists

boolean

Only return documents where the value either exists (true) or does not exist (false).

where.isSigned

object

Show child attributes

where.isSigned.equals

boolean

The value must be exactly equal.

where.isSigned.not_equals

boolean

The query will return all documents where the value is not equal.

where.isSigned.like

string

Case-insensitive string must be present. If string of words, all words must be present, in any order.

where.isSigned.contains

string

Must contain the value entered, case-insensitive.

where.isSigned.in

string

The value must be found within the provided comma-delimited list of values.

where.isSigned.not_in

string

The value must NOT be within the provided comma-delimited list of values.

where.isSigned.all

string

The value must contain all values provided in the comma-delimited list.

where.isSigned.exists

boolean

Only return documents where the value either exists (true) or does not exist (false).

depth

integer

The number of levels of related objects to include in the response

Response

Documents Found

data

Document · object[]

Show child attributes

data.id

string

required

Document is uniquely identified by id

data.data

object

required

Document has Data

data.deal

Deal has Document

data.isSigned

boolean

Document is signed

success

boolean

page

number

Current page number

number | null

number of next page, null if it doesn't exist

number | null

number of previous page, null if it doesn't exist

totalPages

number

Total pages available, based upon the limit

totalCount

number

Total available records within the database

limit

number

Limit query parameter, defaults to 10

pagingCounter

number

number of the first record on the current page

hasPrevPage

boolean

true/false if previous page exists

hasNextPage

boolean

true/false if next page exists

Commerce

Resources

API Reference

Query Parameters

Response