# Search

Full-text search across your inventory. Name, type filter, folder scope and sort options
all go in the request body.

- type limits results to "item" or "folder". The default is "all".
- folder_ids restricts the search to specific folders.
- Results are paginated, so send the same request body when fetching later pages.

Endpoint: POST /api/v1/items/search
Security: BearerAuth

## Query parameters:

  - `name` (string)
    The name of the thing to search for (can be up 190 characters long)

  - `type` (string)
    Limit results to items, to folders, or search both.
    Enum: "all", "item", "folder"

  - `item_group_id` (string)
    Restrict the search to variants of this item group.

  - `folder_ids` (array)
    Array of comma-separated numeric folder ids in which to search
    Example: "[1234, 5678]"

  - `sort` (array)
    Array of objects with the key being the field to sort by (only name is currently supported) and the value being the direction. Acceptable sort directions are "asc" and "desc". Multiple sort objects are allowed.
    Example: "[{ \"name\": \"asc\" }]"

  - `per_page` (number)
    Page size | Defaults to 100
    Example: "2"

  - `page` (number)
    Page number | Defaults to 1 (the same body should be passed to the next page url for pagination)
    Example: "1"

  - `include` (string)
    Includes nested association
    Example: "custom_attributes,photos,options"

## Response 200 fields (application/json):

  - `data` (array)

  - `data.id` (number, required)

  - `data.name` (string, required)

  - `data.price` (number, required)

  - `data.quantity` (number, required)

  - `data.min_quantity` (number, required)

  - `data.notes` (string, required)

  - `data.type` (string, required)

  - `data.parent_id` (number, required)

  - `data.created_at` (string, required)

  - `data.updated_at` (string, required)

  - `data.sid` (string, required)

  - `data.label_url` (string, required)

  - `data.label_url_type` (string, required)

  - `data.label_url_extra` (string, required)

  - `data.label_url_extra_type` (string, required)

  - `data.tag_names` (array, required)

  - `data.tags` (array, required)

  - `data.photos` (array, required)

  - `data.photos.url` (string, required)

  - `data.custom_attribute_values` (array, required)

  - `data.custom_attribute_values.custom_attribute_id` (number, required)

  - `data.custom_attribute_values.custom_attribute_name` (string, required)

  - `data.custom_attribute_values.value` (string, required)

  - `data.option_value_ids` (array, required)

  - `data.item_group_id` (string, required)

  - `meta` (object)

  - `meta.page` (number)

  - `meta.next_page_url` (string)

  - `meta.total_pages` (number)

  - `meta.total_count` (number)

## Response 400 fields (application/json):

  - `message` (string)

## Response 401 fields (application/json):

  - `message` (string)

## Response 429 fields (application/json):

  - `message` (string)