| Field | Type | Required | Description |
|---|---|---|---|
domain |
T.nilable(::String) | ➖ | The domain to filter the links by. E.g. ac.me. If not provided, all links for the workspace will be returned. |
tag_id |
T.nilable(::String) | ➖ | Deprecated. Use tagIds instead. The tag ID to filter the links by. |
tag_ids |
T.nilable(::Object) | ➖ | The tag IDs to filter the links by. |
tag_names |
T.nilable(::Object) | ➖ | The unique name of the tags assigned to the short link (case insensitive). |
folder_id |
T.nilable(::String) | ➖ | The folder ID to filter the links by. |
search |
T.nilable(::String) | ➖ | 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 |
T.nilable(::String) | ➖ | The user ID to filter the links by. |
tenant_id |
T.nilable(::String) | ➖ | The ID of the tenant that created the link inside your system. If set, will only return links for the specified tenant. |
show_archived |
T.nilable(T::Boolean) | ➖ | Whether to include archived links in the response. Defaults to false if not provided. |
with_tags |
T.nilable(T::Boolean) | ➖ | DEPRECATED. Filter for links that have at least one tag assigned to them. |
group_by |
T.nilable(::Object) | ➖ | The field to group the links by. |