> ## Documentation Index
> Fetch the complete documentation index at: https://docs.notifly.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# List catalog items

> List 50 items per page in ascending ID order. Use the cursor or the `Link` header to get the next page.



## OpenAPI

````yaml /en/api-reference/openapi.yaml get /v1/projects/{projectId}/catalogs/{catalogName}/items
openapi: 3.0.3
info:
  title: Notifly API
  version: 1.0.0
  contact:
    email: contact@notifly.tech
servers:
  - url: https://api.notifly.tech
    description: Notifly API server
security: []
tags:
  - name: catalog
    x-group: Catalogs
paths:
  /v1/projects/{projectId}/catalogs/{catalogName}/items:
    parameters:
      - $ref: '#/components/parameters/ProjectId'
      - name: catalogName
        in: path
        description: Unique name supplied when the catalog was created.
        required: true
        schema:
          type: string
          pattern: ^[A-Za-z0-9_-]+$
          maxLength: 250
    get:
      tags:
        - catalog
      summary: list-api-catalog-items
      description: >-
        List 50 items per page in ascending ID order. Use the cursor or the
        `Link` header to get the next page.
      operationId: listApiCatalogItems
      parameters:
        - name: cursor
          in: query
          description: >-
            The `data.next_cursor` value from the previous response. Pass the
            value as returned.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          headers:
            Link:
              $ref: '#/components/headers/Link'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogItemListResponse'
        '400':
          $ref: '#/components/responses/CatalogBadRequest'
        '401':
          $ref: '#/components/responses/CatalogUnauthenticated'
        '403':
          $ref: '#/components/responses/CatalogPermissionDenied'
        '404':
          $ref: '#/components/responses/CatalogNotFound'
        '413':
          $ref: '#/components/responses/CatalogPayloadTooLarge'
        '500':
          $ref: '#/components/responses/CatalogInternalServerError'
      security:
        - bearerAuth: []
components:
  parameters:
    ProjectId:
      name: projectId
      in: path
      description: Notifly project ID.
      required: true
      schema:
        type: string
        pattern: ^[a-f0-9]{32}$
        minLength: 32
        maxLength: 32
  headers:
    Link:
      description: RFC 8288 pagination links.
      schema:
        type: string
  schemas:
    CatalogItemListResponse:
      type: object
      required:
        - data
        - error
      properties:
        data:
          type: object
          required:
            - items
            - next_cursor
            - links
          properties:
            items:
              type: array
              items:
                $ref: '#/components/schemas/CatalogItem'
            next_cursor:
              type: string
              nullable: true
            links:
              $ref: '#/components/schemas/Links'
        error:
          nullable: true
          enum:
            - null
      example:
        data:
          items:
            - id: sku-001
              name: 에브리데이 백팩
              price: 59000
          next_cursor: eyJpZCI6InNrdS0wMDEifQ
          links:
            next: >-
              /v1/projects/0123456789abcdef0123456789abcdef/catalogs/products/items?cursor=eyJpZCI6InNrdS0wMDEifQ
        error: null
    CatalogItem:
      type: object
      description: >-
        A catalog item that you manage. Notifly returns values as stored,
        without classifying or masking them. Keep personal names, email
        addresses, phone numbers, external user IDs, profile fields, and other
        identifying values out of the catalog.
      required:
        - id
      properties:
        id:
          type: string
          pattern: ^[A-Za-z0-9_-]+$
          maxLength: 250
      additionalProperties:
        $ref: '#/components/schemas/CatalogJsonValue'
    Links:
      type: object
      additionalProperties:
        anyOf:
          - type: string
          - nullable: true
            enum:
              - null
    CatalogApiErrorResponse:
      type: object
      required:
        - data
        - error
      properties:
        data:
          nullable: true
          enum:
            - null
        error:
          $ref: '#/components/schemas/CatalogApiError'
      example:
        data: null
        error:
          code: INVALID_ARGUMENT
          message: Invalid bulk item request.
          details:
            - field: items[0].unknown_field
              path:
                - items
                - 0
                - unknown_field
              code: invalid-fields
              message: 'Unrecognized field: unknown_field.'
    CatalogJsonValue:
      description: >-
        A recursive JSON value for a catalog item field. A string can contain up
        to 5,000 characters, an array can hold up to 100 entries, and objects
        and arrays can nest up to 50 levels.
      oneOf:
        - type: string
          maxLength: 5000
        - type: number
        - type: boolean
        - nullable: true
          enum:
            - null
        - type: array
          maxItems: 100
          items:
            $ref: '#/components/schemas/CatalogJsonValue'
        - type: object
          additionalProperties:
            $ref: '#/components/schemas/CatalogJsonValue'
          description: >-
            Stored object keys cannot contain periods or dollar signs. Use
            `$add` and `$remove` only as operators to `PATCH` an array field.
    CatalogApiError:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
        message:
          type: string
        details:
          type: array
          description: >-
            Identifies fields and paths where validation failed. Use these
            structured fields in clients.
          items:
            $ref: '#/components/schemas/CatalogApiValidationErrorDetail'
      additionalProperties: true
    CatalogApiValidationErrorDetail:
      type: object
      description: >-
        One validation error. The `field` value is a human-readable path with
        dots and brackets. The `path` value represents the same location as an
        array of strings and numbers.
      required:
        - field
        - path
        - code
        - message
      properties:
        field:
          type: string
          description: >-
            Field path in dot and bracket notation, for example
            `items[0].price`.
        path:
          type: array
          description: Field path as an array of string and number segments.
          items:
            anyOf:
              - type: string
              - type: integer
        code:
          type: string
          description: Code that identifies why the input was rejected.
        message:
          type: string
          description: Human-readable validation error message.
      additionalProperties: false
  responses:
    CatalogBadRequest:
      description: Invalid Catalog request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CatalogApiErrorResponse'
    CatalogUnauthenticated:
      description: Authentication required.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CatalogApiErrorResponse'
    CatalogPermissionDenied:
      description: Project access denied.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CatalogApiErrorResponse'
    CatalogNotFound:
      description: Catalog resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CatalogApiErrorResponse'
    CatalogPayloadTooLarge:
      description: JSON body exceeds 4 MiB.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CatalogApiErrorResponse'
    CatalogInternalServerError:
      description: Internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CatalogApiErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Pass the token issued by `POST /authenticate` as a bearer token.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.