---
title: "Overview of Public Api"
slug: "overview-of-public-api"
updated: 2022-11-14T20:42:33Z
published: 2022-11-14T20:42:33Z
canonical: "docs.team-tracks.com/overview-of-public-api"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.team-tracks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview of Public API

The TeamTracks API allows for basic CRUD (Create/Read/Update/Delete) operations to be performed on objects in the system. These are REST APIs and authenticated using OAuth 2.0 specifications.

To have access to APIs, you should have a valid Enterprise subscription to TeamTracks.

## API Authentication

### Generating an OAuth Client ID

All endpoints require the user calling them to be authenticated. Before you can start using the APIs, an OAuth client should be created in your TeamTracks instance. This is done using the OAuth Client registration page in the Admin Interface.

![](https://cdn.document360.io/31abc2bc-21c1-457d-a88c-27afd2eed7d6/Images/Documentation/image-1667513481944.png)

This will generate an OAuth client ID that is required for authenticating the API call.

### Generating an Access Token

To generate an access token, you must make a POST request to the following URL:

[https://api.team-tracks.com/auth/token](https://api.team-tracks.com/auth/token)

with the following two request headers,

```none
tenant: <your_tenent_ID>
Ocp-Apim-Subscription-Key: <your_subscription_key>
```

and the following body,

```json
{
    "clientId": "<OAuth_client_ID>",
    "email": "<api_username>",
    "password": "<api_user_password>"
}
```

The response will look like the following:

```json
{
    "token": "Bearer <token>"
}
```

The token has a validity of 1 year from the date of issue.

Contact your TeamTracks Account Manager to receive your Ocp-Apim-Subscription-Key, tenant_ID and the API user credentials.

##### All other endpoints require that token be sent over in the “Authorization” header.

## Related

- [ List of Objects](/list-of-objects.md)
- [Identifying ViewIDs](/identifying-viewids.md)