API ReferenceLinks

List Links

Lists the available links.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

objectstringRequiredformat: "id"
The ID of the object to list the links for.
cursorstringOptionalformat: "text"
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
directionenumOptional

The direction of the links to list, otherwise if not present, then links in both directions (source and target) are included.

Allowed values:
limitintegerOptional
The maximum number of links to return. If not set, then the default is '50'.
modeenumOptional
The iteration mode to use, otherwise if not set, then "after" is used.
Allowed values:
object_typeslist of enumsOptional
The object types to filter for, otherwise if not present, all object types are included.
typeslist of enumsOptionalDeprecated
The link types to filter for, otherwise if not present, all link types are included.

Response

The response to listing the links.
next_cursorstring or nullformat: "text"
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursorstring or nullformat: "text"
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Errors