Skip to main content
GET
Get filter options

Authorizations

X-API-Key
string
header
required

Preferred authentication method. Pass the API key in the X-API-Key HTTP request header. The user account must have api_status enabled.

Query Parameters

page
integer

Page number.

perPage
integer

Items per page.

Search text.

ids
string

Resolve an explicit list of ids in one request: a comma-separated string (ids=5,6,7) or the repeated ids[]=5&ids[]=6 form. Answers exactly the rows whose id is listed, after the caller's Visibility Group scope - ids outside that scope are not returned. Every item must be a whole number above zero. The request answers 422, with the reason under info.errors.ids, instead of a page when the list holds a malformed or empty item (1,,2), names no id at all (separators only, e.g. ids=,), or carries more than 1000 items - repeats count toward that limit. Sent without an explicit perPage, the page size defaults to the number of ids, so a single request returns the whole list (SCL-13678).

Response

Filter options.

status
string
Example:

"success"

code
integer
Example:

200

name
string
Example:

"OK"

message
string
info
object