Import / Export

Read values for a single record

Read values for a single record.

GET

/gb/record/read-record

curl --request GET \
  --url 'https://api.catch-e.com/gb/record/read-record?table_name=%3Cstring%3E&table_key_fields=%3Cstring%3E&table_key_values=%3Cstring%3E&fields=%3Cstring%3E' \
  --header 'Authorization: <api-key>'

{}

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

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

table_namestringqueryrequired

table_key_fieldsstring[]queryrequired

Name of table key field(s) to use in read record query.

Minimum array length: 1

table_key_valuesstring[]queryrequired

Value of table key field(s) to use in read record query.

Minimum array length: 1

fieldsstring[]query

Define fields required. If no fields are specified then all fields are returned.

Response

Success

bodyobject

Still need help? Ask the team