Reference Data

Read-only catalog of equipment types. The ids are what order and load equipment arrays reference. The list is system-managed and small — fetch it once and cache it, or hardcode the ids your integration uses.

The catalog is global and organization-independent: every authenticated organization sees the same rows.

get/reference-data/equipment

Request

  • Base URL: https://api.mvmnt.io/v1
  • URL: https://api.mvmnt.io/v1/reference-data/equipment
  • Auth: HTTP bearer

Query parameters

categoryIdstring uuid

Only return equipment in this category

groupIdstring uuid

Only return equipment in this top-level group

subcategoryIdstring uuid

Only return equipment in this subcategory

Response

Successful response

Example response

{
  "data": [
    {
      "name": "Van 53'",
      "category": {
        "name": "Van"
      },
      "group": {
        "name": "Trailer"
      }
    }
  ]
}

Changes

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      the optional response header X-RateLimit-Reset removed for the status 429

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      endpoint added