Links

List Links (POST)

Lists the available links.

POST
/links.list

Authorization

AuthorizationBearer <token>

All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request. How do I find my token?

In: header

Request Body

cursor?string

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

Formattext
direction?links-direction

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.

Value in"is_source" | "is_target"
limit?integer

The maximum number of links to return. If not set, then the default is '50'.

Formatint32
link_type?array<link-type>

The link type(s) to filter for, otherwise if not present, all link types are included.

mode?list-mode

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.

Value in"after" | "before"
objectstring

The ID of the object to list the links for.

Formatid
object_types?array<link-endpoint-type>

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

types?array<link-type>Deprecated

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

Response Body

curl -X POST "https://api.devrev.ai/links.list" \  -H "Content-Type: application/json" \  -d '{    "object": "string"  }'
{
  "links": [
    {
      "created_by": {
        "type": "dev_user",
        "display_id": "string",
        "id": "string",
        "display_name": "string",
        "display_picture": {
          "display_id": "string",
          "id": "string",
          "file": {
            "type": "string",
            "name": "string",
            "size": 0
          }
        },
        "email": "string",
        "full_name": "string",
        "state": "active"
      },
      "created_date": "2023-01-01T12:00:00.000Z",
      "display_id": "string",
      "id": "string",
      "modified_by": {
        "type": "dev_user",
        "display_id": "string",
        "id": "string",
        "display_name": "string",
        "display_picture": {
          "display_id": "string",
          "id": "string",
          "file": {
            "type": "string",
            "name": "string",
            "size": 0
          }
        },
        "email": "string",
        "full_name": "string",
        "state": "active"
      },
      "modified_date": "2023-01-01T12:00:00.000Z",
      "custom_link_type": {
        "display_id": "string",
        "id": "string"
      },
      "link_type": "custom_link",
      "source": {
        "type": "account",
        "display_id": "string",
        "id": "string",
        "display_name": "string"
      },
      "target": {
        "type": "account",
        "display_id": "string",
        "id": "string",
        "display_name": "string"
      }
    }
  ],
  "next_cursor": "string",
  "prev_cursor": "string"
}
{
  "detail": "string",
  "message": "string",
  "type": "artifact_already_attached_to_a_parent",
  "existing_parent": "string",
  "is_same": true
}
{
  "detail": "string",
  "message": "string",
  "type": "unauthenticated"
}
{
  "detail": "string",
  "message": "string",
  "type": "forbidden"
}
{
  "detail": "string",
  "message": "string",
  "type": "too_many_requests",
  "retry_after": 0
}
{
  "detail": "string",
  "message": "string",
  "type": "internal_error",
  "reference_id": "string"
}
{
  "detail": "string",
  "message": "string",
  "type": "service_unavailable"
}