v1

latestOpenAPI 3.0.02026-07-24102143224.1 KB

Items

List items

get/v3/items

Query parameters

pagenumber required

Page Number

limitnumber required

Number of items to return

filterstring

Format: field:rule:value — comma-separated for multiple filters.

Fields: name (string): eq, neq, like, nlike, in, nin, isnull, isnotnull externalId (string): eq, neq, like, nlike, in, nin, isnull, isnotnull externalIdType (string): eq, neq, like, nlike, in, nin, isnull, isnotnull

Example: filter=name:eq:value

Response

Get all Items by filter

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Example response

{
  "payload": {
    "data": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Item 1",
        "displayName": "Item 1 (Annual)",
        "externalIds": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000"
          }
        ]
      }
    ]
  }
}