Getting started

To start using the HeyTeam API, you need to follow these two simple steps:

Step 1: Obtain credentials from HeyTeam

You can do this by contacting our team. You will be provided with a credential (API Key or OAuth).

This credential will be used to authenticate your requests to the API, so make sure to keep it safe and secure.

Step 2: Make an API request

After you've obtained an API credential, you are now ready to make a call to the HeyTeam API.

There are various interactive tools (e.g. Postman) and methods available in the market that you can use to make a HeyTeam API request.

Make a test API call

The best way to try your credentials if to make a simple GET request using your sub-domain and your token/access token on one of the configuration endpoint available in the HeyTeam API.

curl --request GET \
     --url https://<your-domain>.heyteam.com/eapi/configuration/languages \
     --header 'accept: application/json' \
     --header 'authorization: Bearer <token>'

If the call is successful, you should receive 200 code and a JSON response like the following :

{
    "data": [
        {
            "id": 1,
            "code": "fr-FR",
            "is_enabled": true,
            "is_default": true
        },
        {
            "id": 2,
            "code": "en-US",
            "is_enabled": false,
            "is_default": false
        }
    ]
}