Arguments

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
string

The tag IDs to filter the links by.

tagNames
string | string[]

The unique name of the tags assigned to the short link (case insensitive).

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
default: false

Whether to include archived links in the response. Defaults to false if not provided.

withTags
boolean
default: false

Whether to include tags in the response. Defaults to false if not provided.

groupBy
string

The field to group the links by. Available options are domain, tagId, and userId.

Response

The number of links matching the query.