Contendar Help

Authentication

Every request to the Contendar API needs an API key. The key tells us who you are. A projectId on each request tells us which project to read or change.

Get an API key

  1. Open your project.
  2. In the left sidebar, go to Manage project.
  3. Click API keys.
  4. Click Create API key.
  5. Enter a Name so you can tell this key apart from other keys, for example "Zapier integration".
  6. Choose when the key Expires. The options are Never, 30 days, 90 days, or 1 year.
  7. Click Create API key.

Contendar shows the key one time only. Copy it now and store it somewhere safe. If you lose it, you must create a new one.

Every key starts with ck_. Treat the key like a password. Anyone with the key can read and change your data.

Use the key

Send the key in the Authorization header as a bearer token:

Authorization: Bearer ck_your_key_here

A request with no key, or with a wrong or expired key, returns 401.

One key, many projects

An API key belongs to your account, not to one project. The same key works for every project you own. You choose the project on each request with the projectId parameter.

  • For GET and DELETE requests, add projectId as a query parameter.
  • For POST and PATCH requests, add projectId to the JSON body.

projectId is the UUID of the project. To find it, open the project in Contendar and copy the UUID from the page URL.

If the project ID is missing, or the project does not belong to your account, the request returns 404.

Revoke a key

  1. Go to the API keys page.
  2. Find the key in the list.
  3. Click Revoke.

A revoked key stops working straight away. Revoke a key if it leaks, or when a tool no longer needs it.

Related pages

Was this helpful?