OAuth

Get OAuth access token

Obtain an access token using the OAuth 2.0 Client Credentials grant type.

The access token should be included in subsequent API requests in the Authorization header: Authorization: Bearer <access_token>

post/v1/oauth/token

Request

  • Base URL: https://api.handoff.ai
  • URL: https://api.handoff.ai/v1/oauth/token
  • Auth: none declared

Request body

grant_type'client_credentials' required

Must be "client_credentials"

client_idstring uuid required

Your OAuth client ID

client_secretstring required

Your OAuth client secret

scopestring

Space-separated list of requested scopes (optional, defaults to all granted scopes). Available scopes: estimates:read, estimates:write, materials:create, blueprints:create, presets:manage, files:manage, data:delete, webhooks:manage

Example request

{
  "grant_type": "client_credentials",
  "client_id": "550e8400-e29b-41d4-a716-446655440000",
  "client_secret": "your-client-secret",
  "scope": "estimates:read estimates:write materials:create blueprints:create presets:manage files:manage data:delete webhooks:manage"
}

Response

Access token issued successfully

access_tokenstring required

JWT access token

token_type'Bearer' required
expires_ininteger required

Token lifetime in seconds

scopestring required

Space-separated list of granted scopes

Example response

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 3600,
  "scope": "estimates:read estimates:write materials:create blueprints:create presets:manage files:manage data:delete webhooks:manage"
}

Changes

No recorded changes to this operation across all 1 revision of this API.