| Field | Type | Required | Description | Example |
|---|---|---|---|---|
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 | ➖ | Deprecated. Use tagIds instead. The tag ID to filter the links by. |
|
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). | |
FolderID |
*string | ➖ | The folder ID to filter the links by. | |
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. | |
TenantID |
*string | ➖ | The ID of the tenant that created the link inside your system. If set, will only return links for the specified tenant. | |
ShowArchived |
*bool | ➖ | Whether to include archived links in the response. Defaults to false if not provided. |
|
WithTags |
*bool | ➖ | DEPRECATED. Filter for links that have at least one tag assigned to them. | |
SortBy |
*operations.SortBy | ➖ | The field to sort the links by. The default is createdAt. |
|
SortOrder |
*operations.SortOrder | ➖ | The sort order. The default is desc. |
|
Sort |
*operations.Sort | ➖ | DEPRECATED. Use sortBy instead. |
|
Page |
*float64 | ➖ | The page number for pagination. | 1 |
PageSize |
*float64 | ➖ | The number of items per page. | 50 |