Controls

Get a list of gb controls

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

GET

/gb/controls

curl --request GET \
  --url 'https://api.catch-e.com/gb/controls?module=gb&name=%3Cstring%3E&effective_from=2023-12-25&page=1&page_size=25' \
  --header 'Authorization: <api-key>'

{
  "_embedded": {
    "gb_controls": [
      {
        "effective_from": "0000-00-00",
        "encrypted_flag": "no",
        "module": "gb",
        "name": "becs_details",
        "super_flag": "no",
        "value": {
          "aba_file_description": "BECSPAYMENT",
          "company_name_short": "DemoBecs",
          "identification_number": "999999",
          "user_credits_only": "no"
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.catch-e.com/gb/controls"
    }
  },
  "page": 1,
  "page_count": 1,
  "page_size": 25,
  "total_items": 1
}

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

moduleenum<string>query

Available options: gb, fm, qt, gl, sl, pl, qq, sp, bk

namestringquery

Name

This field supports the wildcard % operator.

Maximum string length: 255

effective_fromstringquery

Effective From

Show all controls with an effective from less than (or equal to) the specified date.

pageintegerquerydefault:1

Optional page number

Required range: 1 <= x <= 2147483647

page_sizeintegerquerydefault:25

Optional page size

Required range: -1 <= x <= 2147483647

Response

Success

_embeddedobject

Show child attributes

_linksobject

pageinteger

Example: 1

page_countinteger

Example: 1

page_sizeinteger

Example: 25

total_itemsinteger

Example: 1

Still need help? Ask the team