Skip to main content
GET
/
v1
/
boards
/
{boardId}
/
edges
List edges
curl --request GET \
  --url https://api.chatgrid.ai/v1/v1/boards/{boardId}/edges \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "f6a7b8c9-d0e1-2345-fabc-456789012345",
      "board_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "source_node_id": "e5f6a7b8-c9d0-1234-efab-345678901234",
      "target_node_id": "11223344-5566-7788-99aa-bbccddeeff00",
      "edge_type": "default",
      "edge_data": null,
      "created_at": "2026-03-15T10:35:00.000Z",
      "updated_at": "2026-03-15T10:35:00.000Z"
    }
  ],
  "has_more": true,
  "cursor": "<string>"
}

Authorizations

Authorization
string
header
required

Pass your API key (prefixed cgk_) or a Supabase JWT in the Authorization: Bearer <token> header.

Path Parameters

boardId
string<uuid>
required

Board UUID.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Query Parameters

limit
integer
default:50

Maximum number of items to return (1-100, default 50).

Required range: 1 <= x <= 100
cursor
string

Opaque cursor for pagination. Pass the cursor value from a previous response.

Example:

"eyJpZCI6ImExYjJjM2Q0LWU1ZjYtNzg5MC1hYmNkLWVmMTIzNDU2Nzg5MCIsImNyZWF0ZWRfYXQiOiIyMDI2LTAzLTE1VDEwOjMwOjAwLjAwMFoifQ"

order
enum<string>
default:desc

Sort direction by created_at.

Available options:
asc,
desc
source_node_id
string<uuid>

Filter edges by source node UUID.

target_node_id
string<uuid>

Filter edges by target node UUID.

Response

A paginated list of edges.

object
enum<string>
Available options:
list
data
object[]
has_more
boolean
cursor
string | null