Skip to main content
Quote / Events

Get quote event codes

Get quote event actions.

GET
/qt/quote-event-codes

This method requires the QuoteEventCodes:Get permission to be associated with your role.

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Query Parameters

quote_event_codestringquery

Optional Quote Event Code

This field supports the wildcard % operator.

Maximum string length: 8
namestringquery

Optional Name

This field supports the wildcard % operator.

descriptionstringquery

Optional Description

This field supports the wildcard % operator.

include_deleted_flagenum<string>querydefault:no

Set to yes if deleted status events are required in the list.

Available options: yes, no
pageintegerquerydefault:1

Optional page number

Required range: 1 <= x <= 2147483647
page_sizeintegerquerydefault:25

Optional page size

Required range: -1 <= x <= 2147483647

Response

application/vnd.catch-e-api.v1+json

Success

_embeddedobject
_linksobject
pageinteger
Example: 1
page_countinteger
Example: 1
page_sizeinteger
Example: 25
total_itemsinteger
Example: 1

Still need help? Ask the team