/
Retrieve lists

Retrieve lists

Request

Retrieves a collection of lists. This operation returns the most recent version of each list.

Security
SecretApiKey or JWT
Query
limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

fieldsstring

Limits the returned fields to the specified list, each field separated by a comma. The ID value is always returned.

qstring

Use this field to perform a partial search of text fields.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/lists?limit=0&offset=0&filter=string&sort=string&fields=string&q=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Collection of lists retrieved.

Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:2
Bodyapplication/json
Array [
idstring, <= 50 charactersread-only

ID of the list.

Example:"lst_0YVCXVQH84DEF93D8VBTJQ9TGK"
versioninteger, >= 1read-only

Version of the list.

descriptionstringrequired

Description of the list.

valuesArray of stringsrequired

Values in the list.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

]
Response
[
  {
    "id": "lst_0YVCXVQH84DEF93D8VBTJQ9TGK",
    "version": 1,
    "description": "string",
    "values": [ … ],
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "_links": [ … ]
  }
]