EndpointsResourcesResourcesId
Retrieve an inventory item
The API runs on your application instance. Schemas and field names come directly from the OpenAPI specification. Session-authenticated requests require a session on that instance.
GET
bearerAuthheader
AuthorizationBearer <inv_ token>id*stringResource UUID or one of the resource's organization-scoped slugs.
Length
1 <= length <= 80language?stringEnabled BCP 47 content language. Missing or stale translated fields fall back to canonical content.
Length
length <= 35X-Organization-ID?stringOrganization membership selected for this request. User-bound credentials may select any active membership; standalone tokens may only repeat their pinned organization ID.
Format
uuidInventory item
application/json- response
resource?curl -X GET 'https://inventory.example.com/api/v1/resources/string'Example Response
{ "resource": { "name": "string", "slugs": [ "string" ], "description": "string", "type": "string", "status": "available", "sku": "string", "barcode": "string", "quantity": 0, "location": "string", "serialNumber": "string", "valueCents": 0, "currency": "str", "priority": 1, "tags": [ "string" ], "categories": [ { "name": "string", "color": "string" } ], "relatedResourceIds": [ "5bd7452e-6f9b-4bd6-99d1-e742582a0663" ], "gpsLatitude": -90, "gpsLongitude": -180, "gpsAltitude": 0, "mapFeatures": [ { "id": "string", "type": "point", "layer": "string", "description": "string", "coordinates": [ 0, 0 ] } ], "notes": "string", "customFields": { "property1": "string", "property2": "string" }, "subtitle": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "media": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6", "url": "string", "name": "string", "mimeType": "string", "kind": "image", "position": 0, "source": "upload", "altText": "string" } ], "cover": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6", "url": "string", "name": "string", "mimeType": "string", "kind": "image", "position": 0, "source": "upload", "altText": "string" } }}