Docs

List assets

Preview· P9
GET
/assets

The asset register, newest first, by cursor. A value shows only with assets.value_read.

Scope: assets:read

Authorization

headerAuthorizationBearer <token>

Send Authorization: Bearer <token> on every request. The token is one of:

PrefixWhat it isWhere it may be used
agoo_sk_live_Secret key, live modeYour servers only
agoo_sk_test_Secret key, test modeYour servers only
agoo_pk_live_Publishable key, live modeBrowsers and apps: create pre-registrations and bookings, read public booking types (with their intake questions) and their free slots, read the visit types open for pre-registration with their public forms. Never lists people.
agoo_pk_test_Publishable key, test modeAs above, in test mode
agoo_rk_live_Agoo Reviews key, live mode: a business on Agoo Reviews on its own, on Reviews BusinessYour servers only: the Reviews operations, for that business and the branches the key names
agoo_rk_test_Agoo Reviews key, test modeAs above, on any level: it reads the business's reviews and checks every write without saving it
agoo_ck_live_Check API key, live mode, for a Check API partnerYour servers only: the Checks operations (checks:read), billed per check
agoo_ck_test_Check API key, test modeAs above, answering only the published test values, never billed

Admins create keys in Console → Developers → API keys and choose each key's scopes; a business on Agoo Reviews on its own creates its keys in its business area on agoo.reviews, under Developers; a Check API partner creates its keys in its partner area on agoo.reviews. A key is shown once. Never put a secret key in a URL, a browser or a mobile app.

Scope: assets:read

Query Parameters

q?string

A word from its name, or an exact tag, serial, IMEI or barcode.

Lengthlength <= 120
status?string

Only these.

Value in"in_stock""assigned""in_repair""lost""retired"
category_id?string

Only this category.

site_id?string

Only this site.

person_id?string

Only what this person holds.

after?string

The cursor: next_cursor from the last page.

limit?integer

Up to 200.

Range1 <= value <= 200

Response Body

A page of assets.

application/json
  1. response
data*array<>
next_cursor*string
has_more*boolean
curl -X GET 'https://api.agoohq.com/v1/assets'
{  "data": [    {      "id": "string",      "name": "string",      "tag": "string",      "barcode": "string",      "serial": "string",      "imei": "string",      "status": "in_stock",      "condition": "new",      "category": {        "id": "string",        "name": "string",        "is_ppe": true      },      "site": {        "id": "string",        "name": "string"      },      "room": "string",      "supplier": "string",      "purchase_date": "2019-08-24",      "warranty_until": "2019-08-24",      "insurance_until": "2019-08-24",      "shared": true,      "holder": {        "id": "string",        "asset_id": "string",        "holder_kind": "person",        "person": {          "id": "string",          "name": "string"        },        "site": {          "id": "string",          "name": "string"        },        "team": {          "id": "string",          "name": "string"        },        "pool_name": "string",        "condition_out": "new",        "expected_return_on": "2019-08-24",        "assigned_at": "2019-08-24T14:15:22Z",        "ack_state": "not_needed",        "returned_at": "2019-08-24T14:15:22Z",        "condition_in": "new",        "version": 0      },      "value_minor": 0,      "value_currency": "string",      "custom": {},      "version": 0,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string",  "has_more": true}