Skip to main content

How do I enable or disable the Client API?

D
Written by Daria Nasedkina

Before you can use the Client API, you need to enable API access and generate an access token. You can also disable access or revoke a token at any time.

Note: When you share API access details with third parties, you're granting them access to your organisation's data, including the ability to add, edit, and delete users.

To learn more about the Client API, see What is the Client API?

Enable or disable the Client API

  1. Go to Settings.

  2. In the Advanced section, click API access.

  3. In the API access section, choose whether to enable or disable it:

    • To enable the Client API, select the check box.

    • To disable the Client API, clear the check box.

  4. Click Save changes.

Generate an access token

Once enabled, you'll need to generate an access token:

  1. Go to Settings.

  2. In the Advanced section, click API access.

  3. In Your access tokens, click the +Add new token button.

  4. Change the description to something meaningful for you. This description is not your access token.

  5. Click Add new token to save.

  6. Your token is generated and displayed. Copy it and keep it safe, as you would a password. This is the only time the token is displayed.

  7. Select the check box to confirm you've saved the token, then click Close.

Edit or delete a token

  1. Go to Settings.

  2. In the Advanced section, click API access.

  3. In Your access tokens, find the token you want to change and click the three dots on the right of its details. Then choose:

    • Edit to change the token's description at any time.

    • Delete to remove the token — for example, if it's no longer used or you need to revoke access.

  4. Confirm your action.

FAQ

I've lost my access token — can I see it again?

No. A token is only displayed once, when you first generate it. If you've lost it, delete the old token and generate a new one.

What happens to integrations using a token if I delete it?

Any integration using that token will lose access immediately. Only delete a token when you're sure it's no longer in use, or when you deliberately want to revoke access.

Does disabling API access delete my tokens?

Disabling API access turns off access without you needing to remove individual tokens. To permanently remove a token, delete it.

Related Articles
Did this answer your question?