List Post

POST
Lists the available links.

Request

This endpoint expects an object.
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
Allowed values: is_sourceis_target
The direction of link, which can either be outbound such that the object is the source of the link, otherwise inbound where the object is the target of the link.
limitintegerOptional
The maximum number of links to return. If not set, then the default is '50'.
link_typelist of enumsOptional
The link type(s) to filter for, otherwise if not present, all link types are included.
mode"after" or "before"Optional
Allowed values: afterbefore
The iteration mode to use. If "after", then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If "before", then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.
object_typeslist of enumsOptional
The object types to filter for, otherwise if not present, all object types are included.
typeslist of enumsOptional
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