Skip to content

Latest commit

 

History

History
18 lines (15 loc) · 8.12 KB

getlinksrequest.md

File metadata and controls

18 lines (15 loc) · 8.12 KB

GetLinksRequest

Fields

Field Type Required Description Example
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) The tag ID to filter the links by. This field is deprecated – use tagIds instead.
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).
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.
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.
sort T.nilable(::OpenApiSDK::Operations::Sort) The field to sort the links by. The default is createdAt, and sort order is always descending.
page T.nilable(::Float) The page number for pagination. 1
page_size T.nilable(::Float) The number of items per page. 50