getCompanies

Overview

This method returns a list of companies configured in the system.

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

Permissions

The permission for this api is stored in [gb_api_permissions]permission as 'Companies: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/gb/companies https://api.{{environment}}.catch-e.com/gb/companies https://api.test.catch-e.com/gb/companies

Query Parameters

Key	Format	Notes	Mandatory
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.company contains:

Field	Format	Notes
company_id	string
name	string
address1	string
address2	string
city	string
state	string
postcode	string
phone	string
fax	string
mobile	string
email_finance	string
postal_address1	string
postal_address2	string
postal_city	string
postal_state	string
postal_postcode	string
abn	string
default_flag	string

{ "_links": { "self": { "href": "https://api.catch-e.loc/gb/companies?page=1" } }, "_embedded": { "company": [ { "_links": { "self": { "href": "https://api.catch-e.loc/gb/companies/1" } }, "company_id": "1", "name": "[COMPANY-NAME]", "address1": "[ADDRESS-LINE-1]", "address2": "", "city": "[CITY]", "state": "NSW", "postcode": "2000", "phone": "[PHONE]", "fax": "", "mobile": "", "email_finance": "[EMAIL]", "postal_address1": "[ADDRESS-LINE-1]", "postal_address2": "", "postal_city": "[CITY]", "postal_state": "NSW", "postal_postcode": "2000", "abn": "[ABN]", "default_flag": "yes" } ] }, "page_count": 1, "page_size": 25, "total_items": 1, "page": 1 }

Error Response Details

Validation Message	Comments
401 - Unauthorized	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 companies 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" }