---
title: "Search Lists"
method: GET
path: "/business/v2/dictionaries"
tags: ["Lists"]
---

# Search Lists

`GET /business/v2/dictionaries`

## Request

- Base URL: `https://api.soldo.com`
- URL: `https://api.soldo.com/business/v2/dictionaries`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.soldo.com/oauth/authorize` scopes: `tag_read`
- TypeScript: <https://skmtc.dev/soldo/apis/soldo-business-api-v2-0/docs/business/v2/dictionaries/get.ts> (a function with typed inputs; its response is checked against the schema)

Endpoint to search `Lists` using filtering parameters.

## Query parameters

- `visible` boolean: It determines whether the `List` is active.
- `text` string: A text to search in the `List` data (name).
- `p` integer: It indicates the specific page to display (the counter starts from zero).
- `s` integer: It indicates the number of items per page.
- `d` 'ASC' | 'DESC': It indicates how the pages are ordered.
- `props` string[]: It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the `props` parameter in the request.

## Response `200`

The result is an array containing `Lists`.

- TagDictionaries
  - `total` integer: It represents the total number of available items in the list.
  - `pages` integer: It represents the total number of available pages.
  - `page_size` integer: It represents the number of items per page.
  - `current_page` integer: It indicates the current page (the counter starts from zero).
  - `results_size` integer: It indicates the size of the array results.
  - `results` TagDictionary[]
    - `id` string: The ID of the `List`.
    - `dictionary` string: The name of the `List`.
    - `visible` boolean: It determines whether the `List` is active.
    - `creation_time` string: The date and time when the `List` was created.
    - `last_update` string: The date and time when the `List` was last updated.
    - `roles` string[]: The list of `Roles` that can view the items in the transaction details.(sortable: no).
    - `users` string[]: The list of `Users` that can view the items in the transaction details. (sortable: no).
    - `is_unique_select_tag` boolean: It determines whether multiple tags of the `List` can be selected.

---

[API](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0.md) - [All operations](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0/llms.txt) - [OpenAPI document](https://skmtc.dev/soldo/apis/soldo-business-api-v2-0/revisions/23fc5d07b367?raw)