API Reference

Connecting securely to the CIM API

The CIM API uses OAuth 2.0 as the means of authorization for individual requests using the Refresh Token Grant Type. To get a Refresh Token, please contact CIM support at support@cim.io.

Once you have your Refresh Token, you can exchange it for an Access Token via this POST endpoint. Replace the refresh_token in the FORM DATA below with the Refresh Token you obtained from CIM Support.

Once you've obtained an Access Token, it needs to be passed in the Authorization header on all individual requests to the CIM API. For example, Authorization: Bearer b7f8f791...f26e554d.

📘

Access Token Expiry

Please note that Access Tokens expire after 1 day, at which point you would need to use your Refresh Token to generate a new Access Token to use. See our example use cases of how you can programmatically generate a new Access Token using your Refresh Token.

Form Data
string
required

Your refresh token obtained from CIM Support.

string
required
Defaults to refresh_token
string
required
Defaults to api-external
Responses

Language
Request
Click Try It! to start a request and see the response here! Or choose an example:
application/json