Skip to main content
Client Groups

Get a list of configured client groups

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

GET
/fm/client-groups

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

client_group_idstringquery

Optional Client Group Id (External)

Maximum string length: 10
client_group_codestringquery

This field supports the wildcard % operator.

Maximum string length: 10
Pattern: ^[a-zA-Z0-9\-\%]+$
client_group_id_externalstringquerydefault:1

Optional page number

Required range: 1 <= x <= 2147483647
namestringquerydefault:25

This field supports the wildcard % operator.

Required range: -1 <= x <= 2147483647
pageintegerquerydefault:1
Required range: -1 <= x <= 2147483647
page_sizeintegerquerydefault:25
Required range: -1 <= x <= 2147483647

Response

application/vnd.catch-e-api.v1+json

Success

_embeddedobject
_linksobject
pageinteger
Example: 1
page_countinteger
Example: 1
page_sizeinteger
Example: 25
total_itemsinteger
Example: 1

Still need help? Ask the team