API Information
API Keys
API Keys are available to generate, view, and revoke from the main API menu screen.
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.
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.
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
Authentication: [ API Key ] via [ bearer token ]
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.
Hitting the GQL API
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.
Don't see API Info on your web portal?
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.
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.
REST API
The REST API generally handles CREATE and UPDATE calls.
The OpenAPI/Swagger docs can be found here:
Useful Reference Links
Last updated