> For the complete documentation index, see [llms.txt](https://timetackle.gitbook.io/tackle/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://timetackle.gitbook.io/tackle/getting-started/quickstart.md).

# Authentication

<figure><img src="https://4161443499-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEoDQGhppzQMlRqbOFpgN%2Fuploads%2FBr35SCeoPO2E2jy4DAzw%2FUntitled%20design.png?alt=media&amp;token=3d0dc7c8-98ac-4ef2-955a-2df80084db1a" alt=""><figcaption></figcaption></figure>

### API Access

Tackle API is request-only, meaning access must be granted before using it. To request API access, please email **<developer@timetackle.com>**.

### Retrieving Your API Key

Once access is granted, navigate to the following page to retrieve your API key:

🔗 [**Tackle Developer Settings**](https://app2.timetackle.com/settings/developer)

* You can generate an API key from this page.
* The key can be updated or regenerated at any time.
* Only **Owner** and **Admin** level users can access this page.

### Using the API Key

To authenticate API requests, include the API key in the request headers using the `X-Tackle-Api-Key` header:

#### Example Request

{% code fullWidth="false" %}

```markup
GET /properties HTTP/1.1
Host: https://api.timetackle.com/external-api/v1
X-Tackle-Api-Key: your-api-key-here
```

{% endcode %}

### API Response

#### Successful Request

If the API key is valid, you will receive the requested data from the relevant API endpoint.

#### Invalid API Key

If the API key is invalid or missing, the response will return a `401 Unauthorized` status code with the following error format:

{% code fullWidth="false" %}

```json
{
    "errors": {
        "code": "UNAUTHORIZED",
        "message": "Invalid API Key ad1fdsda5-357d-4t05-87c2-1dgta2ad66d"
    },
    "statusCode": 401
}
```

{% endcode %}

Ensure that you use a valid API key to access Tackle's API services successfully.