Skip to Content
Getting Started

Quickstart

Getting Started

To begin using the Asset API, follow these steps:

  1. Sign Up: Register for an Asset Tenant Account to obtain your API credentials.
  2. Obtain API Tokens: After registration, retrieve your API Tokens from the Asset Tenant dashboard.
  3. Authentication: Authenticate your application using the provided credentials.

Making Your First API Call

Once authenticated, you can start making API requests. For instance, to Create your first Business in the sandbox. The token needs the business:create scope.

Request:

curl --request POST \
  --url https://api.sandbox.getasset.com/v0/business \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Roofing Pros",
  "entity_type": "c-corp",
  "entries_start": "2025-01-01T00:00:00Z",
  "fiscal_year": "01/01",
  "external_id": "customer_1234"
}'

Response:

A successful request returns 201, with the Business inside data:

{
  "data": {
    "id": "biz_GA6EG2qFxA97NZHtxeLPUy",
    "tenant_id": "ten_Vl1a3f7JlZ9pZ5hL2wNfLn",
    "name": "Roofing Pros",
    "entity_type": "c-corp",
    "entries_start": "2025-01-01T00:00:00Z",
    "fiscal_year": "01/01",
    "external_id": "customer_1234",
    "status": "active",
    "plan": "managed"
  }
}

The response has more fields than shown here.

Verify the Business

Check that the Business exists, and that you saved the right ID, by retrieving it. It needs the business:read scope.

curl --request GET \
  --url https://api.sandbox.getasset.com/v0/business/biz_GA6EG2qFxA97NZHtxeLPUy \
  --header 'Authorization: Bearer <token>'

You should get a 200 with the same Business. Check that data.id matches the ID you saved and that data.external_id is the one you sent.

Next Steps

On this page