Documentation

GET

api

entities

List Entities

curl --request GET \
  --url https://api.example.com/api/v1/entities \
  --header 'Authorization: Bearer <token>'

{
  "entities": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "space_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "entity_type": "<string>",
      "edge_count": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123
}

Authorizations

Authorization

string

header

required

JWT access token or API key (csk_…)

Query Parameters

entity_type

string | null

Filter by entity type

string | null

Search entities by name

sort_by

enum<string>

default:name

Available options:

name,

edge_count,

created_at

order

enum<string>

default:asc

Available options:

asc,

desc

limit

integer

default:50

Required range: 1 <= x <= 200

offset

integer

default:0

Required range: x >= 0

space_uuid

string<uuid>

required

Response

Successful Response

entities

EntityResponse · object[]

required

Show child attributes

total

integer

required

Get Entity

List Entities

curl --request GET \
  --url https://api.example.com/api/v1/entities \
  --header 'Authorization: Bearer <token>'

{
  "entities": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "space_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "entity_type": "<string>",
      "edge_count": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123
}