links

List Post

POST
Lists the available links.

Request

This endpoint expects an object.
object
stringRequired
The ID of the object to list the links for.
cursor
stringOptional
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
direction
enumOptional
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.
Allowed values: is_sourceis_target
limit
integerOptional
The maximum number of links to return. If not set, then the default is '50'.
link_type
list of enumsOptional
The link type(s) to filter for, otherwise if not present, all link types are included.
mode
enumOptional
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.
Allowed values: afterbefore
types
list of enumsOptional
The link types to filter for, otherwise if not present, all link types are included.

Response

This endpoint returns an object
links
list of objects
The list of links.
next_cursor
stringOptional
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursor
stringOptional
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.
POST
1curl -X POST https://api.devrev.ai/links.list \
2     -H "Authorization: <apiKey>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "object": "object"
6}'
200
Successful
1{
2  "links": [],
3  "next_cursor": "next_cursor",
4  "prev_cursor": "prev_cursor"
5}
Built with