Log inTry for free
Back to all APIs

Get items

Use this method to get a list of items from a catalog with pagination. Query parameters are optional and can be used to narrow list results.

Please log in to see full path URL. Learn why.
get
/catalogs/1/catalogs/{catalogId}/items
Authorizations:
API Key Header
Basic
IBSSO Token Header
OAuth 2
Scopes:
catalogs:manage
catalogs:read
catalogs:use
Request rate limit:
5 requests / second (per account)
path Parameters
catalogId
required
integer <int64>
Example: 10000

Catalog id.

query Parameters
queryFilter
string
Example: queryFilter=( type == "Jeans" AND type == "Shirt" ) OR ( price > 10.99 AND color == "Red" )

Enables filtering items using simple queries. Just pass to the parameter URL encoded query.

List of supported logical operators:
Logical OperatorDescription
ANDJoins query clauses with a logical AND. Returns all items that match the conditions of both clauses.
Example: price > 10.99 AND color == Red
ORJoins query clauses with a logical OR. Returns all items that match the conditions of either clause.
Example: type == Jeans OR type == Shirt
List of supported comparison operators:
Comparison OperatorSupported TypeDescription
Greater than: >integer, decimalMatches values that are greater than a specified value.
Example: price > 99.99
Greater or equal: ≥integer, decimalMatches all values that are greater than or equal to a specified value.
Example: price ≥ 99.99
Less than: <integer, decimalMatches all values that are less than a specified value.
Example: price < 99.99
Less or equal: ≤integer, decimalMatches all that are values less than or equal to a specified value.
Example: price ≤ 99
Equal: ==integer, decimal, string, date, time, dateTimeMatches values that are equal to a specified value.
Example: color == green
Not equal: !=integer, decimal, string, date, time, dateTimeMatches values that are not equal to a specified value.
Example: color != green
List of supported date/time range operators:
Date/time Range OperatorSupported TypeDescription
BETWEENdate, time, dateTimeSpecifies date/time range between dates.
Example: createdAt BETWEEN 2023-03-01 AND 2023-03-30
NOT BETWEENdate, time, dateTimeSpecifies date/time range not between dates.
Example: createdAt NOT BETWEEN 2023-03-01 AND 2023-03-30
List of supported string operators:
String Operator   Supported TypeDescription
STARTS WITHstringMatches all values starting with specific substring.
Example: name STARTS WITH Bo
ENDS WITHstringMatches all values ending with specific substring.
Example: name ENDS WITH an
.
page
integer <int32> >= 0
Default: 0

Results page to retrieve (0..N).

size
integer <int32> [ 1 .. 100 ]
Default: 10

Number of items per page.

Responses

200

Successful Response

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

500

Internal Server Error

Request samples

Example
cURL
Copy
curl -L -g 'https://{baseUrl}/catalogs/1/catalogs/10000/items?queryFilter=(%20type%20%3D%3D%20%22Jeans%22%20AND%20type%20%3D%3D%20%22Shirt%22%20)%20OR%20(%20price%20%3E%2010.99%20AND%20color%20%3D%3D%20%22Red%22%20)' \
-H 'Authorization: {authorization}' \
-H 'Accept: application/json'

Response samples

Content type
application/json
Copy
 Collapse all
{
  • "results":
    [
    • {
      • "id": 1,
      • "values":
        [
        • {
          • "fieldName": "Example field 1",
          • "fieldId": "caad56e4-2a1c-4ae8-9717-ebb40d05533d",
          • "value": 123
          },
        • {
          • "fieldName": "Example field 2",
          • "fieldId": "87897d8f-8986-4d70-bdec-f89c3cbf042d",
          • "value": "Example text 1"
          }
        ]
      },
    • {
      • "id": 2,
      • "values":
        [
        • {
          • "fieldName": "Example field 1",
          • "fieldId": "caad56e4-2a1c-4ae8-9717-ebb40d05533d",
          • "value": 412
          },
        • {
          • "fieldName": "Example field 2",
          • "fieldId": "87897d8f-8986-4d70-bdec-f89c3cbf042d",
          • "value": "Example text 2"
          }
        ]
      },
    • {
      • "id": 3,
      • "values":
        [
        • {
          • "fieldName": "Example field 1",
          • "fieldId": "caad56e4-2a1c-4ae8-9717-ebb40d05533d",
          • "value": 267
          },
        • {
          • "fieldName": "Example field 2",
          • "fieldId": "87897d8f-8986-4d70-bdec-f89c3cbf042d",
          • "value": "Example text 3"
          }
        ]
      }
    ],
  • "paging":
    {
    • "page": 1,
    • "size": 20,
    • "totalPages": 1,
    • "totalResults": 3
    }
}
Need assistance Explore Infobip Tutorials
Encountering issues Contact our support
What's new? Check out Release Notes
Unsure about a term? See Glossary
Research panel

Help shape the future of our products

Learn more
Service statusCopyright @ 2006-2025 Infobip ltd.
Privacy documentsTerms of use