Rebilly API Docs

Retrieve quote timeline messages

Retrieves quote timeline messages.

SecuritySecretApiKey or JWT

Request

path Parameters

required

string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

query Parameters

limit	integer [ 0 .. 1000 ] Limits the number of collection items to be returned.
offset	integer >= 0 Specifies the starting point within the collection of items to be returned.
filter	string Filters the collection items. This field requires a special format. Use `,` for multiple allowed values. Use `;` for multiple fields. For more information, see Using filter with collections.
sort	Array of strings Sorts and orders the collection of items. To sort in descending order, prefix with `-`.
q	string Use this field to perform a partial search of text fields.

Responses

200

List of quote timeline messages retrieved.

Response Headers
Pagination-Total	integer Total number of items. Example: 332
Pagination-Limit	integer Maximum number of items per page. Example: 100
Pagination-Offset	integer 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

Response Schema: application/json

Array

string <= 50 characters

ID of the timeline message.

type

string

Type of timeline message.

Enum: "quote-created" "quote-issued" "quote-accepted" "quote-rejected" "quote-canceled" "quote-recalled" "quote-updated" "quote-expired" "quote-order-attached"

triggeredBy

string

Specifies who, or what, triggered the timeline message.

Enum: "rebilly" "app" "direct-api"

message

string

Contents of the timeline message.

object (TimelineExtraData)

Additional data.

	Array of objects (TimelineAction) >= 0 items Actions available for a timeline message. If no actions are available, this field is empty.
	Array of objects (TimelineTable) >= 0 items Table data that is attached to the timeline message.
	object Author of the timeline message.
	object User mentions, or tags, in a timeline.
	Array of objects Links that are attached to a timeline message.

occurredTime

string <date-time>

Date and time when the timeline message occurred.

Array of objects (SelfLink)

Related links.

Array

href	string Link URL.
rel	string Type of link. Value: "self"

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/quotes/{id}/timeline

Request samples

Response samples

application/json

[{"id": "tmln_0YV8Q9WEF5DTA8HFXS27D1G6GC",
"type": "quote-created",
"triggeredBy": "rebilly",
"message": "string",
"extraData": {"actions": [{"action": "resend-email"
}
],
"tables": [{"type": "list",
"title": "string",
"footer": "string"
}
],
"author": {"userFullName": "string",
"userId": "usr_0YVCEENYJ3D7Q9EN6BN16HA0G4"
},
"mentions": {"@test@mail.com": "userId-1"
},
"links": [{"resourceType": "kyc-document",
"resourceId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"placeholder": "KYC document",
"externalUrl": "http://example.com"
}
]
},
"occurredTime": "2019-08-24T14:15:22Z",
"_links": [{"href": "string",
"rel": "self"
}
]
}
]

➔ Next to Create a quote timeline comment