Get Client Endpoints: GetClientGroups

API endpoints for retrieving client data

GetClientGroups

Enables you to get the details of client group records.

See also Main Page → Fleet / Administration / Client Groups → Contact

Supplementary SWAGGER documentation is available here: https://api.catch-e.com/docs/#/Client%20Groups/getClientGroups(https://api.catch-e.com/docs/#/Client%20Groups/getClientGroups)

Permissions

To run this API, the nominated 'web-services' role needs to be given permission.

If you are not actively using the API, leave the permission off for better security.

Go to Roles / Apis and check on ClientGroups:Get

Note: This API is not configured for external use.
Contact your Account Manager to discuss access to this API.

HTTP Method

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

URL Examples

https://api.catch-e.com/fm/client-groups

Body (JSON)

JSON FieldFormatNotesMandatory
clientgroupidnumberPass a unique Client Group Codeno
clientgroupcodestringPass the Client Group Code. This field supports the wildcard % operator (See Wildcard % operator notes below).no
namestringPass the Client Group name. This field supports the wildcard % operator (See Wildcard % operator notes below).no
clientgroupidexternalstringPass the Client Group External Id. This field supports the wildcard % operator (See Wildcard % operator notes below).no
pagenumberReturns all pages by default. You can limit the results with this input valueno
page_sizenumber25 results per page are returned by default. You can limit the results with this input valueno

Wildcard % operator notes:

If you are using "Postman" app, with the wildcard operator, the search string of either %ab% or %ba%, will give this response:

"field_name": {"isEmpty": "Value is required and can't be empty"}.

If you need to search either %ab% or %ba%, please use %25ab%25 or %25ba%25 as required to return results as expected.

Response Details

Validation MessagesComments
200 OK
{ "_links": { "self": { "href": "https://api.test.catch-e.com/fm/client-groups/?client_group_code=%25MPAPI%25&page=1" }, "first": { "href": "https://api.test.catch-e.com/fm/client-groups/?client_group_code=%25MPAPI%25" }, "last": { "href": "https://api.test.catch-e.com/fm/client-groups/?client_group_code=%25MPAPI%25&page=1" } }, "_embedded": { "client_group": [ { "client_group_id": "100013", "client_group_id_external": "0", "client_group_code": "MPAPIPRE", "name": "MP API Group Pre-Deploy API-20350", "address1": "Factory 4", "address2": "2 Fiveways Boulevard", "area": "Keysborough", "state": "VIC", "postcode": "3173", "contact": "Matt Parratt", "abn": "00 111 222 333", "acn": "111 222 333", "billing_email": "matthew.parratt@catch-e.com.au" }, { "client_group_id": "100014", "client_group_id_external": "123456", "client_group_code": "MPAPIPOST", "name": "MP API Group POST API-20350 patchClientGroup", "address1": "Factory 4A", "address2": "2 Fiveways Blvd", "area": "Keysborough", "state": "VIC", "postcode": "3173", "contact": "Matthew Parratt", "abn": "99 888 777 000", "acn": "888 777 000", "billing_email": "ian.rawlings@catch-e.com.au" } ] }, "page_count": 1, "page_size": 25, "total_items": 2, "page": 1}

| A successful response returns all fields in the new table record. |
| 403 - Forbidden | | |

|"detail": "Forbidden"

| You do not have permissions for this request. |

GetClientIndustries

Enables you to get a list of "Industry" values found on the Client / Contact page.

Supplementary SWAGGER documentation is available here: https://api.catch-e.com/docs/#/Clients(https://api.catch-e.com/docs/#/Clients)

Permissions

To run this API, the nominated 'web-services' role needs to be given permission.

If you are not actively using the API, leave the permission off for better security.

Go to Roles / Apis and check on ClientIndustries:Get

Note: This API is not configured for external use.
Contact your Account Manager to discuss access to this API.

HTTP Method

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

URL Examples

https://api.catch-e.com/fm/clients-industries

Parameters - Query

KeyFormatNotesDefault ValueMandatory
clientindustrycodestringOptional Client Industry Code. This field supports the wildcard % operator (See Wildcard % operator notes below).no
pagenumberReturns all pages by default. You can limit the results with this input value1no
page_sizenumber25 results per page are returned by default. You can limit the results with this input value25no

Wildcard % operator notes:

If you are using "Postman" app, with the wildcard operator, the search string of either %ab% or %ba%, will give this response:

"field_name": {"isEmpty": "Value is required and can't be empty"}.

If you need to search either %ab% or %ba%, please use %25ab%25 or %25ba%25 as required to return results as expected.

