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

# Lists the service provider's item catalog: products and bundles.

> All filters are optional and combine with AND.


One resource for both kinds of item — `Type` says which. A bundle is a product made
of other products; an invoice line references either kind through one `ItemId`. Labor
items are internal to contract pricing, are not creatable in the app, and are never
returned here.

`Status` reflects whether the item is archived: 1 Active, 2 Archived. Archived items
are left out unless `statusIds` names Archived.

`CategoryId`, `SubcategoryId`, `ClientId` and `LocationId` are bare
ids — resolve a category/subcategory against `GET /v1/items/categories`.




## OpenAPI

````yaml /api-reference/openapi.json get /v1/items
openapi: 3.0.4
info:
  title: Public API
  description: Gorelo Public API documentation.
  version: 1.0.0
servers:
  - url: https://api.usw.gorelo.io
    description: US
  - url: https://api.aue.gorelo.io
    description: Australia
security:
  - ApiKeyAuth: []
tags:
  - name: Attachments
    description: "Uploading a file, for anything that can carry one. One endpoint rather than one per record\r\ntype, because the upload itself is identical - only the record it is checked against differs."
  - name: Alerts
    description: Alerts management operations
  - name: Assets
    description: Assets management operations
  - name: Billing
    description: Billing management operations
  - name: Tickets
    description: Tickets management operations
  - name: Clients
    description: Clients management operations
  - name: Contacts
    description: Contacts management operations
  - name: Deletions
    description: Deletions management operations
  - name: Documents
    description: Documents management operations
  - name: Forms
    description: Forms management operations
  - name: Organization
    description: Organization management operations
  - name: Projects
    description: Projects management operations
