Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.getasset.com/llms.txt

Use this file to discover all available pages before exploring further.

Asset’s API uses OAuth 2.0 for authentication. All API requests require a valid access token, included in the Authorization header.

​
Getting an Access Token

  1. Set Up Your Tenant Account
    • A Tenant Account is required to authenticate with Asset’s API. If you don’t have one, reach out via our Contact form.
    • Once set up, you can manage OAuth credentials in the Asset Dashboard.
  2. Obtain Client Credentials
    • Register an application in the Asset Dashboard to receive a client_id and client_secret.
    • Separate credentials exist for Production and Sandbox environments.
  3. Request a Token
Use your client credentials to request an access token: 
curl --request POST \
  --url https://api.sandbox.getasset.com/v0/auth/token \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'client_id=<string>' \
  --data 'client_secret=The oauth client secret'
A successful response returns: 
{
  "access_token": "your-access-token",
  "token_type": "Bearer",
}

​
Scoping the access token to a business

You can scope the access token to a business by passing the business id as a body parameter 
curl --request POST \
  --url https://api.sandbox.getasset.com/v0/auth/token \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'client_id=<string>' \
  --data 'client_secret=The oauth client secret' \
  --data business_id=biz_GA6EG2qFxA97NZHtxeLPUy

​
Scoping the access token to a resource

You can scope the access token to a subset of resources and actions that can be done on that resource. For example, to create an access token to only create, read and update the ledgers, you can add the list of scopes to the request: 
curl --request POST \
 --url https://api.sandbox.getasset.com/v0/auth/token \
 --header 'Content-Type: application/x-www-form-urlencoded' \
 --data 'client_id=<string>' \
 --data 'client_secret=The oauth client secret' \
 --data 'scope=ledger:create ledger:update ledger:read'

​
Authenticating API Requests

Include the access token in the Authorization header: 
curl --request GET \
  --url "https://api.sandbox.getasset.com/v0/business?page_size=100" \
  --header "Authorization: Bearer YOUR_ACCESS_TOKEN"
Access tokens expire after a set time and must be renewed using the same OAuth flow. Manage credentials in the Asset Dashboard.
Credentials and tokens should always be kept secure—never share them outside your organization and exercise caution when sharing internally.
Questions? Reach out via our Contact form.