List

GET
Lists the available links.

Query parameters

objectstringRequired
The ID of the object to list the links for.
cursorstringOptional
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
direction"is_source" or "is_target"Optional
The direction of the links to list, otherwise if not present, then links in both directions (source and target) are included.
Allowed values: is_sourceis_target
limitintegerOptional
The maximum number of links to return. If not set, then the default is '50'.
link_typeenumOptional
The link type(s) to filter for, otherwise if not present, all link types are included.
mode"after" or "before"Optional
The iteration mode to use, otherwise if not set, then "after" is used.
Allowed values: afterbefore
object_typesenumOptional
The object types to filter for, otherwise if not present, all object types are included.
typesenumOptional
The link types to filter for, otherwise if not present, all link types are included.

Response

This endpoint returns an object
linkslist of objects
The list of links.
next_cursorstringOptional
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursorstringOptional
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.
Built with