mirror of
https://github.com/LukeHagar/dub-node.git
synced 2025-12-06 20:37:44 +00:00
6.0 KiB
6.0 KiB
GetLinksRequest
Fields
| Field | Type | Required | Description |
|---|---|---|---|
domain |
string | ➖ | The domain to filter the links by. E.g. ac.me. If not provided, all links for the workspace will be returned. |
tagId |
string | ➖ | The tag ID to filter the links by. This field is deprecated – use tagIds instead. |
tagIds |
operations.QueryParamTagIds | ➖ | The tag IDs to filter the links by. |
tagNames |
operations.QueryParamTagNames | ➖ | The unique name of the tags assigned to the short link (case insensitive). |
search |
string | ➖ | 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 | ➖ | The user ID to filter the links by. |
showArchived |
boolean | ➖ | Whether to include archived links in the response. Defaults to false if not provided. |
withTags |
boolean | ➖ | Whether to include tags in the response. Defaults to false if not provided. |
sort |
operations.Sort | ➖ | The field to sort the links by. The default is createdAt, and sort order is always descending. |
page |
number | ➖ | The page number for pagination (each page contains 100 links). |