# API Information

<figure><img src="https://490131596-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0LJDMCSYOqplCEgCo73X%2Fuploads%2F1qFBf7aCFE0BcgCUDK6y%2Fimage.png?alt=media&#x26;token=12bc9045-9df6-4ad5-864f-b0008f50e622" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
*The API module is an additional module that can be added to your Fast-Weigh Subscription. Please contact our Support team at 865-219-2980 or support\@tacinsight, or review our* [*Additional Modules*](https://help.tacinsight.com/fast-weigh-knowledge-base/references/web-portal/account-and-administration/broken-reference) *for more information.*
{% endhint %}

***

## API Keys

API Keys are available to generate, view, and revoke from the main API menu screen.

<figure><img src="https://490131596-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0LJDMCSYOqplCEgCo73X%2Fuploads%2FeQfLC6wIvupURxc7rPug%2Fimage.png?alt=media&#x26;token=f65bc657-29d7-49db-b0ab-cccda55b2aa4" alt=""><figcaption></figcaption></figure>

To generate a new API Key, click the +New Key button and enter the users information, their Role, select their their Read/Write Permissions, and any note necessary information in the Comment in the new window, the click Update.

<figure><img src="https://490131596-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0LJDMCSYOqplCEgCo73X%2Fuploads%2F8xEiBPJppGFHx9AS93oL%2Fimage.png?alt=media&#x26;token=512f8334-f60f-45ef-9645-a51ef1f30fad" alt="" width="466"><figcaption></figcaption></figure>

The columns and fields above available display the following information:

* *Owner:* The user using the generated key.
* *Key:* The generated key.
* *Clipboard Copy:* Allows a single click to copy the key.
* *Permissions:* The users permissions related to Read or Write access.
* *Role:* The users role as a *Customer* or *Hauler*
* *Comment:* A note to associate or describe the current use of the key.
* *Revoked:* A Yes/No statement if they key is currently in use by the user.

***

## Authentication

The Fast-Weigh REST & GraphQL API services use token-based authentication with a custom `x-api-key` HTTP header record. The token should be included with every call.

{% hint style="info" %}
***Basic Authentication has been deprecated.***
{% endhint %}

We have transitioned from using Basic Authentication with username/password credentials to token-based authentication. Existing integrations will continue to work, but please note that Basic Authentication has been deprecated.

***

## GraphQL

**Endpoint:** [**https://graphql.fast-weigh.com**](https://graphql.fast-weigh.com)

**Authentication**: \[ **API Key ]** via **\[** **bearer token ]**

{% hint style="success" %}
As of October 2025, the **GraphQL API** is now unified under one endpoint URL

We are moving towards supporting this version of the API for the future, so we highly recommend adopting this new, unified GraphQL API.&#x20;
{% endhint %}

**Hitting the GQL API**&#x20;

To hit the api you can use a generated API Key from the API Info page in the Portal as a Bearer Token

`headers:`

`Authorization: "Bearer <api-key>"`

**Schema & Model Explorer:**

To view the **GraphQL** **Schema**, simply head to the endpoint directly: <https://graphql.fast-weigh.com>. This will take you to a web page where you can explore all the available query and mutation models.

<figure><img src="https://490131596-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0LJDMCSYOqplCEgCo73X%2Fuploads%2Fdpo8TpbmOKCxe925U5M3%2Fimage.png?alt=media&#x26;token=86a68124-fa01-4c9d-96ab-c5ac0773cee4" alt=""><figcaption><p>GQL Schema Page</p></figcaption></figure>

{% hint style="danger" %}
**Don't see API Info on your web portal?**

1. You may not be an **Admin** of your Fast-Weigh account. Check with a known admin to see if they can set up this key.
2. Your company's account may not have this enabled. If this is the case you will need to contact your sales or onboarding rep to get it enabled.
   {% endhint %}

***

## REST API

The REST API generally handles CREATE and UPDATE calls.

The OpenAPI/Swagger docs can be found here:

{% embed url="<https://api.fast-weigh.com/swagger>" %}

***

## Useful Reference Links

{% embed url="<https://docs.fast-weigh.dev>" %}
Overview
{% endembed %}

{% embed url="<https://docs.fast-weigh.dev/authentication/>" %}
Authentication
{% endembed %}

{% embed url="<https://docs.fast-weigh.dev/tooling/>" %}
Tooling
{% endembed %}

{% embed url="<https://docs.fast-weigh.dev/data-queries/overview/>" %}
Data Queries
{% endembed %}

{% embed url="<https://docs.fast-weigh.dev/custom-reporting/overview/>" %}
Custom Reporting
{% endembed %}

{% embed url="<https://docs.fast-weigh.dev/graphql/schema/>" %}
GraphQL
{% endembed %}

{% embed url="<https://docs.fast-weigh.dev/rest/crash-course/>" %}
REST API
{% endembed %}