Controls

Get a gb control

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

GET

/gb/controls/{module}/{name}/{effective_from}

Get a gb control

curl --request GET \
  --url https://api.catch-e.com/gb/controls/{module}/{name}/{effective_from} \
  --header 'Authorization: <api-key>'

{
  "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"
  }
}

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

Path Parameters

moduleenum<string>required

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

namestringrequired

effective_fromstringdefault:0000-00-00required

Response

Success

effective_fromstring

encrypted_flagenum<string>default:no

Available options: no, yes

moduleenum<string>

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

namestring

Maximum string length: 255

super_flagenum<string>default:no

Available options: no, yes

valueany

Still need help? Ask the team