Links & Search

Last updated 24 days ago

Links & Search ​

Generate deep links to lists/items and search for resources. Base path: /v1/links.

MethodPathPurpose
GET/v1/links/{type}/{id}Link for a list or item (type = list | list_item)
POST/v1/links/batchMultiple links at once (max. 50)
GET/v1/links/{type}/{id}/validateCheck access to a resource
GET/v1/lists/{listId}/linkLink for a list
GET/v1/list-items/{itemId}/linkLink for an item

The optional query parameter baseUrl overrides the link base.

MethodPathPurpose
GET/v1/links/searchSearch lists/items by name
GET/v1/links/quick-searchTypeahead search
GET/v1/links/exact-searchExact name match
GET/v1/links/suggestionsAutocomplete
GET/v1/lists/{listId}/searchSearch for items within a list
ParameterDescription
qSearch term (required)
typeslist, list_item (comma-separated)
limitNumber of results
includeArchivedInclude archived items
fuzzySearchFuzzy search
listIdRestrict to a single list
statusFilter by status

Example ​

bash