List Entity Definitions

GET

/entities/definitions

List all entity definitions for the current user’s organization.

Successful Response

namestring

typeenum

Type of entity.

Allowed values:

entity_schemalist of strings or map from strings to any

module_namestring

class_namestring

idstringformat: "uuid"

descriptionstringOptional

parent_idstringOptionalformat: "uuid"

organization_idstringOptionalformat: "uuid"

1	from airweave import AirweaveSDK
2
3	client = AirweaveSDK(
4	api_key="YOUR_API_KEY",
5	)
6	client.entities.list_entity_definitions()

1	[
2	{
3	"name": "name",
4	"type": "file",
5	"entity_schema": [
6	"entity_schema"
7	],
8	"module_name": "module_name",
9	"class_name": "class_name",
10	"id": "id",
11	"description": "description",
12	"parent_id": "parent_id",
13	"organization_id": "organization_id"
14	}
15	]