mirror of
https://github.com/LukeHagar/dub-node.git
synced 2025-12-06 12:27:48 +00:00
16 lines
5.5 KiB
Markdown
16 lines
5.5 KiB
Markdown
# GetLinksRequest
|
||
|
||
|
||
## Fields
|
||
|
||
| Field | Type | Required | Description |
|
||
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
||
| `domain` | *string* | :heavy_minus_sign: | The domain to filter the links by. E.g. `ac.me`. If not provided, all links for the workspace will be returned. |
|
||
| `tagId` | *string* | :heavy_minus_sign: | The tag ID to filter the links by. This field is deprecated – use `tagIds` instead. |
|
||
| `tagIds` | *operations.QueryParamTagIds* | :heavy_minus_sign: | The tag IDs to filter the links by. |
|
||
| `search` | *string* | :heavy_minus_sign: | The search term to filter the links by. The search term will be matched against the short link slug and the destination url. |
|
||
| `userId` | *string* | :heavy_minus_sign: | The user ID to filter the links by. |
|
||
| `showArchived` | *boolean* | :heavy_minus_sign: | Whether to include archived links in the response. Defaults to `false` if not provided. |
|
||
| `withTags` | *boolean* | :heavy_minus_sign: | Whether to include tags in the response. Defaults to `false` if not provided. |
|
||
| `sort` | [operations.Sort](../../models/operations/sort.md) | :heavy_minus_sign: | The field to sort the links by. The default is `createdAt`, and sort order is always descending. |
|
||
| `page` | *number* | :heavy_minus_sign: | The page number for pagination (each page contains 100 links). | |