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

# Get accessories, optionally narrowed to stock and to one type

> Return the list of accessories for your company. Pass `unassigned: true` to see only what is in stock — nobody owns it, so it can be handed out — and `type` to keep only one kind of accessory, so a request for a spare keyboard does not page through the whole inventory. The two combine: `unassigned: true` with `type: "KEYBOARD"` answers "is there a keyboard available?" in one call, and `pagination.totalElements` is how many there are. `unassigned: false` returns only accessories someone already holds. An accessory can have custom fields (see `getAccessoryCustomFields`).

<span className="badge-read">Key: Read</span><span className="badge-company">Scope: Company</span>


## OpenAPI

````yaml https://api.getprimo.com/openapi.json get /accessories
openapi: 3.1.1
info:
  title: Public API - BETA
  description: Read docs on https://docs.getprimo.com/
  version: '1.0'
  contact: {}
servers:
  - url: https://api.getprimo.com
security:
  - apikey: []
tags: []
paths:
  /accessories:
    get:
      tags:
        - Accessories
      summary: Get accessories, optionally narrowed to stock and to one type
      description: >-
        Return the list of accessories for your company. Pass `unassigned: true`
        to see only what is in stock — nobody owns it, so it can be handed out —
        and `type` to keep only one kind of accessory, so a request for a spare
        keyboard does not page through the whole inventory. The two combine:
        `unassigned: true` with `type: "KEYBOARD"` answers "is there a keyboard
        available?" in one call, and `pagination.totalElements` is how many
        there are. `unassigned: false` returns only accessories someone already
        holds. An accessory can have custom fields (see
        `getAccessoryCustomFields`).
      operationId: getAccessories
      parameters:
        - name: page
          required: false
          in: query
          description: Page number
          schema:
            minimum: 1
            maximum: 9007199254740991
            default: 1
            type: number
        - name: perPage
          required: false
          in: query
          description: Number of items per page (max 100)
          schema:
            minimum: 1
            maximum: 100
            default: 50
            type: number
        - name: unassigned
          required: false
          in: query
          description: >-
            Narrow to stock: true returns only accessories with no owner, false
            only those currently assigned. Omit to return both.
          schema:
            type: boolean
        - name: type
          required: false
          in: query
          description: Return only accessories of this type.
          schema:
            type: string
            enum:
              - MONITOR
              - KEYBOARD
              - MOUSE
              - MOUSEPAD
              - WEBCAM
              - HEADSET
              - SPEAKER
              - CABLE_ADAPTER
              - HUB
              - CHARGER
              - STORAGE_DEVICE
              - LAPTOP_CASE
              - ERGONOMIC
              - SHIPPING_MATERIAL
              - FIDO_KEY
              - ACCESS_CARD
              - NETWORK_DEVICE
              - FIREWALL
              - ROUTER
              - SWITCH
              - OTHER
      responses:
        default:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccessories_Output'
components:
  schemas:
    GetAccessories_Output:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              ownerId:
                description: Employee ID currently assigned to this accessory
                anyOf:
                  - type: string
                  - type: 'null'
              name:
                type: string
              type:
                type: string
                enum:
                  - MONITOR
                  - KEYBOARD
                  - MOUSE
                  - MOUSEPAD
                  - WEBCAM
                  - HEADSET
                  - SPEAKER
                  - CABLE_ADAPTER
                  - HUB
                  - CHARGER
                  - STORAGE_DEVICE
                  - LAPTOP_CASE
                  - ERGONOMIC
                  - SHIPPING_MATERIAL
                  - FIDO_KEY
                  - ACCESS_CARD
                  - NETWORK_DEVICE
                  - FIREWALL
                  - ROUTER
                  - SWITCH
                  - OTHER
              brand:
                anyOf:
                  - type: string
                  - type: 'null'
              model:
                anyOf:
                  - type: string
                  - type: 'null'
              serialNumber:
                anyOf:
                  - type: string
                  - type: 'null'
              tags:
                type: array
                items:
                  type: string
              description:
                description: Free-form accessory description
                anyOf:
                  - type: string
                  - type: 'null'
              condition:
                description: >-
                  Current accessory condition. Null when condition is not
                  specified.
                anyOf:
                  - type: string
                    enum:
                      - NEW
                      - GOOD
                      - DAMAGED
                      - UNUSABLE
                  - type: 'null'
              createdAt:
                type: string
                format: date-time
                pattern: >-
                  ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
              updatedAt:
                type: string
                format: date-time
                pattern: >-
                  ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
            required:
              - id
              - name
              - type
              - tags
              - createdAt
              - updatedAt
            additionalProperties: false
        pagination:
          type: object
          properties:
            totalElements:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            totalPages:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            page:
              type: integer
              minimum: 1
              maximum: 9007199254740991
            perPage:
              type: integer
              minimum: 1
              maximum: 100
          required:
            - totalElements
            - totalPages
            - page
            - perPage
          additionalProperties: false
      required:
        - data
        - pagination
      additionalProperties: false
  securitySchemes:
    apikey:
      scheme: bearer
      bearerFormat: API key
      type: http
      description: >-
        Use your Primo API key in the Authorization header as `Bearer
        <API_KEY>`.

````