Fetches a list of equipment components based on filters.

GET/api/v2/equipment/components/list

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentials

Parameters

equipmentIdqueryinteger · int32

The ID of the equipment to filter components.

pageNumberqueryinteger · int32

The page number for pagination (default is 1).

pageSizequeryinteger · int32

The page size for pagination (default is 10).

Responses

Request successful with equipment component data.

Standard response envelopeisSuccessmessageerrorsdata

Read the result from data. When isSuccess is false, errors lists what went wrong. Handling errors

Paginated

totalCountinteger · int32
- componentIdinteger · int32
- equipmentIdinteger · int32
- componentLookupIdinteger · int32
- componentCategoryIdinteger · int32
- componentTypeIdinteger · int32
- descriptionstring
- startDatestring · datenullable
- startHoursnumber · double
- partNostring
- serialNostring
- averageLifenumber · double
- adjustedLifenumber · double
- remainingLifenumber · double
- percentUsednumber · double
- dueDatestring · datenullable
- commentsstring
- replacedboolean
- deletedboolean
pageCountinteger · int32
currentPageCountinteger · int32
nextPageNumberinteger · int32nullable
hasNextPageboolean

REQUEST EXAMPLE

curl --request GET \
  'https://apiv2.crmseries.com/api/v2/equipment/components/list' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace the uppercase placeholders and sample values with your integration values.

RESPONSE · 200

{
  "isSuccess": true,
  "message": "",
  "data": {
    "totalCount": 42,
    "data": [
      {
        "componentId": 1024,
        "equipmentId": 1024,
        "componentLookupId": 1024,
        "componentCategoryId": 1024,
        "componentTypeId": 1024,
        "description": "string",
        "startDate": "2026-01-15",
        "startHours": 3250,
        "partNo": "string",
        "serialNo": "CAT0320XABC12345",
        "averageLife": 1.5,
        "adjustedLife": 1.5,
        "remainingLife": 1.5,
        "percentUsed": 1.5,
        "dueDate": "2026-01-15",
        "comments": "string",
        "replaced": false,
        "deleted": false
      }
    ],
    "pageCount": 42,
    "currentPageCount": 42,
    "nextPageNumber": 1,
    "hasNextPage": true
  },
  "errors": []
}