Skip to main content
Suppliers API

getSuppliers

getSuppliers

Overview

Allows you to retrieve a list of configured suppliers. This method requires the Suppliers:Get permission to be associated with your role.
By default, only 'admin' role is linked in [gb_role_api_permissions].

HTTP Method

Use the HTTP Method 'GET' for consuming this web service.

Input Fields (Header)

  • Header should contain the 'Content-Type' Key with the Value = 'application/json' or 'application/hjson'.

Input Fields (Body)

Field

Format

Notes

Mandatory

name

string

Optional supplier name. This field supports the wildcard % operator.

No

external_code

string

Optional supplier name. This field supports the wildcard % operator.

No

supplier_code

string

Optional supplier name. This field supports the wildcard % operator.

No

supplier_type

string

Optional supplier type.

Available values: dealership, service-centre, card-services, tyres, glass-repairs, financier, transport, detailing, disposal, body-repairs, artwork, insurer, broker, residual-insurer, maintenance-controller, rental, roadside, salary-packaging

No

exclude_empty_name_flag

string

Optional flag. Set 'yes' to exclude suppliers with an empty name field.

Available values: yes, no. Default value: no

no

status

string

Optional status.

Available values: active, inactive. Default value: active

no

interface_type

string

Optional interface type.

Available values: card-services, maintenance-controller, claim, contract-events

no

page

string

Optional page number. Defaults to 1

no

page_size

string

Optional Page size. Defaults to 25 records per page.

no

Input URL Examples

For a list of Asset Types:

https://api.catch-e.com/fm/suppliers?page=1&page_size=5 

(Successful) Output Example

{ "_links": { "self": { "href": "https://api.test.catch-e.com/fm/suppliers/?page=1" }, "first": { "href": "https://api.test.catch-e.com/fm/suppliers/" }, "last": { "href": "https://api.test.catch-e.com/fm/suppliers/?page=112" }, "next": { "href": "https://api.test.catch-e.com/fm/suppliers/?page=2" } }, "_embedded": { "supplier": [ { "supplier_id": 100000, "name": "AAB Vehicles R Us", "_links": { "self": { "href": "https://api.test.catch-e.com/fm/suppliers/100000" } } }, { "supplier_id": 100001, "name": "A-Z Vehicles R Us", "_links": { "self": { "href": "https://api.test.catch-e.com/fm/suppliers/100001" } } }, { "supplier_id": 100002, "name": "AAA Vehicles R Us", "_links": { "self": { "href": "https://api.test.catch-e.com/fm/suppliers/100002" } } }, { "supplier_id": 100003, "name": "Sample Automotive Service Supplier", "_links": { "self": { "href": "https://api.test.catch-e.com/fm/suppliers/100003" } } }, { "supplier_id": 100004, "name": "OZ Automotive Service Supplier", "_links": { "self": { "href": "https://api.test.catch-e.com/fm/suppliers/100004" } } } ] }, "page_count": 112, "page_size": 5, "total_items": 557, "page": 1 } 

Error Codes

Example error output

 { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "Unauthorized" }

Was this helpful?

Still need help? Ask the team