List Links (POST)

POST

Lists the available links.

Request

This endpoint expects an object.

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

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.

modeenumOptional

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 enumsOptionalDeprecated

The link types to filter for, otherwise if not present, all link types are included.

Response

The response to listing the links.

linkslist of objects

The list of links.

next_cursorstringOptionalformat: "text"

The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.

prev_cursorstringOptionalformat: "text"

The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Errors

POST

1 curl -X POST https://api.devrev.ai/links.list \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "object": "foo"
6 }'

200linksListPostExample

1 {
2   "links": [
3     {
4       "id": "foo",
5       "link_type": "custom_link",
6       "source": {
7         "display_id": "foo",
8         "id": "foo",
9         "display_name": "foo"
10       },
11       "target": {
12         "display_id": "foo",
13         "id": "foo",
14         "display_name": "foo"
15       },
16       "created_by": {
17         "display_id": "foo",
18         "id": "foo",
19         "display_name": "foo",
20         "display_picture": {
21           "display_id": "foo",
22           "id": "foo",
23           "file": {
24             "type": "foo",
25             "name": "foo",
26             "size": 42
27           }
28         },
29         "email": "foo",
30         "full_name": "foo",
31         "state": "active"
32       },
33       "created_date": "2023-01-01T12:00:00.000Z",
34       "custom_link_type": {
35         "id": "foo",
36         "display_id": "foo"
37       },
38       "display_id": "foo",
39       "modified_by": {
40         "display_id": "foo",
41         "id": "foo",
42         "display_name": "foo",
43         "display_picture": {
44           "display_id": "foo",
45           "id": "foo",
46           "file": {
47             "type": "foo",
48             "name": "foo",
49             "size": 42
50           }
51         },
52         "email": "foo",
53         "full_name": "foo",
54         "state": "active"
55       },
56       "modified_date": "2023-01-01T12:00:00.000Z"
57     }
58   ],
59   "next_cursor": "foo",
60   "prev_cursor": "foo"
61 }

Replace Links

Up Next

Built with

1	curl -X POST https://api.devrev.ai/links.list \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"object": "foo"
6	}'

1	{
2	"links": [
3	{
4	"id": "foo",
5	"link_type": "custom_link",
6	"source": {
7	"display_id": "foo",
8	"id": "foo",
9	"display_name": "foo"
10	},
11	"target": {
12	"display_id": "foo",
13	"id": "foo",
14	"display_name": "foo"
15	},
16	"created_by": {
17	"display_id": "foo",
18	"id": "foo",
19	"display_name": "foo",
20	"display_picture": {
21	"display_id": "foo",
22	"id": "foo",
23	"file": {
24	"type": "foo",
25	"name": "foo",
26	"size": 42
27	}
28	},
29	"email": "foo",
30	"full_name": "foo",
31	"state": "active"
32	},
33	"created_date": "2023-01-01T12:00:00.000Z",
34	"custom_link_type": {
35	"id": "foo",
36	"display_id": "foo"
37	},
38	"display_id": "foo",
39	"modified_by": {
40	"display_id": "foo",
41	"id": "foo",
42	"display_name": "foo",
43	"display_picture": {
44	"display_id": "foo",
45	"id": "foo",
46	"file": {
47	"type": "foo",
48	"name": "foo",
49	"size": 42
50	}
51	},
52	"email": "foo",
53	"full_name": "foo",
54	"state": "active"
55	},
56	"modified_date": "2023-01-01T12:00:00.000Z"
57	}
58	],
59	"next_cursor": "foo",
60	"prev_cursor": "foo"
61	}