Sign in

v2

latestOpenAPI 3.0.02026-08-0793108394.2 KB
Equipment

Get a piece of equipment by ID.

get/v2/equipment/{organization_equipment_id}

Headers

X-Encircle-Attributionstring

String used to internally identify which integrator made this request on behalf of their users.

Integrators should reuse the same 'X-Encircle-Attribution' value for all their users.

This attribution enables Encircle to provide better assistance to integrators if they encounter any issues.

If not specified, the request will not be associated with any integration services.

X-Encircle-Requeststring

Unique string used to identify each specific request.

Any retries due to connection failures should reuse the same 'X-Encircle-Request' value. This helps prevent duplicate requests from unintentionally being processed again.

If not specified, the request will be treated as unique and it will be processed normally.

Response

A single Equipment object corresponding to the given ID.

idstring uuid required

A RFC 4122 compliant UUID in lowercase hexadecimal.

organization_idstring uuid required

A RFC 4122 compliant UUID in lowercase hexadecimal.

equipment_type'air_mover' | 'dehumidifier' | 'air_scrubber' | 'dryer' | 'heater' | 'other' required
equipment_spec_idstring uuid required

A RFC 4122 compliant UUID in lowercase hexadecimal.

manufacturerstring required
modelstring required
serial_numberstring nullable required
is_rentalboolean required
asset_identifierstring required
is_retiredboolean required
createdstring date-time required

A RFC 3339 compliant date-time string.

Example response

{
  "id": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
  "organization_id": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
  "equipment_spec_id": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
  "created": "1969-07-20T20:17:40Z"
}