Equipment

Returns a list of your Equipment. Archived Equipment is not included in the results.

get/equipment

Request

Query parameters

start_cursorstring

The start cursor for Keyset pagination.

per_pageinteger

The number of records per page to return.

The fields, operations, and values to filter the records by.

in_service_date'asc' | 'desc'
out_of_service_date'asc' | 'desc'
purchase_date'asc' | 'desc'
created_at'asc' | 'desc'
updated_at'asc' | 'desc'
id'asc' | 'desc'

The fields and direction to sort the results by.

Response

OK

start_cursorstring nullable

The current start cursor of the records returned.

next_cursorstring nullable

The next cursor to retrieve the next page of records.

per_pageinteger

The maximum number of records returned.

estimated_remaining_countinteger

The number of remaining records including the returned records, up to a maximum of 500.

Example response

{
  "records": [
    {
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "purchase_date": "2023-03-14",
      "warranty_expiration_date": "2023-03-14",
      "in_service_date": "2023-03-14",
      "out_of_service_date": "2023-03-14"
    }
  ]
}

Changes

    • info

      for the query request parameter per_page, the min was decreased from 2.00 to 1.00

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status