search
Go to app

playQuick Start

hashtag
Getting your API key

API keys are used to authenticate requests to the API. Any request that doesn't include an API key will return an error.

You can generate an API key by going to Settings → API keys → Create new key on a paid plan.

hashtag
Using your API key

The Ambit Developer API uses the Bearer authentication scheme to authenticate incoming requests.

The API key should be included in the Authorization header of any HTTP request in the following format:

Authorization: Bearer <API key>

where <API key> is the key from the Getting your API key section.

hashtag
Example request

Let's take a look at how to create a contact using the API.

curl -X POST https://app.ambit.so/api/v1/contacts \
  -H "Authorization: Bearer <API key>" \
  -H "Content-Type: application/json" \
  -d '{"email": "alex@example.com", "name": "Alex", "status": "ACTIVE"}'

Here, we hit the /v1/contacts endpoint with a POST request to create a new contact named Alex.

hashtag
API reference

For detailed info on each API resource and available HTTP operations, see the Reference section of the documentation.

PreviousWelcome!NextUser

Last updated