Welcome to our API docs!

Quickstart Guide

Generating an auth token

Navigate to your user profile

On the API Tokens tab, enter a label for your token and hit the Create button

Save the token value somewhere safe, it will never be shown again.

Sending your first request

To send a request to our API, set the Authorization header to Token <your token value>. For example:

curl --request GET \
  --url https://api.captivateiq.com/ciq/v1/employees/ \
  --header 'Accept: application/json' \
  --header 'Authorization: Token mytokenvalue'

If all is successful, you should see something like the following:

{
    "object": "list",
    "total_count": 18,
    "next": null,
    "previous": null,
    "data": [
        {
            "object": "employee",
            "id": "f386ae72-ec52-4b16-b9f2-dbb98b93189e",
            "employee_id": "User106",
            "email": "[email protected]",
            "first_name": "Julie",
            "last_name": "Wise",
            "final_process_date": null,
            "is_active": true,
            "linked_user": "da6275af-4648-4d76-964e-7faf2c35276b",
            "created_at": "2020-09-01T22:34:32.320468Z",
            "updated_at": "2020-09-09T21:30:26.662966Z"
        },
        ...
    ]
}

Troubleshooting

For frequently asked questions and troubleshooting tips, please see our FAQs section.

Terms and Conditions

The terms and conditions governing the usage of CaptivateIQ's API can be found here.