Create an API token and connect a read integration

Use a token for an authenticated integration

An API token lets an external service authenticate on behalf of your account. It is different from a webhook URL token and Auth Secret: a webhook receives incoming lead submissions, while the authenticated API provides application and custom-field endpoints under account access rules.

Open your profile and choose API Tokens. Your token belongs to you, so its access is still subject to your account and company permissions. A token is not a way to bypass a missing carrier relationship or permission.

Create and copy a token

1. Choose Create in API Tokens.
2. Enter a useful Token name identifying the integration.
3. Select the Abilities offered in your account’s token form. Choose only the access the integration needs.
4. Set Token expiry if the form offers an expiry date for your workflow.
5. Create the token and copy the full value immediately.
6. Store it in the external service’s private credential settings, then select I have copied my token when finished.
7. Test a read request for a record you already expect this account to access before enabling an automated workflow.

Token fields and lifecycle controls

Start with read-only requests

The authenticated application endpoints include GET /api/v1/apps and GET /api/v1/apps/{application}. The application value in the second path is the application identifier provided by the API.

Custom-field integrations can read the company definitions with GET /api/v1/companies/{company}/custom-fields and read an application’s field values with GET /api/v1/apps/{application}/custom-fields. Use the host for your actual Truckers Data account; do not use addresses pictured in the demo screenshots.

Your developer should send the token using an Authorization: Bearer header and request JSON responses. Verify that the returned applications and company are the ones the account is permitted to use.

Understand custom-field identifiers before updating

The custom-field read response includes the definition’s identifier, stable key, label, type, options, required flag, formatted value, and raw value. Use the definition/key supplied for the receiving company rather than assuming another company uses the same identifier.

The custom-field update endpoint accepts a fields object keyed by field key, or a list using a definition identifier/key with a value. Unknown definitions are reported as a validation error. Changes do not alter the public application’s questions.

API and token troubleshooting