Quote / Walkaway

Get a list of walkaway plans

Get a list of walkaway plans.

GET

/qt/walkaway-plans

curl --request GET \
  --url 'https://api.catch-e.com/qt/walkaway-plans?walkaway_plan_code=%3Cstring%3E&name=%3Cstring%3E&state=NSW&status_flag=active&page=1&page_size=25' \
  --header 'Authorization: <api-key>'

{
  "_embedded": {
    "qt_walkaway_plans": [
      {
        "cost_price_net": 123,
        "margin_net": 123,
        "name": "<string>",
        "prn": "<string>",
        "retail_price_gross": 123,
        "retail_price_net": 123,
        "state": "NSW",
        "status_flag": "active",
        "walkaway_plan_code": "<string>",
        "walkaway_plan_id": "<string>",
        "wordprn": "<string>"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.catch-e.com/qt/walkaway-plans"
    }
  },
  "page": 1,
  "page_count": 1,
  "page_size": 25,
  "total_items": 1
}

This method requires the WalkawayPlans: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

walkaway_plan_codestringquery

Optional Walkaway Plan Code

This field supports the wildcard % operator.

Maximum string length: 20

namestringquery

Optional Name

This field supports the wildcard % operator.

Maximum string length: 60

stateenum<string>query

Optional State

Available options: NSW, ACT, NT, WA, SA, VIC, TAS, QLD, NZ

status_flagenum<string>querydefault:active

Status flag

Available options: active, inactive

pageintegerquerydefault:1

Optional page number

Required range: 1 <= x <= 2147483647

page_sizeintegerquerydefault:25

Optional page size

Required range: -1 <= x <= 2147483647

Response

Success

_embeddedobject

Show child attributes

_linksobject

pageinteger

Example: 1

page_countinteger

Example: 1

page_sizeinteger

Example: 25

total_itemsinteger

Example: 1

Still need help? Ask the team