Retrieve quote timeline messages

Request

Retrieves quote timeline messages.
Security
SecretApiKey or JWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required
ID of the resource.
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 ,.

qstring
Use this field to perform a partial search of text fields.
curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/quotes/{id}/timeline?limit=0&offset=0&filter=string&sort=string&q=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of quote timeline messages 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 timeline message.
Example:"tmln_0YV8Q9WEF5DTA8HFXS27D1G6GC"
typestringread-only
Type of timeline message.
Enum:"quote-created""quote-issued""quote-accepted""quote-rejected""quote-canceled""quote-recalled""quote-updated""quote-expired""quote-order-attached""timeline-comment-created"
triggeredBystringread-only
Specifies who, or what, triggered the timeline message.
Enum:"rebilly""app""direct-api"
messagestring
Contents of the timeline message.
extraDataobject(TimelineExtraData)read-only
Additional data.
occurredTimestring, (date-time)(ServerTimestamp)read-only
Date and time when the timeline message occurred.
]
Response
[ { "id": "tmln_0YV8Q9WEF5DTA8HFXS27D1G6GC", "type": "quote-created", "triggeredBy": "rebilly", "message": "string", "extraData": { … }, "occurredTime": "2019-08-24T14:15:22Z", "_links": [ … ] } ]