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

# List items

> List catalog items with cursor pagination.

## Request

```http theme={null}
GET /v1/items?limit=20&starting_after=7f3a2c9e
```

| Parameter        | Type    | Required | Description                                                 |
| ---------------- | ------- | -------- | ----------------------------------------------------------- |
| `limit`          | integer | no       | Number of items to return. Defaults to `20`, maximum `100`. |
| `starting_after` | string  | no       | Item ID cursor from a previous response.                    |
| `category`       | string  | no       | Filters by `metadata.category`.                             |
| `created_after`  | integer | no       | Unix timestamp lower bound for `created`.                   |
| `created_before` | integer | no       | Unix timestamp upper bound for `created`.                   |

## Response

```json theme={null}
{
  "object": "list",
  "data": [
    {
      "id": "7f3a2c9e",
      "object": "item",
      "name": "Wireless Headphones",
      "description": "Noise-cancelling Bluetooth headphones.",
      "metadata": {
        "category": "electronics"
      },
      "active": true,
      "created": 1777478400,
      "updated_at": 1777478400
    }
  ],
  "has_more": false,
  "next_cursor": null,
  "url": "/v1/items"
}
```


## OpenAPI

````yaml GET /v1/items
openapi: 3.0.3
info:
  title: NeuronSearchLab Core API
  version: 1.0.0
  description: >-
    Versioned data-plane API for OAuth token exchange, catalog item ingestion,
    user event ingestion, and recommendation serving.
  license:
    name: Proprietary
    url: https://neuronsearchlab.com
servers:
  - url: https://api.neuronsearchlab.com
    description: Core API Gateway custom domain
security:
  - oauth2: []
tags:
  - name: Authentication
    description: OAuth 2.0 client credentials token exchange.
  - name: Items
    description: Catalog item ingestion, lookup, update, deletion, and pagination.
  - name: Events
    description: User interaction event ingestion, lookup, and pagination.
  - name: Recommendations
    description: >-
      Personalized recommendation serving, request-scoped filtering, and
      auto-section generation.
  - name: Search
    description: Query-driven search serving through the Core API data plane.
  - name: CORS
    description: Browser preflight routes generated by API Gateway.
paths:
  /v1/items:
    get:
      tags:
        - Items
      summary: List items
      description: >-
        List catalog items for the authenticated tenant using cursor-style
        pagination. Items are ordered by `entity_id` ascending.
      operationId: listItems
      parameters:
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/ItemStartingAfter'
        - name: category
          in: query
          description: Filter by `metadata.category`.
          schema:
            type: string
          example: electronics
        - name: created_after
          in: query
          description: Return items created at or after this Unix timestamp in seconds.
          schema:
            type: integer
            format: int64
            minimum: 1
          example: 1777478400
        - name: created_before
          in: query
          description: Return items created at or before this Unix timestamp in seconds.
          schema:
            type: integer
            format: int64
            minimum: 1
          example: 1777564800
      responses:
        '200':
          description: Paginated item list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ItemList'
              examples:
                items:
                  $ref: '#/components/examples/ItemList'
        '400':
          $ref: '#/components/responses/Error400'
        '401':
          $ref: '#/components/responses/Error401'
        '403':
          $ref: '#/components/responses/Error403'
        '500':
          $ref: '#/components/responses/Error500'
      security:
        - oauth2:
            - neuronsearchlab-api/read
components:
  parameters:
    Limit:
      name: limit
      in: query
      description: >-
        Maximum number of resources to return. Defaults to 20 and is capped at
        100.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
      example: 20
    ItemStartingAfter:
      name: starting_after
      in: query
      description: Cursor from a previous item list response.
      schema:
        type: string
        pattern: ^[A-Za-z0-9][A-Za-z0-9_-]{0,127}$
      example: 7f3a2c9e
  schemas:
    ItemList:
      allOf:
        - $ref: '#/components/schemas/ListEnvelope'
        - type: object
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/Item'
    ListEnvelope:
      type: object
      required:
        - object
        - data
        - has_more
        - url
      properties:
        object:
          type: string
          enum:
            - list
        data:
          type: array
          items: {}
        has_more:
          type: boolean
        next_cursor:
          type: string
          nullable: true
        url:
          type: string
    Item:
      type: object
      required:
        - id
        - object
        - name
        - description
        - metadata
        - active
        - created
        - updated_at
      properties:
        id:
          type: string
          pattern: ^[A-Za-z0-9][A-Za-z0-9_-]{0,127}$
          example: 7f3a2c9e
        object:
          type: string
          enum:
            - item
        name:
          type: string
          example: Wireless Headphones
        description:
          type: string
          example: Noise-cancelling Bluetooth headphones.
        metadata:
          $ref: '#/components/schemas/Metadata'
        active:
          type: boolean
          example: true
        created:
          type: integer
          format: int64
          nullable: true
          description: Unix timestamp in seconds.
          example: 1777478400
        updated_at:
          type: integer
          format: int64
          nullable: true
          description: Unix timestamp in seconds.
          example: 1777478500
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - not_found_error
                - conflict_error
                - rate_limit_error
                - api_error
            code:
              type: string
            message:
              type: string
            details: {}
            request_id:
              type: string
              format: uuid
          additionalProperties: true
    Metadata:
      type: object
      description: Arbitrary JSON object used for filtering, ranking, and debugging.
      additionalProperties: true
      example:
        category: electronics
        brand: Acme
        price: 10999
        currency: usd
  examples:
    ItemList:
      summary: Item list
      value:
        object: list
        data:
          - id: 7f3a2c9e
            object: item
            name: Wireless Headphones
            description: Noise-cancelling Bluetooth headphones.
            metadata:
              category: electronics
            active: true
            created: 1777478400
            updated_at: 1777478500
        has_more: false
        next_cursor: null
        url: /v1/items
    ErrorValidation:
      summary: Validation error
      value:
        error:
          type: invalid_request_error
          code: validation_error
          message: Validation error
          details:
            fieldErrors:
              name:
                - Required
    ErrorUnauthorized:
      summary: Unauthorized
      value:
        error:
          type: authentication_error
          code: unauthorized_no_client_id_in_jwt
          message: 'Unauthorized: No client ID in JWT'
  responses:
    Error400:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            validation:
              $ref: '#/components/examples/ErrorValidation'
    Error401:
      description: Unauthenticated
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            unauthorized:
              $ref: '#/components/examples/ErrorUnauthorized'
    Error403:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Error500:
      description: Server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://auth.neuronsearchlab.com/oauth2/token
          scopes:
            neuronsearchlab-api/read: Read recommendations, items, and events.
            neuronsearchlab-api/write: Create, update, and delete items; submit events.

````