Find batch numbers and other cylinder details
GET
/asset-recall/values
const url = 'https://example.com/asset-recall/values?q=example';const options = { method: 'GET', headers: {cookie: '__Host-bottle.session_token=<__Host-bottle.session_token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://example.com/asset-recall/values?q=example' \ --cookie __Host-bottle.session_token=<__Host-bottle.session_token>Values recorded on cylinders now or before, under any of the business’s cylinder details, that contain q. Capitals and small letters match each other. An exact match is first, then values starting with q. Up to 20, each with how many cylinders carried it and how many carry it now.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”q
required
string
Responses
Section titled “Responses”Matching values
Media typeapplication/json
object
items
required
Array<object>
object
definitionId
required
UUID v7
string format: uuid
name
required
string
value
required
string
cylinders
required
integer
current
required
integer
Example
{ "items": [ { "definitionId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" } ]}Not signed in
Media typeapplication/json
object
error
required
string
message
required
string
Example
{ "error": "not_found", "message": "Customer not found"}Not an owner or admin, missing scope, or the plan does not open Assets
Media typeapplication/json
object
error
required
string
message
required
string
Example
{ "error": "not_found", "message": "Customer not found"}Assets is not available to this business
Media typeapplication/json
object
error
required
string
message
required
string
Example
{ "error": "not_found", "message": "Customer not found"}Assets is switched off
Media typeapplication/json
object
error
required
string
message
required
string
Example
{ "error": "not_found", "message": "Customer not found"}Validation failed
Media typeapplication/json
object
error
required
string
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{ "error": "validation", "issues": [ { "path": "email", "message": "Invalid email" } ]}