API reference

Catch-e API20261005062544

This is the documentation for the Catch-e API. For further assistance utilising this API, please contact your Catch-e representitive.

Getting Started

Access to this API requires the use of a Bearer token. This token is obtained via a call to the /authenticate method.

Date Format and Timezone

All dates are specified in internationally agreed ISO 8601 format: yyyy-MM-dd. For e.g: 2019-01-01

All timestamps returned from the API should be treated as UTC unless otherwise stated. Some APIs, specifically requestTableExport and requestTableImport will allow the specification of a presentation/treatment timezone.

Pagination

APIs supporting pagination can specify "-1" in the page_size parameter to display all records.

Audit User Id Override

If an Authenticated API user has the Audit:UserIdOverride permission, an optional header Audit-User-Id can be supplied on supported web-services that will create any associated Audit Records with the user_id specified.

PHP Client SDK

Catch-e provides an API SDK for PHP. To install simply type:

composer require catch-e/api-sdk

For more information see https://packagist.org/packages/catch-e/api-sdk.

License

Ownership of intellectual property rights in the Catch-e API and supporting documentation

Unless otherwise noted, copyright (and any other intellectual property rights, if any) in the Catch-e API and supporting documentation is owned by Catch-e Pty Ltd.

Acknowledgements

Catch-e uses third-party libraries when developing this software. Please refer to the licenses page for specific attribution.

Disclaimer

Your use is your responsibility.

The Catch-e API data is provided "as is" and Catch-e is not liable for how you use this data, how third parties use or rely on this data or any errors contained within the data. You are responsible for determining whether the Catch-e API is suitable for your particular usage and purposes.

Base URL

All requests use this base URL:

https://api.catch-e.com

Authentication

AuthorizationstringheaderAPI key

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

curl --request GET \
  --url https://api.catch-e.com/fm/approvals \
  --header 'Authorization: <api-key>'

Still need help? Ask the team