Quotes List

GET/api/v1/quotes/AccessExpress

Returns a list of quotes for a particular customer with filtering, sorting, and pagination options.

Auth Scope

urn:grt:accessexpress

Content-Type

application/json

Rate Limit

60 req/min

Headers

Header	Value
`Authorization`	`Bearer access-token`

Parameter	Type	Required	Description
`search`	string	No	A general search term to filter quotes by name or request number
`status`	array of strings	No	Filters quotes by one or more statuses. Acceptable status options include `Checking availability`, `Order services`, `Closed`, and `Quote expired`
`requester`	array of strings	No	Filters quotes by requester identifiers or names. Example: "Requester1,Requester2"
`start_date`	datetime	No	Filters quotes submitted on or after this ISO-formatted date. Example: `2024-01-01T00:00:00`
`end_date`	datetime	No	Filters quotes submitted on or before this ISO-formatted date. Example: `2024-12-31T23:59:59`
`granted_tenant_macnum`	string	No	The company macnum on whose behalf the action is performed

Parameter	Type	Required	Description
`name_order`	string	No	Sorts results by quote name. Accepts values `asc` or `desc`
`request_number_order`	string	No	Sorts results by request number. Accepts values `asc` or `desc`
`status_order`	string	No	Sorts results by quote status. Accepts values `asc` or `desc`
`last_update_order`	string	No	Sorts results by last updated timestamp. Accepts values `asc` or `desc`
`date_submitted_order`	string	No	Sorts results by submission date. Accepts values `asc` or `desc`
`requester_order`	string	No	Sorts results by requester. Accepts values `asc` or `desc`

Parameter	Type	Required	Description
`page`	integer	No	The page number of the results to return
`page_size`	integer	No	The number of results to return per page

If the request is successful, a 200 OK status code is returned.

Field	Type	Description
`id`	UUID	Unique identifier for the quote request
`request_number`	integer	Request number for the quote
`status`	string	Current status of the quote. Values: `Checking availability`, `Order services`, `Closed`, `Quote expired`
`formal_quote_expires_at`	datetime	ISO 8601 timestamp indicating when the formal quote expires

HTTP Status	Error Description	Resolution
`401`	Authentication Failed	Verify your access token is valid and included in the Authorization header with the "Bearer " prefix.
`403`	Permission Denied	You do not have permissions to view quote results. Check your API scope (`urn:grt:accessexpress`).
`429`	Rate Limit Exceeded	You have exceeded the rate limit of 60 requests per minute. Check the `Retry-After` header in the response.