---
title: "Get search list."
method: POST
path: "/api/v1/search/list"
tags: ["Search"]
---

# Get search list.

`POST /api/v1/search/list`

## Request

- Base URL: `https://api.intheloop.io`
- URL: `https://api.intheloop.io/api/v1/search/list`
- Auth: API key in header `Authorization`

## Headers

- `Authorization` string
- `X-Impersonate-User` string

## Request body

- SearchQueryBase: Card base resource
  - `queryText` string: Query text
  - `size` integer, required: Size of results
  - `sortOrder` 'Descending' | 'Ascending', required: Sort direction enum
  - `sortType` 'ModifiedDate' | 'CreatedDate' | 'ViewDate', required: Sort Type enum
  - `historyId` string: Histroy id
  - `historyStartDate` string, date-time: Histroy start date if HistoryId is not yet define
  - `historyEndDate` string, date-time: Histroy start end if HistoryId is not yet define
  - `responseFormat` string: Response format (small)
  - `$type` string, required

## Response `200`

OK

- ListOfResourcesOfResourceBase: List of resources
  - `resources` ResourceBase[]: List of resources
    - `id` string: Resource id
    - `name` string: Resource name or title
    - `revision` string: Resource revision
    - `clientId` string: Resource client id
    - `$type` string, required
  - `size` integer, required: Page size
  - `offset` integer, required: Page offset
  - `offsetHistoryId` string: Offset history id
  - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size

## Other responses

- `400`: Bad request. Check fields message and error code from response body for additional information.
- `401`: Unauthorized request. Check fields message and error code from response body for additional information.
- `429`: Too many requests. Check response header Retry-After indicating how long to wait before making a new request.
- `451`: Unavailable because account is not verified.

---

[API](https://skmtc.dev/intheloop/apis/loop-api.md) - [All operations](https://skmtc.dev/intheloop/apis/loop-api/llms.txt) - [OpenAPI document](https://skmtc.dev/intheloop/apis/loop-api/revisions/0892c5ba0787?raw)