Change an asset
Name the version you read: a stale one is version_stale (409), and nothing changes.
Scope: assets:write
AuthorizationBearer <token>Send Authorization: Bearer <token> on every request. The token is one of:
| Prefix | What it is | Where it may be used |
|---|---|---|
agoo_sk_live_ | Secret key, live mode | Your servers only |
agoo_sk_test_ | Secret key, test mode | Your servers only |
agoo_pk_live_ | Publishable key, live mode | Browsers 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 mode | As above, in test mode |
agoo_rk_live_ | Agoo Reviews key, live mode: a business on Agoo Reviews on its own, on Reviews Business | Your servers only: the Reviews operations, for that business and the branches the key names |
agoo_rk_test_ | Agoo Reviews key, test mode | As 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 partner | Your servers only: the Checks operations (checks:read), billed per check |
agoo_ck_test_ | Check API key, test mode | As 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:write
asset_id*string^asset_[0-7][0-9a-hjkmnp-tv-z]{25}$version*integerThe version you read.
1 <= valueIdempotency-Key*stringA UUID you generate for this operation. If you retry with the same key within 24 hours, Agoo returns the
original response instead of acting twice. While the first request is still running, a retry returns
conflict. Reusing a key with a different request returns idempotency_key_reused. Responses with
rate_limited, internal_error or unavailable aren't stored, so retry those with the same key.
uuidapplication/json- body
Adds or changes an asset. To empty a field, name it in clear.
name?stringlength <= 160category_id?stringtag?stringlength <= 40barcode?stringlength <= 80serial?stringlength <= 120imei?stringlength <= 40site_id?stringWhen adding. To change where something is, use its move.
room?stringlength <= 120supplier?stringlength <= 160value_minor?integerWhole minor units. Needs assets.value_read.
0 <= valuevalue_currency?stringpurchase_date?stringdatewarranty_until?stringdateinsurance_until?stringdatemaintenance_due_on?stringdatelicence_until?stringdateinspect_every_days?integer1 <= value <= 3660condition?string"new""good""fair""poor""damaged"owner_person_id?stringWho reminders go to. Nobody named: whoever manages assets.
shared?booleanStaff may check it out for themselves by scanning it.
legal_entity_id?stringphoto_file_ids?array<string>items <= 12custom?The category's own fields.
notes?stringlength <= 2000clear?array<string>Fields to empty.
items <= 20The asset.
application/json- response
id*stringname*stringtag*stringbarcode?stringserial?stringimei?stringstatus*string"in_stock""assigned""in_repair""lost""retired"condition*string"new""good""fair""poor""damaged"category*site?room?stringsupplier?stringpurchase_date?stringdatewarranty_until?stringdateinsurance_until?stringdateshared?booleanholder?value_minor?integerWhole minor units, with assets.value_read.
value_currency?stringcustom?version*integercreated_at*stringdate-timeupdated_at*stringdate-timecurl -X PATCH 'https://api.agoohq.com/v1/assets/string?version=1' \ -H 'Idempotency-Key: 3f6b2a1e-8c4d-4f7a-9b2e-5d1c0a7e9f64' \ -H 'Content-Type: application/json' \ -d '{}'{ "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"}Get an asset GET
One asset and who holds it. One the key can't see doesn't exist for it. **Scope:** `assets:read`
Issue an asset POST
To a person, a site, a team or a shared pool, one holder at a time. Fires `asset.assigned`. A person signs an acknowledgement through e-signature unless the category doesn't ask or you excuse them with a reason; it never holds up the hand-over. **Scope:** `assets:write`