Sign in

v2

latestOpenAPI 3.0.02026-08-0793108394.2 KB
Equipment

Find organization equipment.

get/v2/equipment

Query parameters

organization_idstring uuid

A RFC 4122 compliant UUID in lowercase hexadecimal.

Example:f81d4fae-7dec-11d0-a765-00a0c91e6bf6

Filter by an organization ID.

is_retiredboolean

Filter by whether or not the equipment has been retired.

equipment_type'air_mover' | 'dehumidifier' | 'air_scrubber' | 'dryer' | 'heater' | 'other'

Filter by type of equipment

currently_placed_in_claim_idinteger

Filter by the claim ID of where the equipment is currently placed

order'newest' | 'oldest'

Specifies the ordering of results.

If not specified, defaults to newest.

newest

Ordered by creation date in descending order (newest first).

oldest

Ordered by creation date in ascending order (oldest first).

limitinteger

Maximum number of results to return.

Maximum limit is '100'. If not specified, defaults to '50'.

afterstring jwt

If not specified, fetches the first page of results.

A string obtained from previous API queries. Used to fetch the next page of results.

See the after key in the response for more information.

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 list of Equipment in your organization and its child organizations.

Example response

{
  "list": [
    {
      "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"
    }
  ]
}