getClients

Overview

This method returns a list of clients, optionally filtered by client code, client group code, client type, name or primary contact name.

By default only active clients are returned. Records with a status of 'deleted' are never returned.

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

Permissions

The permission for this api is stored in [gb_api_permissions]permission as 'Clients:Get'.

Only roles with a stored link to this permission in [gb_role_api_permissions] can run this api.

HTTP Method

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

URL Examples

https://api.demo.catch-e.com/fm/clients https://api.{{environment}}.catch-e.com/fm/clients https://api.test.catch-e.com/fm/clients

Query Parameters

Key	Format	Notes	Mandatory
client_code	string	Filter by client code. Supports the wildcard `%` operator.	No
client_group_code	string	Filter by client group code. Supports the wildcard `%` operator.	No
client_type	string	Filter by client type.	No
name	string	Filter by client name. Supports the wildcard `%` operator.	No
contact1_name	string	Filter by the name of contact 1. Supports the wildcard `%` operator.	No
include_inactive_flag	string	Set to `yes` to include inactive clients in the list. 'Deleted' records cannot be returned. Allowed values: `yes`, `no`. Default `no`.	No
fields	array of strings	The fields to return. If no fields are specified, all fields are returned.	No
page	integer	Page number. Default `1`.	No
page_size	integer	Number of records per page. Default `25`. Use `-1` to return all records.	No

Response Details

Success

200 - OK

Each record in _embedded.fm_clients contains the same fields as getClient; see that article for the full field list.

{ "_links": { "self": { "href": "https://api.catch-e.loc/fm/clients?page=1" } }, "_embedded": { "fm_clients": [ { "_links": { "self": { "href": "https://api.catch-e.loc/fm/clients/1234" } }, "client_id": "1234", "client_code": "ACME", "name": "Acme Pty Ltd", "client_type": "fleet", "state": "NSW", "contact1_name": "[CONTACT-NAME]", "contact1_email": "[EMAIL]", "billing_interval": "monthly", "payment_method": "eft", "bank_bsb": "[BSB]", "bank_account_number": "[ACCOUNT-NUMBER]", "...": "..." } ] }, "page_count": 1, "page_size": 25, "total_items": 1, "page": 1 }

The example is shortened. Only a selection of fields is shown for each client.

Error Response Details

Validation Message	Comments
401 - Unauthorized	1. You have not authenticated before running this API or 2. The token_timeout of the current session has passed. You need to authenticate again.

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

Validation Message	Comments
403 - Forbidden	- You do not have permissions for this request. - Go to System Roles and enter 'web_services' - Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked.

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

Validation Message	Comments
404 - Not Found	No clients were found.

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

Validation Message	Comments
406 - Not Acceptable	The Accept header of the request does not match a response format this API supports.

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

Validation Message	Comments
409 - Conflict	The request conflicts with the current state of the data.

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

Validation Message	Comments
500 - Internal Error	An unexpected error occurred on the server.

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

Validation Message	Comments
default - Unexpected Error	Any other unexpected error.

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