paths:
  /v1/items:
    get:
      tags:
        - Billing
      summary: 'Lists the service provider''s item catalog: products and bundles.'
      description: "All filters are optional and combine with AND.\r\n\n\r\nOne resource for both kinds of item — `Type` says which. A bundle is a product made\r\nof other products; an invoice line references either kind through one `ItemId`. Labor\r\nitems are internal to contract pricing, are not creatable in the app, and are never\r\nreturned here.\r\n\n`Status` reflects whether the item is archived: 1 Active, 2 Archived. Archived items\r\nare left out unless `statusIds` names Archived.\r\n\n`CategoryId`, `SubcategoryId`, `ClientId` and `LocationId` are bare\r\nids — resolve a category/subcategory against `GET /v1/items/categories`.\r\n"
      operationId: get_v1_items
      parameters:
        - name: Cursor
          in: query
          description: >-
            Opaque pagination cursor from a previous page; omit for the first
            page. Only valid against the same filters that produced it.
          schema:
            type: string
        - name: PageSize
          in: query
          description: >-
            Number of items per page. Rejected with a 400 outside 1-200 (default
            50).
          schema:
            type: integer
            format: int32
            default: 50
        - name: TypeIds
          in: query
          description: Comma-separated item type ids (1 Product, 2 Bundle).
          schema:
            type: string
        - name: CategoryIds
          in: query
          description: Comma-separated category ids.
          schema:
            type: string
        - name: SubcategoryIds
          in: query
          description: Comma-separated subcategory ids.
          schema:
            type: string
        - name: ClientIds
          in: query
          description: Comma-separated client ids.
          schema:
            type: string
        - name: Skus
          in: query
          description: Comma-separated SKUs, matched exactly.
          schema:
            type: string
        - name: Vendors
          in: query
          description: Comma-separated vendor names, matched exactly.
          schema:
            type: string
        - name: PartNumbers
          in: query
          description: Comma-separated manufacturer part numbers, matched exactly.
          schema:
            type: string
        - name: StatusIds
          in: query
          description: >-
            Comma-separated status ids: 1 Active, 2 Archived. Omitted returns
            Active only (archived excluded). Any other id is a 400.
          schema:
            type: string
        - name: Query
          in: query
          description: >-
            Free-text keyword matched against Name and Description. Max 200
            characters.
          schema:
            type: string
        - name: CreatedSince
          in: query
          description: Only items created on or after this UTC instant.
          schema:
            type: string
            format: date-time
        - name: CreatedBefore
          in: query
          description: Only items created on or before this UTC instant.
          schema:
            type: string
            format: date-time
        - name: UpdatedSince
          in: query
          description: Only items last changed on or after this UTC instant.
          schema:
            type: string
            format: date-time
        - name: UpdatedBefore
          in: query
          description: Only items last changed on or before this UTC instant.
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ItemListModelListBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ItemListModelListBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ItemListModelListBaseResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
components:
  schemas:
    ItemListModelListBaseResponse:
      type: object
      properties:
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        IsSuccess:
          type: boolean
        Data:
          type: array
          items:
            $ref: '#/components/schemas/ItemListModel'
          nullable: true
        DataContext:
          $ref: '#/components/schemas/PaginationDataContext'
        Notifications:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
    ObjectBaseResponse:
      type: object
      properties:
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        IsSuccess:
          type: boolean
        Data:
          nullable: true
        DataContext:
          $ref: '#/components/schemas/ErrorDataContext'
        Notifications:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
    HttpStatusCode:
      enum:
        - 100
        - 101
        - 102
        - 103
        - 200
        - 201
        - 202
        - 203
        - 204
        - 205
        - 206
        - 207
        - 208
        - 226
        - 300
        - 301
        - 302
        - 303
        - 304
        - 305
        - 306
        - 307
        - 308
        - 400
        - 401
        - 402
        - 403
        - 404
        - 405
        - 406
        - 407
        - 408
        - 409
        - 410
        - 411
        - 412
        - 413
        - 414
        - 415
        - 416
        - 417
        - 421
        - 422
        - 423
        - 424
        - 426
        - 428
        - 429
        - 431
        - 451
        - 500
        - 501
        - 502
        - 503
        - 504
        - 505
        - 506
        - 507
        - 508
        - 510
        - 511
      type: integer
      format: int32
    ItemListModel:
      type: object
      properties:
        Id:
          type: string
          description: Identifier of the item.
          format: uuid
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        Type:
          $ref: '#/components/schemas/CodeModel'
        Status:
          $ref: '#/components/schemas/CodeModel'
        Name:
          type: string
          description: Display name of the item.
          example: Managed Workstation - Standard
        Number:
          type: string
          description: The item's product number, free text. Not clearable once set.
          nullable: true
        Description:
          type: string
          description: Free-text description.
          nullable: true
        CategoryId:
          type: integer
          description: >-
            Category the item is filed under, resolvable against GET
            /v1/items/categories.
          format: int64
          nullable: true
        SubcategoryId:
          type: integer
          description: Subcategory the item is filed under, nested under CategoryId.
          format: int64
          nullable: true
        ClientId:
          type: integer
          description: >-
            Client this item is scoped to, when it is client-specific rather
            than catalog-wide.
          format: int64
          nullable: true
        LocationId:
          type: integer
          description: >-
            Client location this item is scoped to. Only meaningful alongside
            ClientId.
          format: int64
          nullable: true
        Sku:
          type: string
          description: Stock-keeping unit. Product-only; null for a bundle.
          nullable: true
        PartNumber:
          type: string
          description: Manufacturer part number. Product-only; null for a bundle.
          nullable: true
        Manufacturer:
          type: string
          description: Manufacturer name. Product-only; null for a bundle.
          nullable: true
        Vendor:
          type: string
          description: Vendor the item is sourced from.
          nullable: true
        UnitCost:
          type: number
          description: "Unit cost. For a product this is its current cost. For a bundle this is the sum of its\r\nsub-items' unit cost times quantity."
          format: double
          nullable: true
          example: 42.5
        UnitPrice:
          type: number
          description: Unit price charged to the client.
          format: double
          nullable: true
          example: 89
        TaxId:
          type: integer
          description: "Tax rate applied to this item, resolvable against GET /v1/taxes, or null when none is\r\nassigned."
          format: int64
          nullable: true
        ExternalProductId:
          type: string
          description: >-
            Identifier of this item in an external accounting system
            (QuickBooks/Xero), or null.
          nullable: true
        CreatedOn:
          type: string
          description: When the item was created, in UTC.
          format: date-time
          nullable: true
        UpdatedOn:
          type: string
          description: >-
            When the item was last changed, in UTC. Null when it has never been
            changed.
          format: date-time
          nullable: true
      additionalProperties: false
      description: "One row of the item catalog: a product or a bundle. `Type` says which. A bundle is a\r\nproduct made of other products; an invoice line references either kind through one\r\n`ItemId`. Labor items are internal to contract pricing, are not creatable in the app, and\r\nare never returned here."
    PaginationDataContext:
      type: object
      properties:
        Pagination:
          $ref: '#/components/schemas/PaginatedResponse'
      additionalProperties: false
      description: "The `DataContext` of a cursor-paginated success response: carries the paging metadata\r\nfor the returned page."
    Error:
      type: object
      properties:
        Code:
          pattern: ^[0-9]{6}$
          type: string
          description: 6-digit MMTTNN error code. See the Public API error-code registry.
          example: '070101'
        Message:
          type: string
        PropertyName:
          type: string
          nullable: true
        ActionHint:
          type: string
          nullable: true
        DocUrl:
          type: string
          nullable: true
      additionalProperties: false
    ErrorDataContext:
      type: object
      properties:
        TraceId:
          type: string
          description: Request correlation id. Quote this when reporting a problem.
          nullable: true
      additionalProperties: false
      description: "The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest."
    CodeModel:
      type: object
      properties:
        Id:
          type: integer
          description: >-
            Numeric identifier of the coded value (e.g. status, priority, type,
            or source id).
          format: int64
          example: 1
        Name:
          type: string
          description: Display name of the coded value.
      additionalProperties: false
      description: >-
        A coded value, such as a status, priority, type or source, as an id and
        a display name.
    PaginatedResponse:
      type: object
      properties:
        NextCursor:
          type: string
          nullable: true
        PreviousCursor:
          type: string
          nullable: true
        HasMore:
          type: boolean
        HasPrevious:
          type: boolean
        TotalCount:
          type: integer
          format: int32
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: >-
        Your Gorelo API key. See [Generate API key](/generate-api-key). If your
        data is hosted in Australia, click the base URL at the top of this page
        and select `https://api.aue.gorelo.io`.
      name: X-API-Key
      in: header

````

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