| Field | Type | Required | Description | Example |
|---|---|---|---|---|
domain |
Optional[str] | ➖ | The domain to filter the links by. E.g. ac.me. If not provided, all links for the workspace will be returned. |
|
tag_id |
Optional[str] | ➖ | Deprecated. Use tagIds instead. The tag ID to filter the links by. |
|
tag_ids |
Optional[operations.QueryParamTagIds] | ➖ | The tag IDs to filter the links by. | |
tag_names |
Optional[operations.QueryParamTagNames] | ➖ | The unique name of the tags assigned to the short link (case insensitive). | |
search |
Optional[str] | ➖ | The search term to filter the links by. The search term will be matched against the short link slug and the destination url. | |
user_id |
Optional[str] | ➖ | The user ID to filter the links by. | |
tenant_id |
Optional[str] | ➖ | The ID of the tenant that created the link inside your system. If set, will only return links for the specified tenant. | |
show_archived |
Optional[bool] | ➖ | Whether to include archived links in the response. Defaults to false if not provided. |
|
with_tags |
Optional[bool] | ➖ | DEPRECATED. Filter for links that have at least one tag assigned to them. | |
sort_by |
Optional[operations.SortBy] | ➖ | The field to sort the links by. The default is createdAt. |
|
sort_order |
Optional[operations.SortOrder] | ➖ | The sort order. The default is desc. |
|
sort |
Optional[operations.Sort] | ➖ | DEPRECATED. Use sortBy instead. |
|
page |
Optional[float] | ➖ | The page number for pagination. | 1 |
page_size |
Optional[float] | ➖ | The number of items per page. | 50 |