Response Details

Validation MessagesComments
201 Created
{ "_links": { "self": { "href": "https://api.support.catch-e.com/fm/client-industries/?page=1&page_size=2&client_industry_code=A01%25" }, "first": { "href": "https://api.support.catch-e.com/fm/client-industries/?page_size=2&client_industry_code=A01%25" }, "last": { "href": "https://api.support.catch-e.com/fm/client-industries/?page=12&page_size=2&client_industry_code=A01%25" }, "next": { "href": "https://api.support.catch-e.com/fm/client-industries/?page=2&page_size=2&client_industry_code=A01%25" } }, "_embedded": { "fm_client_industries": [ { "client_industry_id": "100000", "client_industry_code": "A0111", "description": "Agriculture, Forestry and Fishing - Plant Nurseries", "status_flag": "active", "_links": { "self": { "href": "https://api.support.catch-e.com/fm/client-industries/100000" } } }, { "client_industry_id": "100001", "client_industry_code": "A0112", "description": "Agriculture, Forestry and Fishing - Cut Flower and Flower Seed Growing", "status_flag": "active", "_links": { "self": { "href": "https://api.support.catch-e.com/fm/client-industries/100001" } } } ] }, "page_count": 12, "page_size": 2, "total_items": 23, "page": 1}

| A successful response returns all fields in the table. |
| 403 - Forbidden | | |

|"detail": "Forbidden"

| You do not have permissions for this request. |
| 422 - Unprocessable Entity | | |

{ "validationMessages": { "fields": { "notInArray": "Unknown field specified"}

| The syntax of the fields key is not correct. Having spaces in the list of fields is one possible reason. |

GetCompetitorMargins

Returns the Quotes / Contract "Lost By" list.

Use this selection in patchQuote.

Supplementary SWAGGER documentation is available here: https://api.catch-e.com/docs/#/Quote%20%2F%20Competitor%20Margins/getCompetitorMargins(https://api.catch-e.com/docs/#/Quote%20%2F%20Competitor%20Margins/getCompetitorMargins)

Permissions

This method requires the permission CompetitorMargins:Get.

This permission is not available in Roles / Apis by default, but it can be enabled for you by Catch-e.
If enabled, you can then turn on this permission for your 'web services' role. Visit the process page Edit API permissions for the steps to do this.

Note: This API is not configured for external use by default.
Contact your Account Manager to discuss access to this API.

Authentication

Authenticate with the API before running this API.

HTTP Method

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

URL Examples

https://api.test.catch-e.com/qt/competitor-margins

Parameters (Query Params)

KeyFormatNotesMandatory
descriptionstringGet a competitor margin description. This field supports the wildcard % operator (See Wildcard % operator notes below).No
includeinactiveflagstringyes or no. Set to yes if inactive Competitors required in the list.No
pagenumberOptional page number. Default 1 page.No
page_sizenumberOptional page size. Default 25 records per page.No

Wildcard % operator notes:

If you are using "Postman" app, with the wildcard operator, the search string of either %ab% or %ba%, will give this response:

"field_name": {"isEmpty": "Value is required and can't be empty"}.

If you need to search either %ab% or %ba%, please use %25ab%25 or %25ba%25 as required to return results as expected.

GetCompetitors

Returns the Quotes / Contract "Competitor" list.

Use this selection in patchQuote.

Supplementary SWAGGER documentation is available here: api.test.catch-e.com/docs/#/Quote%20%2F%20Competitors

Permissions

This method requires the permission Competitors:Get.

This permission is not available in Roles / Apis by default, but it can be enabled for you by Catch-e.
If enabled, you can then turn on this permission for your 'web services' role. Visit the process page Edit API permissions for the steps to do this.

Note: This API is not configured for external use by default.
Contact your Account Manager to discuss access to this API.

Authentication

Authenticate with the API before running this API.

HTTP Method

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

URL Examples

https://api.test.catch-e.com/qt/competitors

Parameters (Query Params)

KeyFormatNotesMandatory
namestringGet a competitor description. This field supports the wildcard % operator (See Wildcard % operator notes below).No
includeinactiveflagstringSet to yes if inactive Competitors required in the list.No
pagenumberOptional page number. Default 1 page.No
page_sizenumberOptional page size. Default 25 records per page.No

Wildcard % operator notes:

If you are using "Postman" app, with the wildcard operator, the search string of either %ab% or %ba%, will give this response:

"field_name": {"isEmpty": "Value is required and can't be empty"}.

If you need to search either %ab% or %ba%, please use %25ab%25 or %25ba%25 as required to return results as expected.