Entity API

• Base URL: https://entity.sls.epilot.io
• API Docs: https://docs.epilot.io/api/entity

Flexible data layer for epilot Entities.

Quick Start

# List available operations
epilot entity

# Call an operation
epilot entity listSchemas

Common Flags

Flag	Description
-p key=value	Set a named parameter
-d '{...}'	Request body JSON
-H 'Key: Value'	Custom header
-t, --token <token>	Bearer token for authentication
--profile <name>	Use a named profile
-s, --server <url>	Override server base URL
-i, --include	Include response headers in output
--json	Output raw JSON (no formatting)
-v, --verbose	Verbose output (show request details)
--jsonata <expr>	JSONata expression to transform response
--definition <file>	Override OpenAPI spec file/URL
--guided	Prompt for all parameters interactively
--no-interactive	Disable interactive prompts

Operations

Schemas

• listSchemas — Get the latest versions of all schemas
• getSchema — By default gets the latest version of the Schema and to get the specific version of schema pass the id.
• putSchema — Create or update a schema with a new version
• deleteSchema — Delete a schema, or a specific version of a schema
• getJsonSchema — Get formal JSON schema definition draft 2020-12 for the given epilot schema
• getSchemaExample — Get a full example entity for the given schema
• getSchemaVersions — Get all versions of this schema ordered by the latest versions including drafts.
• listAvailableCapabilities — List available capabilities for schema
• listSchemaBlueprints — List canonical versions of all available schemas
• listTaxonomyClassificationsForSchema — List taxonomy classifications for a given schema
• createSchemaAttribute — Create a schema attribute
• getSchemaAttribute — Get a schema attribute from given attribute ID
• putSchemaAttribute — Updates an attribute in the schema
• deleteSchemaAttribute — Deletes an attribute from a schema
• createSchemaCapability — Create a schema capability
• getSchemaCapability — Get a schema capability from given capability ID
• putSchemaCapability — Adds or updates an capability in the schema
• deleteSchemaCapability — Deletes a Capability from a schema
• createSchemaGroup — Create a schema group
• getSchemaGroup — Get a schema group from given group composite ID
• putSchemaGroup — Adds or updates an capability in the schema
• deleteSchemaGroup — Deletes a Capability from a schema
• createSchemaGroupHeadline — Create a headline in a schema group
• getSchemaGroupHeadline — Get a group headline from schema from given headline composite ID
• putSchemaGroupHeadline — Adds or updates a group headline in the schema
• deleteSchemaGroupHeadline — Deletes a group headline from a schema

Entities

• searchEntities — Search for entities. Supports ordering and pagination. [Lucene query syntax](https://www.elastic.co/guide/en/elasticsear
• listEntities — List entities that meet the specified conditions.
• queryEntityGraph — Traverse an entity relationship graph starting from a seed entity.
• createEntity — Creates a new entity using a key.
• validateEntity — Validates an entity against the schema.
• validateEntityV2 — Validates an entity against the schema.
• upsertEntity — Create or update an entity using unique_key
• getEntityV2 — Gets Entity by id.
• restoreEntity — Restores an entity by id
• reindexEntity — Triggers a reindex for the Entity for search.
• getEntity — Gets Entity and relations by id.
• updateEntity — Updates an Entity
• patchEntity — Partially updates an entity with the passed in entity data.
• deleteEntity — Deletes an Entity
• autocomplete — Autocomplete entity attributes
• wipeAllEntities — Creates a request to queue the deletion of all entities in the system. This is a destructive operation and should only b

Activity

• createActivity — Create an activity that can be displayed in activity feeds.
• getActivity — Get activity by id
• attachActivity — Attach existing activity to entity activity feeds
• getEntityActivityFeed — Get activity feed for an entity

Relations

• getRelations — Returns 1st level direct relations for an entity.
• addRelations — Relates one or more entities to parent entity by adding items to a relation attribute
• removeRelations — Disassociate one or more entities to parent entity by removing items to a relation attribute
• getRelationsV2 — Returns 1st level direct relations for an entity with pagination.
• getRelationsV3 — Returns 1st level direct relations for an entity with pagination.
• getRelatedEntitiesCount — Returns the amount of unique related entities for an entity - includes direct and reverse relations.
• updateRelation — Updates an existing relation between two entities.
• deleteRelation — Removes relation between two entities

Import-Export

• exportEntities — Export entity data in a CSV-format. The export will export data as close as possible to what is visible on Entity UI tab
• importEntities — This endpoint enables the import of entities into the platform.

Saved Views

• listSavedViews — Get the Saved Views based on the schema
• createSavedView — Creates a new saved view
• getSavedView — Gets Saved View configuration by id.
• updateSavedView — Updates a saved view
• patchSavedView — Partially updates a saved view with the provided payload. If an updated_at is passed and the server contains a newer ver
• deleteSavedView — Deletes a saved view
• listFavoriteViewsForUser — Get the Favorite Saved Views for user based on the schema

Taxonomy

• listTaxonomies — List taxonomies in an organization
• createTaxonomy — Create a new taxonomy
• getTaxonomy — Get taxonomy by slug
• updateTaxonomy — Update a taxonomy
• deleteTaxonomy — Delete a taxonomy
• updateClassificationsForTaxonomy — Update the classifications for a taxonomy
• createTaxonomyClassification — Create a new classification for a taxonomy
• getTaxonomyClassification — Get a classification for a taxonomy by slug
• updateTaxonomyClassification — Update a classification for a taxonomy
• deleteTaxonomyClassification — Delete a classification for a taxonomy
• taxonomyAutocomplete — Taxonomies autocomplete
• taxonomiesClassificationsSearch — List taxonomy classifications in an organization based on taxonomy slug
• getTaxonomyBulkActionJobs — Gets bulk actions jobs by job status:
• getTaxonomyBulkActionJobById — Gets a bulk action job by job id
• cancelBulkAction — Cancels a running bulk action job. The job status will be updated to CANCELLED
• bulkMoveClassifications — Moves classifications from one taxonomy to another, through a bulk async operation which
• bulkMergeClassifications — Merges classifications from one taxonomy into one individual classification, through a bulk async operation which
• bulkDeleteClassifications — Permanently deletes taxonomy classifications. The classifications are deleted through a bulk

listSchemas

Get the latest versions of all schemas

GET /v1/entity/schemas

Parameters

Name	In	Type	Required	Description
unpublished	query	boolean	No	Return unpublished draft schemas
exclude	query	string[]	No	List of schema slugs to exclude from the results. Accepts a comma-separated list of slugs to exclude from the results.

Sample Call

epilot entity listSchemas

With JSONata filter:

epilot entity listSchemas --jsonata 'results[0]'

Sample Response

{
  "results": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "created_at": "string",
      "updated_at": "string",
      "comment": "string",
      "source": {},
      "slug": "contact",
      "version": 1,
      "blueprint": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "feature_flag": "FF_MY_FEATURE_FLAG",
      "enable_setting": ["360_features"],
      "name": "Contact",
      "plural": "Contacts",
      "description": "Example description",
      "docs_url": "https://docs.epilot.io/docs/pricing/entities",
      "category": "customer_relations",
      "published": false,
      "draft": false,
      "icon": "person",
      "title_template": "{{first_name}} {{last_name}}",
      "ui_config": {},
      "capabilities": [],
      "group_settings": [],
      "layout_settings": {},
      "dialog_config": {},
      "attributes": [],
      "_purpose": ["string"],
      "explicit_search_mappings": {},
      "group_headlines": []
    }
  ]
}

---

getSchema

By default gets the latest version of the Schema and to get the specific version of schema pass the id.

GET /v1/entity/schemas/{slug}

Parameters

Name	In	Type	Required	Description
slug	path	string	Yes	Entity Type
id	query	string (uuid)	No

Sample Call

epilot entity getSchema \
  -p slug=contact

Using positional args for path parameters:

epilot entity getSchema contact

With JSONata filter:

epilot entity getSchema -p slug=contact --jsonata '$'

Sample Response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_at": "string",
  "updated_at": "string",
  "comment": "string",
  "source": {
    "id": "string",
    "type": "string"
  },
  "slug": "contact",
  "version": 1,
  "blueprint": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "feature_flag": "FF_MY_FEATURE_FLAG",
  "enable_setting": ["360_features"],
  "name": "Contact",
  "plural": "Contacts",
  "description": "Example description",
  "docs_url": "https://docs.epilot.io/docs/pricing/entities",
  "category": "customer_relations",
  "published": false,
  "draft": false,
  "icon": "person",
  "title_template": "{{first_name}} {{last_name}}",
  "ui_config": {
    "table_view": {
      "view_type": "default",
      "row_actions": ["string"],
      "bulk_actions": ["string"],
      "navbar_actions": [],
      "enable_thumbnails": false
    },
    "create_view": {
      "view_type": "default",
      "search_params": {}
    },
    "edit_view": {
      "view_type": "default",
      "search_params": {},
      "summary_attributes": ["email"]
    },
    "single_view": {
      "view_type": "default",
      "search_params": {},
      "summary_attributes": ["email"]
    },
    "list_item": {
      "summary_attributes": [],
      "quick_actions": [],
      "ui_config": {}
    },
    "sharing": {
      "show_sharing_button": true
    }
  },
  "capabilities": [
    {
      "id": "d5839b94-ba20-4225-a78e-76951d352bd6",
      "name": "customer_messaging",
      "title": "Messaging",
      "attributes": [],
      "_purpose": ["taxonomy-slug:classification-slug"],
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
      "app_id": "123e4567-e89b-12d3-a456-426614174000",
      "ui_config": {},
      "ui_hooks": [],
      "feature_flag": "FF_MY_FEATURE_FLAG",
      "settings_flag": []
    }
  ],
  "group_settings": [
    {
      "id": "e18a532b-ae79-4d86-a6a5-e5dbfb579d14",
      "label": "Contact Details",
      "expanded": true,
      "order": 1
    },
    {
      "id": "e9a1ae28-27ba-4fa0-a79c-e279cc5c4a6e",
      "label": "Address Details",
      "expanded": false,
      "order": 2,
      "info_tooltip_title": {}
    }
  ],
  "layout_settings": {
    "grid_gap": "string",
    "grid_template_columns": "string"
  },
  "dialog_config": {},
  "attributes": [
    {
      "name": "email",
      "type": "email",
      "label": "Email",
      "required": true
    },
    {
      "name": "first_name",
      "type": "string",
      "label": "First Name"
    }
  ],
  "_purpose": ["string"],
  "explicit_search_mappings": {
    "image": {
      "type": "keyword",
      "index": false
    }
  },
  "group_headlines": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "label": "string",
      "layout": "string",
      "group": "string",
      "order": 0,
      "type": "headline",
      "enable_divider": false,
      "divider": "top_divider",
      "_purpose": ["taxonomy-slug:classification-slug"],
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
    }
  ]
}

---

putSchema

Create or update a schema with a new version

PUT /v1/entity/schemas/{slug}

Parameters

Name	In	Type	Required	Description
slug	path	string	Yes	Entity Type
draft	query	boolean	No

Request Body

Sample Call

epilot entity putSchema \
  -p slug=contact

With request body:

epilot entity putSchema \
  -p slug=contact \
  -d '{
  "slug": "contact",
  "version": 1,
  "blueprint": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "feature_flag": "FF_MY_FEATURE_FLAG",
  "enable_setting": ["360_features"],
  "name": "Contact",
  "plural": "Contacts",
  "description": "Example description",
  "docs_url": "https://docs.epilot.io/docs/pricing/entities",
  "category": "customer_relations",
  "published": false,
  "draft": false,
  "icon": "person",
  "title_template": "{{first_name}} {{last_name}}",
  "ui_config": {
    "table_view": {
      "view_type": "default",
      "row_actions": ["string"],
      "bulk_actions": ["string"],
      "navbar_actions": [],
      "enable_thumbnails": false
    },
    "create_view": {
      "view_type": "default",
      "search_params": {}
    },
    "edit_view": {
      "view_type": "default",
      "search_params": {},
      "summary_attributes": ["email"]
    },
    "single_view": {
      "view_type": "default",
      "search_params": {},
      "summary_attributes": ["email"]
    },
    "list_item": {
      "summary_attributes": [],
      "quick_actions": [],
      "ui_config": {}
    },
    "sharing": {
      "show_sharing_button": true
    }
  },
  "capabilities": [
    {
      "id": "d5839b94-ba20-4225-a78e-76951d352bd6",
      "name": "customer_messaging",
      "title": "Messaging",
      "attributes": [],
      "_purpose": ["taxonomy-slug:classification-slug"],
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
      "app_id": "123e4567-e89b-12d3-a456-426614174000",
      "ui_config": {},
      "ui_hooks": [],
      "feature_flag": "FF_MY_FEATURE_FLAG",
      "settings_flag": []
    }
  ],
  "group_settings": [
    {
      "id": "e18a532b-ae79-4d86-a6a5-e5dbfb579d14",
      "label": "Contact Details",
      "expanded": true,
      "order": 1
    },
    {
      "id": "e9a1ae28-27ba-4fa0-a79c-e279cc5c4a6e",
      "label": "Address Details",
      "expanded": false,
      "order": 2,
      "info_tooltip_title": {}
    }
  ],
  "layout_settings": {
    "grid_gap": "string",
    "grid_template_columns": "string"
  },
  "dialog_config": {},
  "attributes": [
    {
      "name": "email",
      "type": "email",
      "label": "Email",
      "required": true
    },
    {
      "name": "first_name",
      "type": "string",
      "label": "First Name"
    }
  ],
  "_purpose": ["string"],
  "explicit_search_mappings": {
    "image": {
      "type": "keyword",
      "index": false
    }
  },
  "group_headlines": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "label": "string",
      "layout": "string",
      "group": "string",
      "order": 0,
      "type": "headline",
      "enable_divider": false,
      "divider": "top_divider",
      "_purpose": ["taxonomy-slug:classification-slug"],
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
    }
  ]
}'

Using positional args for path parameters:

epilot entity putSchema contact

Using stdin pipe:

cat body.json | epilot entity putSchema -p slug=contact

With JSONata filter:

epilot entity putSchema -p slug=contact --jsonata '$'

Sample Response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_at": "string",
  "updated_at": "string",
  "comment": "string",
  "source": {
    "id": "string",
    "type": "string"
  },
  "slug": "contact",
  "version": 1,
  "blueprint": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "feature_flag": "FF_MY_FEATURE_FLAG",
  "enable_setting": ["360_features"],
  "name": "Contact",
  "plural": "Contacts",
  "description": "Example description",
  "docs_url": "https://docs.epilot.io/docs/pricing/entities",
  "category": "customer_relations",
  "published": false,
  "draft": false,
  "icon": "person",
  "title_template": "{{first_name}} {{last_name}}",
  "ui_config": {
    "table_view": {
      "view_type": "default",
      "row_actions": ["string"],
      "bulk_actions": ["string"],
      "navbar_actions": [],
      "enable_thumbnails": false
    },
    "create_view": {
      "view_type": "default",
      "search_params": {}
    },
    "edit_view": {
      "view_type": "default",
      "search_params": {},
      "summary_attributes": ["email"]
    },
    "single_view": {
      "view_type": "default",
      "search_params": {},
      "summary_attributes": ["email"]
    },
    "list_item": {
      "summary_attributes": [],
      "quick_actions": [],
      "ui_config": {}
    },
    "sharing": {
      "show_sharing_button": true
    }
  },
  "capabilities": [
    {
      "id": "d5839b94-ba20-4225-a78e-76951d352bd6",
      "name": "customer_messaging",
      "title": "Messaging",
      "attributes": [],
      "_purpose": ["taxonomy-slug:classification-slug"],
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
      "app_id": "123e4567-e89b-12d3-a456-426614174000",
      "ui_config": {},
      "ui_hooks": [],
      "feature_flag": "FF_MY_FEATURE_FLAG",
      "settings_flag": []
    }
  ],
  "group_settings": [
    {
      "id": "e18a532b-ae79-4d86-a6a5-e5dbfb579d14",
      "label": "Contact Details",
      "expanded": true,
      "order": 1
    },
    {
      "id": "e9a1ae28-27ba-4fa0-a79c-e279cc5c4a6e",
      "label": "Address Details",
      "expanded": false,
      "order": 2,
      "info_tooltip_title": {}
    }
  ],
  "layout_settings": {
    "grid_gap": "string",
    "grid_template_columns": "string"
  },
  "dialog_config": {},
  "attributes": [
    {
      "name": "email",
      "type": "email",
      "label": "Email",
      "required": true
    },
    {
      "name": "first_name",
      "type": "string",
      "label": "First Name"
    }
  ],
  "_purpose": ["string"],
  "explicit_search_mappings": {
    "image": {
      "type": "keyword",
      "index": false
    }
  },
  "group_headlines": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "label": "string",
      "layout": "string",
      "group": "string",
      "order": 0,
      "type": "headline",
      "enable_divider": false,
      "divider": "top_divider",
      "_purpose": ["taxonomy-slug:classification-slug"],
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
    }
  ]
}

---

deleteSchema

Delete a schema, or a specific version of a schema

DELETE /v1/entity/schemas/{slug}

Parameters

Name	In	Type	Required	Description
slug	path	string	Yes	Entity Type

Sample Call

epilot entity deleteSchema \
  -p slug=contact

Using positional args for path parameters:

epilot entity deleteSchema contact

With JSONata filter:

epilot entity deleteSchema -p slug=contact --jsonata '$'

---

getJsonSchema

Get formal JSON schema definition draft 2020-12 for the given epilot schema

GET /v1/entity/schemas/{slug}/json/schema

Parameters

Name	In	Type	Required	Description
slug	path	string	Yes	Entity Type
dereference	query	boolean	No

Sample Call

epilot entity getJsonSchema \
  -p slug=contact

Using positional args for path parameters:

epilot entity getJsonSchema contact

With JSONata filter:

epilot entity getJsonSchema -p slug=contact --jsonata '$'

Sample Response

{
  "$schema": "http://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "_id": {
      "type": "string",
      "format": "uuid",
      "example": "123e4567-e89b-12d3-a456-426614174000"
    },
    "_org": {
      "type": "string",
      "description": "Organization Id the entity belongs to",
      "readOnly": true
    },
    "_owners": {
      "type": "array",
      "readOnly": true,
      "items": {}
    },
    "_schema": {
      "readOnly": true,
      "type": "string"
    },
    "_title": {
      "readOnly": true,
      "type": "string"
    },
    "_tags": {
      "type": "array",
      "nullable": true,
      "items": {}
    },
    "_manifest": {
      "type": "array",
      "description": "Manifest ID used to create/update the entity",
      "items": {}
    },
    "_created_at": {
      "readOnly": true,
      "type": "string",
      "format": "date-time"
    },
    "_updated_at": {
      "readOnly": true,
      "type": "string",
      "format": "date-time"
    },
    "_acl": {
      "readOnly": true,
      "type": "object",
      "description": "Access control list (ACL) for an entity. Defines sharing access to external orgs or users.",
      "additionalProperties": true,
      "properties": {}
    },
    "title": {
      "type": "string",
      "nullable": true,
      "enum": ["Dr.", "Prof.", "Prof. Dr.", null]
    },
    "salutation": {
      "type": "string",
      "nullable": true,
      "enum": ["Mr.", "Ms. / Mrs.", "Company", "Contact Person", "Company/Contact Person", "Spouse", "Family", "Ownership", "Assembly", "Other", null]
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "customer_number": {
      "type": "string",
      "nullable": true
    },
    "birthdate": {
      "type": "string",
      "format": "date",
      "nullable": true
    },
    "account": {
      "type": "object",
      "nullable": true,
      "properties": {},
      "additionalProperties": true
    },
    "address": {
      "type": "array",
      "nullable": true,
      "description": "Addresses as a list of object, the element with index 0 is treated as the primary one.\n",
      "items": {}
    },
    "email": {
      "type": "array",
      "nullable": true,
      "description": "Email addresses as a list of object, the element with index 0 is treated as the primary one.\n",
      "items": {}
    },
    "phone": {
      "type": "array",
      "description": "Phone numbers as a list of object, the element with index 0 is treated as the primary one.\n",
      "items": {}
    }
  },
  "required": ["first_name", "last_name", "_id", "_org", "_owners", "_schema", "_title", "_tags", "_created_at", "_updated_at", "_acl"]
}

---

getSchemaExample

Get a full example entity for the given schema

GET /v1/entity/schemas/{slug}/json/example

Parameters

Name	In	Type	Required	Description
slug	path	string	Yes	Entity Type

Sample Call

epilot entity getSchemaExample \
  -p slug=contact

Using positional args for path parameters:

epilot entity getSchemaExample contact

With JSONata filter:

epilot entity getSchemaExample -p slug=contact --jsonata '$'

Sample Response

{}

---

getSchemaVersions

Get all versions of this schema ordered by the latest versions including drafts.

GET /v1/entity/schemas/{slug}/versions

Parameters

Name	In	Type	Required	Description
slug	path	string	Yes	Entity Type
versions_from	query	number	No
versions_size	query	number	No
drafts_from	query	number	No
drafts_size	query	number	No
fields	query	string[]	No

Sample Call

epilot entity getSchemaVersions \
  -p slug=contact

Using positional args for path parameters:

epilot entity getSchemaVersions contact

With JSONata filter:

epilot entity getSchemaVersions -p slug=contact --jsonata 'versions'

Sample Response

{
  "versions": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "created_at": "string",
      "updated_at": "string",
      "comment": "string",
      "source": {},
      "slug": "contact",
      "version": 1,
      "blueprint": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "feature_flag": "FF_MY_FEATURE_FLAG",
      "enable_setting": ["360_features"],
      "name": "Contact",
      "plural": "Contacts",
      "description": "Example description",
      "docs_url": "https://docs.epilot.io/docs/pricing/entities",
      "category": "customer_relations",
      "published": false,
      "draft": false,
      "icon": "person",
      "title_template": "{{first_name}} {{last_name}}",
      "ui_config": {},
      "capabilities": [],
      "group_settings": [],
      "layout_settings": {},
      "dialog_config": {},
      "attributes": [],
      "_purpose": ["string"],
      "explicit_search_mappings": {},
      "group_headlines": []
    }
  ],
  "drafts": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "created_at": "string",
      "updated_at": "string",
      "comment": "string",
      "source": {},
      "slug": "contact",
      "version": 1,
      "blueprint": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "feature_flag": "FF_MY_FEATURE_FLAG",
      "enable_setting": ["360_features"],
      "name": "Contact",
      "plural": "Contacts",
      "description": "Example description",
      "docs_url": "https://docs.epilot.io/docs/pricing/entities",
      "category": "customer_relations",
      "published": false,
      "draft": false,
      "icon": "person",
      "title_template": "{{first_name}} {{last_name}}",
      "ui_config": {},
      "capabilities": [],
      "group_settings": [],
      "layout_settings": {},
      "dialog_config": {},
      "attributes": [],
      "_purpose": ["string"],
      "explicit_search_mappings": {},
      "group_headlines": []
    }
  ],
  "versions_more": true,
  "drafts_more": true
}

---

listAvailableCapabilities

List available capabilities for schema

GET /v1/entity/schemas/{slug}/capabilities/available

Parameters

Name	In	Type	Required	Description
slug	path	string	Yes	Entity Type

Sample Call

epilot entity listAvailableCapabilities \
  -p slug=contact

Using positional args for path parameters:

epilot entity listAvailableCapabilities contact

With JSONata filter:

epilot entity listAvailableCapabilities -p slug=contact --jsonata 'results[0]'

Sample Response

{
  "results": [
    {
      "id": "d5839b94-ba20-4225-a78e-76951d352bd6",
      "name": "customer_messaging",
      "title": "Messaging",
      "attributes": [],
      "_purpose": ["taxonomy-slug:classification-slug"],
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
      "app_id": "123e4567-e89b-12d3-a456-426614174000",
      "ui_config": {},
      "ui_hooks": [],
      "feature_flag": "FF_MY_FEATURE_FLAG",
      "settings_flag": []
    }
  ]
}

---

listSchemaBlueprints

List canonical versions of all available schemas

GET /v1/entity/schemas/blueprints

Sample Call

epilot entity listSchemaBlueprints

With JSONata filter:

epilot entity listSchemaBlueprints --jsonata 'results[0]'

Sample Response

{
  "results": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "created_at": "string",
      "updated_at": "string",
      "comment": "string",
      "source": {},
      "slug": "contact",
      "version": 1,
      "blueprint": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "feature_flag": "FF_MY_FEATURE_FLAG",
      "enable_setting": ["360_features"],
      "name": "Contact",
      "plural": "Contacts",
      "description": "Example description",
      "docs_url": "https://docs.epilot.io/docs/pricing/entities",
      "category": "customer_relations",
      "published": false,
      "draft": false,
      "icon": "person",
      "title_template": "{{first_name}} {{last_name}}",
      "ui_config": {},
      "capabilities": [],
      "group_settings": [],
      "layout_settings": {},
      "dialog_config": {},
      "attributes": [],
      "_purpose": ["string"],
      "explicit_search_mappings": {},
      "group_headlines": []
    }
  ]
}

---

searchEntities

Search for entities. Supports ordering and pagination. [Lucene query syntax](https://www.elastic.co/guide/en/elasticsear

POST /v1/entity:search

Request Body

Sample Call

epilot entity searchEntities

With request body:

epilot entity searchEntities \
  -d '{
  "q": "_schema:contact AND status:active",
  "include_scores": false,
  "sort": "string",
  "from": 0,
  "size": 10,
  "hydrate": false,
  "fields": ["_id", "_title", "first_name", "account", "!account.*._files", "**._product"],
  "aggs": {
    "contact-count-per-tag": {
      "terms": {
        "field": "_tags.keyword"
      }
    }
  },
  "include_deleted": "false",
  "highlight": {},
  "stable_for": 0,
  "stable_query_id": "string",
  "search_after": ["string"]
}'

Using stdin pipe:

cat body.json | epilot entity searchEntities

With JSONata filter:

epilot entity searchEntities --jsonata 'results[0]'

Sample Response

{
  "hits": 1,
  "results": [
    {
      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "_org": "123",
      "_owners": [
        {
          "org_id": "123",
          "user_id": "123"
        }
      ],
      "_schema": "contact",
      "_tags": ["example", "mock"],
      "_created_at": "2021-02-09T12:41:43.662Z",
      "_updated_at": "2021-02-09T12:41:43.662Z",
      "_acl": {
        "view": ["org:456", "org:789"],
        "edit": ["org:456"],
        "delete": ["org:456"]
      },
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
    }
  ],
  "aggregations": {
    "contact-count-per-tag": {
      "doc_count_error_upper_bound": 0,
      "sum_other_doc_count": 23,
      "buckets": [
        {
          "key": "automation",
          "doc_count": 108
        },
        {
          "key": "primary",
          "doc_count": 66
        }
      ]
    }
  },
  "stable_query_id": "string",
  "sort_end": [1747905443332, "0.000023312468"]
}

---

listEntities

List entities that meet the specified conditions.

POST /v1/entity:list

Request Body

Sample Call

epilot entity listEntities

With request body:

epilot entity listEntities \
  -d '{
  "query": {
    "query_string": {
      "query": "status:active",
      "fields": ["_title", "_tags", "status"],
      "default_operator": "OR",
      "lenient": true
    }
  },
  "filter": [
    {
      "term": {
        "_schema": "contact"
      }
    },
    {
      "terms": {
        "status": ["active"]
      }
    }
  ],
  "allow_targeting_all_schemas": false,
  "sort": "string",
  "from": 0,
  "size": 10,
  "hydrate": false,
  "fields": ["_id", "_title", "first_name", "account", "!account.*._files", "**._product"],
  "aggs": {
    "contact-count-per-tag": {
      "terms": {
        "field": "_tags.keyword"
      }
    }
  },
  "include_deleted": "false",
  "include_scores": false,
  "highlight": {},
  "stable_for": 0,
  "stable_query_id": "string",
  "search_after": ["string"]
}'

Using stdin pipe:

cat body.json | epilot entity listEntities

With JSONata filter:

epilot entity listEntities --jsonata 'results[0]'

Sample Response

{
  "hits": 1,
  "results": [
    {
      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "_org": "123",
      "_owners": [
        {
          "org_id": "123",
          "user_id": "123"
        }
      ],
      "_schema": "contact",
      "_tags": ["example", "mock"],
      "_created_at": "2021-02-09T12:41:43.662Z",
      "_updated_at": "2021-02-09T12:41:43.662Z",
      "_acl": {
        "view": ["org:456", "org:789"],
        "edit": ["org:456"],
        "delete": ["org:456"]
      },
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
    }
  ],
  "aggregations": {
    "contact-count-per-tag": {
      "doc_count_error_upper_bound": 0,
      "sum_other_doc_count": 23,
      "buckets": [
        {
          "key": "automation",
          "doc_count": 108
        },
        {
          "key": "primary",
          "doc_count": 66
        }
      ]
    }
  },
  "stable_query_id": "string",
  "sort_end": [1747905443332, "0.000023312468"]
}

---

queryEntityGraph

Traverse an entity relationship graph starting from a seed entity.

POST /v1/entity:graph

Request Body (required)

Sample Call

epilot entity queryEntityGraph

With request body:

epilot entity queryEntityGraph \
  -d '{
  "seed": {
    "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "node_id": "contact"
  },
  "graph": {
    "nodes": [
      {
        "id": "portal_user",
        "schema": "portal_user",
        "cardinality": "one"
      },
      {
        "id": "contact",
        "schema": "contact",
        "cardinality": "one"
      }
    ],
    "edges": [
      {
        "from": "portal_user",
        "to": "contact"
      },
      {
        "from": "contact",
        "to": "billing_accounts"
      }
    ]
  },
  "hydrate": false
}'

Using stdin pipe:

cat body.json | epilot entity queryEntityGraph

With JSONata filter:

epilot entity queryEntityGraph --jsonata 'nodes'

Sample Response

{
  "nodes": {
    "portal_user": ["550e8400-e29b-41d4-a716-446655440001"],
    "contact": ["550e8400-e29b-41d4-a716-446655440002"],
    "billing_accounts": ["550e8400-e29b-41d4-a716-446655440003", "550e8400-e29b-41d4-a716-446655440004"]
  },
  "entityNodes": {
    "portal_user": {
      "_id": "550e8400-e29b-41d4-a716-446655440001",
      "_schema": "portal_user"
    },
    "contact": {
      "_id": "550e8400-e29b-41d4-a716-446655440002",
      "_schema": "contact"
    },
    "billing_accounts": [
      {
        "_id": "550e8400-e29b-41d4-a716-446655440003",
        "_schema": "billing_account"
      },
      {
        "_id": "550e8400-e29b-41d4-a716-446655440004",
        "_schema": "billing_account"
      }
    ]
  },
  "edges": [
    {
      "from": "portal_user",
      "to": "contact"
    },
    {
      "from": "contact",
      "to": "billing_accounts"
    }
  ]
}

---

createEntity

Creates a new entity using a key.

POST /v1/entity/{slug}

Parameters

Name	In	Type	Required	Description
slug	path	string	Yes	Entity Type
activity_id	query	string (ulid) | "" | null	No	Activity to include in event feed
fill_activity	query	boolean	No	Update the diff and entity for the custom activity included in the query.

Pending state on activity is automatically ended when activity is filled. | | async | query | boolean | No | Don't wait for updated entity to become available in Search API. Useful for large migrations | | validate | query | boolean | No | When true, enables entity validation against the entity schema. |

Request Body

Sample Call

epilot entity createEntity \
  -p slug=contact

With request body:

epilot entity createEntity \
  -p slug=contact \
  -d '{
  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "_org": "123",
  "_owners": [
    {
      "org_id": "123",
      "user_id": "123"
    }
  ],
  "_schema": "contact",
  "_tags": ["example", "mock"],
  "_created_at": "2021-02-09T12:41:43.662Z",
  "_updated_at": "2021-02-09T12:41:43.662Z",
  "_acl": {
    "view": ["org:456", "org:789"],
    "edit": ["org:456"],
    "delete": ["org:456"]
  },
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
}'

Using positional args for path parameters:

epilot entity createEntity contact

Using stdin pipe:

cat body.json | epilot entity createEntity -p slug=contact

With JSONata filter:

epilot entity createEntity -p slug=contact --jsonata '$'

Sample Response

{
  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "_org": "123",
  "_owners": [
    {
      "org_id": "123",
      "user_id": "123"
    }
  ],
  "_schema": "contact",
  "_tags": ["example", "mock"],
  "_created_at": "2021-02-09T12:41:43.662Z",
  "_updated_at": "2021-02-09T12:41:43.662Z",
  "_acl": {
    "view": ["org:456", "org:789"],
    "edit": ["org:456"],
    "delete": ["org:456"]
  },
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
}

---

validateEntity

Validates an entity against the schema.

POST /v1/entity/{slug}:validate

Parameters

Name	In	Type	Required	Description
slug	path	unknown	Yes	Entity Type

Request Body

Sample Call

epilot entity validateEntity \
  -p slug=price

With request body:

epilot entity validateEntity \
  -p slug=price \
  -d '{
  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "_org": "123",
  "_owners": [
    {
      "org_id": "123",
      "user_id": "123"
    }
  ],
  "_schema": "contact",
  "_tags": ["example", "mock"],
  "_created_at": "2021-02-09T12:41:43.662Z",
  "_updated_at": "2021-02-09T12:41:43.662Z",
  "_acl": {
    "view": ["org:456", "org:789"],
    "edit": ["org:456"],
    "delete": ["org:456"]
  },
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
}'

Using positional args for path parameters:

epilot entity validateEntity price

Using stdin pipe:

cat body.json | epilot entity validateEntity -p slug=price

With JSONata filter:

epilot entity validateEntity -p slug=price --jsonata 'status'

Sample Response

{
  "status": "success",
  "errors": [
    {
      "code": "custom",
      "params": {
        "type": "missing_field"
      },
      "path": ["first_name"],
      "message": "Invalid input"
    }
  ]
}

---

validateEntityV2

Validates an entity against the schema.

POST /v2/entity/{slug}:validate

Parameters

Name	In	Type	Required	Description
slug	path	unknown	Yes	Entity Type

Request Body

Sample Call

epilot entity validateEntityV2 \
  -p slug=price

With request body:

epilot entity validateEntityV2 \
  -p slug=price \
  -d '{
  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "_org": "123",
  "_owners": [
    {
      "org_id": "123",
      "user_id": "123"
    }
  ],
  "_schema": "contact",
  "_tags": ["example", "mock"],
  "_created_at": "2021-02-09T12:41:43.662Z",
  "_updated_at": "2021-02-09T12:41:43.662Z",
  "_acl": {
    "view": ["org:456", "org:789"],
    "edit": ["org:456"],
    "delete": ["org:456"]
  },
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
}'

Using positional args for path parameters:

epilot entity validateEntityV2 price

Using stdin pipe:

cat body.json | epilot entity validateEntityV2 -p slug=price

With JSONata filter:

epilot entity validateEntityV2 -p slug=price --jsonata 'status'

Sample Response

{
  "status": "success",
  "errors": [
    {
      "keyword": "string",
      "instance_path": "string",
      "schema_path": "string",
      "params": {},
      "property_name": "string",
      "message": "string",
      "schema": {},
      "parent_schema": {},
      "data": {}
    }
  ]
}

---

upsertEntity

Create or update an entity using unique_key

PATCH /v1/entity/{slug}:upsert

Parameters

Name	In	Type	Required	Description
slug	path	string	Yes	Entity Type
activity_id	query	string (ulid) | "" | null	No	Activity to include in event feed
fill_activity	query	boolean	No	Update the diff and entity for the custom activity included in the query.

Pending state on activity is automatically ended when activity is filled. | | dry_run | query | boolean | No | Dry Run mode = return results but does not perform the operation. | | async | query | boolean | No | Don't wait for updated entity to become available in Search API. Useful for large migrations | | validate | query | boolean | No | When true, enables entity validation against the entity schema. | | strict | query | boolean | No | Strict mode = return 409 if more than one entity is matched |

Request Body

Sample Call

epilot entity upsertEntity \
  -p slug=contact

With request body:

epilot entity upsertEntity \
  -p slug=contact \
  -d '{
  "unique_key": ["_id"],
  "entity": {
    "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "_org": "123",
    "_owners": [
      {
        "org_id": "123",
        "user_id": "123"
      }
    ],
    "_schema": "contact",
    "_tags": ["example", "mock"],
    "_created_at": "2021-02-09T12:41:43.662Z",
    "_updated_at": "2021-02-09T12:41:43.662Z",
    "_acl": {
      "view": ["org:456", "org:789"],
      "edit": ["org:456"],
      "delete": ["org:456"]
    },
    "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
  }
}'

Using positional args for path parameters:

epilot entity upsertEntity contact

Using stdin pipe:

cat body.json | epilot entity upsertEntity -p slug=contact

With JSONata filter:

epilot entity upsertEntity -p slug=contact --jsonata '$'

Sample Response

{
  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "_org": "123",
  "_owners": [
    {
      "org_id": "123",
      "user_id": "123"
    }
  ],
  "_schema": "contact",
  "_tags": ["example", "mock"],
  "_created_at": "2021-02-09T12:41:43.662Z",
  "_updated_at": "2021-02-09T12:41:43.662Z",
  "_acl": {
    "view": ["org:456", "org:789"],
    "edit": ["org:456"],
    "delete": ["org:456"]
  },
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
}

---

getEntityV2

Gets Entity by id.

GET /v2/entity/{slug}/{id}

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes	Entity id
slug	path	string	Yes	Entity Type
hydrate	query	boolean	No	When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.
fields	query	string[]	No	List of entity fields to include in results

Sample Call

epilot entity getEntityV2 \
  -p id=123e4567-e89b-12d3-a456-426614174000 \
  -p slug=contact

Using positional args for path parameters:

epilot entity getEntityV2 123e4567-e89b-12d3-a456-426614174000 contact

With JSONata filter:

epilot entity getEntityV2 -p id=123e4567-e89b-12d3-a456-426614174000 -p slug=contact --jsonata '$'

Sample Response

{
  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "_org": "123",
  "_owners": [
    {
      "org_id": "123",
      "user_id": "123"
    }
  ],
  "_schema": "contact",
  "_tags": ["example", "mock"],
  "_created_at": "2021-02-09T12:41:43.662Z",
  "_updated_at": "2021-02-09T12:41:43.662Z",
  "_acl": {
    "view": ["org:456", "org:789"],
    "edit": ["org:456"],
    "delete": ["org:456"]
  },
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
}

---

restoreEntity

Restores an entity by id

PATCH /v1/entity/{slug}/{id}:restore

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes	Entity id
slug	path	string	Yes	Entity Type
activity_id	query	string (ulid) | "" | null	No	Activity to include in event feed

Request Body

Sample Call

epilot entity restoreEntity \
  -p id=123e4567-e89b-12d3-a456-426614174000 \
  -p slug=contact \
  -d '{}'

Using positional args for path parameters:

epilot entity restoreEntity 123e4567-e89b-12d3-a456-426614174000 contact

Using stdin pipe:

cat body.json | epilot entity restoreEntity -p id=123e4567-e89b-12d3-a456-426614174000 -p slug=contact

With JSONata filter:

epilot entity restoreEntity -p id=123e4567-e89b-12d3-a456-426614174000 -p slug=contact --jsonata '$'

Sample Response

{
  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "_org": "123",
  "_owners": [
    {
      "org_id": "123",
      "user_id": "123"
    }
  ],
  "_schema": "contact",
  "_tags": ["example", "mock"],
  "_created_at": "2021-02-09T12:41:43.662Z",
  "_updated_at": "2021-02-09T12:41:43.662Z",
  "_acl": {
    "view": ["org:456", "org:789"],
    "edit": ["org:456"],
    "delete": ["org:456"]
  },
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
}

---

reindexEntity

Triggers a reindex for the Entity for search.

POST /v1/entity/{slug}/{id}:reindex

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes	Entity id
slug	path	string	Yes	Entity Type

Request Body

Sample Call

epilot entity reindexEntity \
  -p id=123e4567-e89b-12d3-a456-426614174000 \
  -p slug=contact \
  -d '{}'

Using positional args for path parameters:

epilot entity reindexEntity 123e4567-e89b-12d3-a456-426614174000 contact

Using stdin pipe:

cat body.json | epilot entity reindexEntity -p id=123e4567-e89b-12d3-a456-426614174000 -p slug=contact

With JSONata filter:

epilot entity reindexEntity -p id=123e4567-e89b-12d3-a456-426614174000 -p slug=contact --jsonata '$'

Sample Response

{
  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "_org": "123",
  "_owners": [
    {
      "org_id": "123",
      "user_id": "123"
    }
  ],
  "_schema": "contact",
  "_tags": ["example", "mock"],
  "_created_at": "2021-02-09T12:41:43.662Z",
  "_updated_at": "2021-02-09T12:41:43.662Z",
  "_acl": {
    "view": ["org:456", "org:789"],
    "edit": ["org:456"],
    "delete": ["org:456"]
  },
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
}

---

getEntity

Gets Entity and relations by id.

GET /v1/entity/{slug}/{id}

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes	Entity id
slug	path	string	Yes	Entity Type
hydrate	query	boolean	No	When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.

Sample Call

epilot entity getEntity \
  -p id=123e4567-e89b-12d3-a456-426614174000 \
  -p slug=contact

Using positional args for path parameters:

epilot entity getEntity 123e4567-e89b-12d3-a456-426614174000 contact

With JSONata filter:

epilot entity getEntity -p id=123e4567-e89b-12d3-a456-426614174000 -p slug=contact --jsonata 'entity._title'

Sample Response

{
  "entity": {
    "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "_org": "123",
    "_owners": [
      {
        "org_id": "123",
        "user_id": "123"
      }
    ],
    "_schema": "contact",
    "_tags": ["example", "mock"],
    "_created_at": "2021-02-09T12:41:43.662Z",
    "_updated_at": "2021-02-09T12:41:43.662Z",
    "_acl": {
      "view": ["org:456", "org:789"],
      "edit": ["org:456"],
      "delete": ["org:456"]
    },
    "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
  },
  "relations": [
    {
      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "_org": "123",
      "_owners": [
        {
          "org_id": "123",
          "user_id": "123"
        }
      ],
      "_schema": "contact",
      "_tags": ["example", "mock"],
      "_created_at": "2021-02-09T12:41:43.662Z",
      "_updated_at": "2021-02-09T12:41:43.662Z",
      "_acl": {
        "view": ["org:456", "org:789"],
        "edit": ["org:456"],
        "delete": ["org:456"]
      },
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
    }
  ]
}

---

updateEntity

Updates an Entity

PUT /v1/entity/{slug}/{id}

Parameters

Name	In	Type	Required	Description
slug	path	string	Yes	Entity Type
id	path	string (uuid)	Yes	Entity id
activity_id	query	string (ulid) | "" | null	No	Activity to include in event feed
fill_activity	query	boolean	No	Update the diff and entity for the custom activity included in the query.

Pending state on activity is automatically ended when activity is filled. | | async | query | boolean | No | Don't wait for updated entity to become available in Search API. Useful for large migrations | | validate | query | boolean | No | When true, enables entity validation against the entity schema. |

Request Body

Sample Call

epilot entity updateEntity \
  -p slug=contact \
  -p id=123e4567-e89b-12d3-a456-426614174000

With request body:

epilot entity updateEntity \
  -p slug=contact \
  -p id=123e4567-e89b-12d3-a456-426614174000 \
  -d '{
  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "_org": "123",
  "_owners": [
    {
      "org_id": "123",
      "user_id": "123"
    }
  ],
  "_schema": "contact",
  "_tags": ["example", "mock"],
  "_created_at": "2021-02-09T12:41:43.662Z",
  "_updated_at": "2021-02-09T12:41:43.662Z",
  "_acl": {
    "view": ["org:456", "org:789"],
    "edit": ["org:456"],
    "delete": ["org:456"]
  },
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
}'

Using positional args for path parameters:

epilot entity updateEntity contact 123e4567-e89b-12d3-a456-426614174000

Using stdin pipe:

cat body.json | epilot entity updateEntity -p slug=contact -p id=123e4567-e89b-12d3-a456-426614174000

With JSONata filter:

epilot entity updateEntity -p slug=contact -p id=123e4567-e89b-12d3-a456-426614174000 --jsonata '$'

Sample Response

{
  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "_org": "123",
  "_owners": [
    {
      "org_id": "123",
      "user_id": "123"
    }
  ],
  "_schema": "contact",
  "_tags": ["example", "mock"],
  "_created_at": "2021-02-09T12:41:43.662Z",
  "_updated_at": "2021-02-09T12:41:43.662Z",
  "_acl": {
    "view": ["org:456", "org:789"],
    "edit": ["org:456"],
    "delete": ["org:456"]
  },
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
}

---

patchEntity

Partially updates an entity with the passed in entity data.

PATCH /v1/entity/{slug}/{id}

Parameters

Name	In	Type	Required	Description
slug	path	string	Yes	Entity Type
id	path	string (uuid)	Yes	Entity id
activity_id	query	string (ulid) | "" | null	No	Activity to include in event feed
fill_activity	query	boolean	No	Update the diff and entity for the custom activity included in the query.

Pending state on activity is automatically ended when activity is filled. | | dry_run | query | boolean | No | Dry Run mode = return results but does not perform the operation. | | async | query | boolean | No | Don't wait for updated entity to become available in Search API. Useful for large migrations | | validate | query | boolean | No | When true, enables entity validation against the entity schema. |

Request Body (required)

Sample Call

epilot entity patchEntity \
  -p slug=contact \
  -p id=123e4567-e89b-12d3-a456-426614174000

With request body:

epilot entity patchEntity \
  -p slug=contact \
  -p id=123e4567-e89b-12d3-a456-426614174000 \
  -d '{
  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "_org": "123",
  "_owners": [
    {
      "org_id": "123",
      "user_id": "123"
    }
  ],
  "_schema": "contact",
  "_tags": ["example", "mock"],
  "_created_at": "2021-02-09T12:41:43.662Z",
  "_updated_at": "2021-02-09T12:41:43.662Z",
  "_acl": {
    "view": ["org:456", "org:789"],
    "edit": ["org:456"],
    "delete": ["org:456"]
  },
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
}'

Using positional args for path parameters:

epilot entity patchEntity contact 123e4567-e89b-12d3-a456-426614174000

Using stdin pipe:

cat body.json | epilot entity patchEntity -p slug=contact -p id=123e4567-e89b-12d3-a456-426614174000

With JSONata filter:

epilot entity patchEntity -p slug=contact -p id=123e4567-e89b-12d3-a456-426614174000 --jsonata '$'

Sample Response

{
  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "_org": "123",
  "_owners": [
    {
      "org_id": "123",
      "user_id": "123"
    }
  ],
  "_schema": "contact",
  "_tags": ["example", "mock"],
  "_created_at": "2021-02-09T12:41:43.662Z",
  "_updated_at": "2021-02-09T12:41:43.662Z",
  "_acl": {
    "view": ["org:456", "org:789"],
    "edit": ["org:456"],
    "delete": ["org:456"]
  },
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
}

---

deleteEntity

Deletes an Entity

DELETE /v1/entity/{slug}/{id}

Parameters

Name	In	Type	Required	Description
slug	path	string	Yes	Entity Type
id	path	string (uuid)	Yes	Entity id
activity_id	query	string (ulid) | "" | null	No	Activity to include in event feed
purge	query	boolean	No	Permanently deletes the entity when set to true

Sample Call

epilot entity deleteEntity \
  -p slug=contact \
  -p id=123e4567-e89b-12d3-a456-426614174000

Using positional args for path parameters:

epilot entity deleteEntity contact 123e4567-e89b-12d3-a456-426614174000

With JSONata filter:

epilot entity deleteEntity -p slug=contact -p id=123e4567-e89b-12d3-a456-426614174000 --jsonata '$'

---

autocomplete

Autocomplete entity attributes

GET /v1/entity:autocomplete

Parameters

Name	In	Type	Required	Description
input	query	string	No	Input to autocomplete
attribute	query	string	Yes	Autocomplete attribute
slug	query	string	No	Limit results to entity schema
size	query	number	No	Maximum number of results to return

Sample Call

epilot entity autocomplete \
  -p attribute=_tags

With JSONata filter:

epilot entity autocomplete -p attribute=_tags --jsonata 'results[0]'

Sample Response

{
  "hits": 1,
  "results": ["value"]
}

---

wipeAllEntities

Creates a request to queue the deletion of all entities in the system. This is a destructive operation and should only b

POST /v1/entity:wipeAllEntities

Request Body

Sample Call

epilot entity wipeAllEntities \
  -d '{"schemas":["contact"]}'

Using stdin pipe:

cat body.json | epilot entity wipeAllEntities

With JSONata filter:

epilot entity wipeAllEntities --jsonata '$'

---

createActivity

Create an activity that can be displayed in activity feeds.

POST /v1/entity/activity

Parameters

Name	In	Type	Required	Description
entities	query	string (uuid)[]	No	Comma-separated list of entities which the activity primarily concerns

Request Body

Sample Call

epilot entity createActivity

With request body:

epilot entity createActivity \
  -d '{
  "type": "string",
  "title": "My custom activity",
  "message": "{{caller}} did something with {{entity payload.entity.id}}.",
  "payload": {
    "entity": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "schema": "contact"
    }
  },
  "pending": false
}'

Using stdin pipe:

cat body.json | epilot entity createActivity

With JSONata filter:

epilot entity createActivity --jsonata '$'

Sample Response

{
  "_id": "01F130Q52Q6MWSNS8N2AVXV4JN",
  "timestamp": "1970-01-01T00:00:00.000Z",
  "type": "string",
  "title": "My custom activity",
  "message": "{{caller}} did something with {{entity payload.entity.id}}.",
  "payload": {
    "entity": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "schema": "contact"
    }
  },
  "pending": false,
  "caller": {
    "EpilotAuth": {
      "token": {
        "sub": "476e9b48-42f4-4234-a2b0-4668b34626ce",
        "cognito:groups": ["Administrator"],
        "cognito:preferred_role": "arn:aws:iam::912468240823:role/base-administrator-role",
        "iss": "https://cognito-idp.eu-central-1.amazonaws.com/eu-central-1_6lZSgmU6D",
        "custom:ivy_org_id": "739224",
        "cognito:username": "n.ahmad@epilot.cloud",
        "custom:ivy_user_id": "10006129",
        "cognito:roles": ["arn:aws:iam::912468240823:role/base-administrator-role"],
        "aud": "6e0jbdnger7nmoktaaflarue1l",
        "event_id": "cd5f5583-d90c-4db5-8e99-5f5dd29a4d75",
        "token_use": "id",
        "auth_time": 1614333023,
        "exp": 1614336623,
        "iat": 1614333023,
        "email": "n.ahmad@epilot.cloud"
      }
    }
  }
}

---

getActivity

Get activity by id

GET /v1/entity/activity/{id}

Parameters

Name	In	Type	Required	Description
id	path	string (ulid)	Yes	Activity Id
operations_size	query	number	No	Maximum number of operations to include in response (default: 10)
operations_from	query	number	No	Pagination offset for operations

Sample Call

epilot entity getActivity \
  -p id=01F130Q52Q6MWSNS8N2AVXV4JN

Using positional args for path parameters:

epilot entity getActivity 01F130Q52Q6MWSNS8N2AVXV4JN

With JSONata filter:

epilot entity getActivity -p id=01F130Q52Q6MWSNS8N2AVXV4JN --jsonata '$'

Sample Response

{
  "_id": "01F130Q52Q6MWSNS8N2AVXV4JN",
  "timestamp": "1970-01-01T00:00:00.000Z",
  "type": "string",
  "title": "My custom activity",
  "message": "{{caller}} did something with {{entity payload.entity.id}}.",
  "payload": {
    "entity": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "schema": "contact"
    }
  },
  "pending": false,
  "caller": {
    "EpilotAuth": {
      "token": {}
    }
  },
  "operations_total": 1,
  "operations": [
    {
      "entity": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "org": "123",
      "activity_id": "01F130Q52Q6MWSNS8N2AVXV4JN",
      "activity_type": "string",
      "operation": "createEntity",
      "params": {},
      "payload": {},
      "diff": {}
    }
  ]
}

---

attachActivity

Attach existing activity to entity activity feeds

POST /v1/entity/activity/{id}:attach

Parameters

Name	In	Type	Required	Description
id	path	string (ulid)	Yes	Activity Id
entities	query	string (uuid)[]	No	Comma-separated list of entities which the activity primarily concerns

Sample Call

epilot entity attachActivity \
  -p id=01F130Q52Q6MWSNS8N2AVXV4JN

Using positional args for path parameters:

epilot entity attachActivity 01F130Q52Q6MWSNS8N2AVXV4JN

With JSONata filter:

epilot entity attachActivity -p id=01F130Q52Q6MWSNS8N2AVXV4JN --jsonata '$'

Sample Response

{
  "_id": "01F130Q52Q6MWSNS8N2AVXV4JN",
  "timestamp": "1970-01-01T00:00:00.000Z",
  "type": "string",
  "title": "My custom activity",
  "message": "{{caller}} did something with {{entity payload.entity.id}}.",
  "payload": {
    "entity": {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "schema": "contact"
    }
  },
  "pending": false,
  "caller": {
    "EpilotAuth": {
      "token": {
        "sub": "476e9b48-42f4-4234-a2b0-4668b34626ce",
        "cognito:groups": ["Administrator"],
        "cognito:preferred_role": "arn:aws:iam::912468240823:role/base-administrator-role",
        "iss": "https://cognito-idp.eu-central-1.amazonaws.com/eu-central-1_6lZSgmU6D",
        "custom:ivy_org_id": "739224",
        "cognito:username": "n.ahmad@epilot.cloud",
        "custom:ivy_user_id": "10006129",
        "cognito:roles": ["arn:aws:iam::912468240823:role/base-administrator-role"],
        "aud": "6e0jbdnger7nmoktaaflarue1l",
        "event_id": "cd5f5583-d90c-4db5-8e99-5f5dd29a4d75",
        "token_use": "id",
        "auth_time": 1614333023,
        "exp": 1614336623,
        "iat": 1614333023,
        "email": "n.ahmad@epilot.cloud"
      }
    }
  }
}

---

getEntityActivityFeed

Get activity feed for an entity

GET /v1/entity/{slug}/{id}/activity

Parameters

Name	In	Type	Required	Description
slug	path	string	Yes	Entity Type
id	path	string (uuid)	Yes	Entity id
after	query	string (date-time)	No	Get activities strictly after this timestamp. Cannot be used with 'before', 'start_date', 'end_date', or 'preset_range'.
before	query	string (date-time)	No	Get activities strictly before this timestamp. Cannot be used with 'after', 'start_date', 'end_date', or 'preset_range'.
start_date	query	string (date-time)	No	The inclusive start timestamp for a date range filter. Requires 'end_date' to also be provided. Cannot be used with 'before', 'after', or 'preset_range'.
end_date	query	string (date-time)	No	The inclusive end timestamp for a date range filter. Requires 'start_date' to also be provided. Cannot be used with 'before', 'after', or 'preset_range'.
preset_range	query	"today" | "this_week" | "last_week"	No	Get activities within a predefined date range (e.g., 'today', 'last_week'). Cannot be used with 'before', 'after', 'start_date', or 'end_date'.
from	query	number	No	Starting page number
size	query	number	No	max number of results to return
type	query	string[]	No	Filter by activity type(s)
include_relations	query	boolean	No	Include activities from related entities
exclude_activity_groups	query	string	No	Exclude all activity types that are part of an activity group from results

Sample Call

epilot entity getEntityActivityFeed \
  -p slug=contact \
  -p id=123e4567-e89b-12d3-a456-426614174000

Using positional args for path parameters:

epilot entity getEntityActivityFeed contact 123e4567-e89b-12d3-a456-426614174000

With JSONata filter:

epilot entity getEntityActivityFeed -p slug=contact -p id=123e4567-e89b-12d3-a456-426614174000 --jsonata 'results[0]'

Sample Response

{
  "total": 1,
  "results": [
    {
      "_id": "01F130Q52Q6MWSNS8N2AVXV4JN",
      "timestamp": "1970-01-01T00:00:00.000Z",
      "type": "string",
      "title": "My custom activity",
      "message": "{{caller}} did something with {{entity payload.entity.id}}.",
      "payload": {},
      "pending": false,
      "caller": {},
      "operations_total": 1,
      "operations": []
    }
  ]
}

---

getRelations

Returns 1st level direct relations for an entity.

GET /v1/entity/{slug}/{id}/relations

Parameters

Name	In	Type	Required	Description
slug	path	string	Yes	Entity Type
id	path	string (uuid)	Yes	Entity id
hydrate	query	boolean	No	When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.
include_reverse	query	boolean	No	When true, includes reverse relations in response (other entities pointing to this entity)
from	query	number	No	Starting page number
size	query	number	No	Number of results to return per page
include_schemas	query	string[]	No	Filter results to only include schemas
exclude_schemas	query	string[]	No	Filter results to exclude schemas

Sample Call

epilot entity getRelations \
  -p slug=contact \
  -p id=123e4567-e89b-12d3-a456-426614174000

Using positional args for path parameters:

epilot entity getRelations contact 123e4567-e89b-12d3-a456-426614174000

With JSONata filter:

epilot entity getRelations -p slug=contact -p id=123e4567-e89b-12d3-a456-426614174000 --jsonata '$'

Sample Response

[
  {
    "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "org_id": "string",
    "_schema": "contact",
    "attribute": "string",
    "_tags": ["string"],
    "reverse": true
  },
  {
    "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "_org": "123",
    "_owners": [
      {
        "org_id": "123",
        "user_id": "123"
      }
    ],
    "_schema": "contact",
    "_tags": ["example", "mock"],
    "_created_at": "2021-02-09T12:41:43.662Z",
    "_updated_at": "2021-02-09T12:41:43.662Z",
    "_acl": {
      "view": ["org:456", "org:789"],
      "edit": ["org:456"],
      "delete": ["org:456"]
    },
    "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
  }
]

---

addRelations

Relates one or more entities to parent entity by adding items to a relation attribute

POST /v1/entity/{slug}/{id}/relations

Parameters

Name	In	Type	Required	Description
slug	path	string	Yes	Entity Type
id	path	string (uuid)	Yes	Entity id
async	query	boolean	No	Don't wait for updated entity to become available in Search API. Useful for large migrations
activity_id	query	string (ulid) | "" | null	No	Activity to include in event feed

Request Body

Sample Call

epilot entity addRelations \
  -p slug=contact \
  -p id=123e4567-e89b-12d3-a456-426614174000

With request body:

epilot entity addRelations \
  -p slug=contact \
  -p id=123e4567-e89b-12d3-a456-426614174000 \
  -d '[
  {
    "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "org_id": "string",
    "_schema": "contact",
    "attribute": "string",
    "_tags": ["string"],
    "reverse": true
  }
]'

Using positional args for path parameters:

epilot entity addRelations contact 123e4567-e89b-12d3-a456-426614174000

Using stdin pipe:

cat body.json | epilot entity addRelations -p slug=contact -p id=123e4567-e89b-12d3-a456-426614174000

With JSONata filter:

epilot entity addRelations -p slug=contact -p id=123e4567-e89b-12d3-a456-426614174000 --jsonata 'entity_id'

Sample Response

{
  "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "org_id": "string",
  "_schema": "contact",
  "attribute": "string",
  "_tags": ["string"],
  "reverse": true
}

---

removeRelations

Disassociate one or more entities to parent entity by removing items to a relation attribute

DELETE /v1/entity/{slug}/{id}/relations

Parameters

Name	In	Type	Required	Description
slug	path	string	Yes	Entity Type
id	path	string (uuid)	Yes	Entity id
async	query	boolean	No	Don't wait for updated entity to become available in Search API. Useful for large migrations
activity_id	query	string (ulid) | "" | null	No	Activity to include in event feed

Request Body

Sample Call

epilot entity removeRelations \
  -p slug=contact \
  -p id=123e4567-e89b-12d3-a456-426614174000

With request body:

epilot entity removeRelations \
  -p slug=contact \
  -p id=123e4567-e89b-12d3-a456-426614174000 \
  -d '[
  {
    "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "org_id": "string",
    "_schema": "contact",
    "attribute": "string",
    "_tags": ["string"],
    "reverse": true
  }
]'

Using positional args for path parameters:

epilot entity removeRelations contact 123e4567-e89b-12d3-a456-426614174000

Using stdin pipe:

cat body.json | epilot entity removeRelations -p slug=contact -p id=123e4567-e89b-12d3-a456-426614174000

With JSONata filter:

epilot entity removeRelations -p slug=contact -p id=123e4567-e89b-12d3-a456-426614174000 --jsonata '$'

---

getRelationsV2

Returns 1st level direct relations for an entity with pagination.

GET /v2/entity/{slug}/{id}/relations

Parameters

Name	In	Type	Required	Description
slug	path	string	Yes	Entity Type
id	path	string (uuid)	Yes	Entity id
hydrate	query	boolean	No	When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.
query	query	string	No	Input to filter search results
include_reverse	query	boolean	No	When true, includes reverse relations in response (other entities pointing to this entity)
from	query	number	No	Starting page number
size	query	number	No	Number of results to return per page
fields	query	string[]	No	List of entity fields to include in results

Sample Call

epilot entity getRelationsV2 \
  -p slug=contact \
  -p id=123e4567-e89b-12d3-a456-426614174000

Using positional args for path parameters:

epilot entity getRelationsV2 contact 123e4567-e89b-12d3-a456-426614174000

With JSONata filter:

epilot entity getRelationsV2 -p slug=contact -p id=123e4567-e89b-12d3-a456-426614174000 --jsonata 'hits[0]'

Sample Response

{
  "hits": 1,
  "relations": [
    {
      "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "org_id": "string",
      "_schema": "contact",
      "attribute": "string",
      "_tags": ["string"],
      "reverse": true
    },
    {
      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "_org": "123",
      "_owners": [
        {
          "org_id": "123",
          "user_id": "123"
        }
      ],
      "_schema": "contact",
      "_tags": ["example", "mock"],
      "_created_at": "2021-02-09T12:41:43.662Z",
      "_updated_at": "2021-02-09T12:41:43.662Z",
      "_acl": {
        "view": ["org:456", "org:789"],
        "edit": ["org:456"],
        "delete": ["org:456"]
      },
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
    }
  ]
}

---

getRelationsV3

Returns 1st level direct relations for an entity with pagination.

GET /v3/entity/{slug}/{id}/relations

Parameters

Name	In	Type	Required	Description
slug	path	string	Yes	Entity Type
id	path	string (uuid)	Yes	Entity id
hydrate	query	boolean	No	When true, enables entity hydration to resolve nested $relation & $relation_ref references in-place.
include_reverse	query	boolean	No	When true, includes reverse relations in response (other entities pointing to this entity)

It gets overriden by mode query parameter. | | from | query | number | No | Starting page number | | size | query | number | No | Number of results to return per page | | include_schemas | query | string[] | No | Filter results to only include schemas | | exclude_schemas | query | string[] | No | Filter results to exclude schemas | | mode | query | "direct" | "reverse" | "both" | No | Options to determine how relations will be included in the result. It overrides the include_reverse query param. Explanation of possible options:

• direct: include relations to which the searched en | | fields | query | string[] | No | List of entity fields to include in results | | include_deleted | query | "true" | "false" | "only" | No | Whether to include relations to/from deleted entities
• true: include relations to/from deleted entities
• false: exclude relations to/from deleted entities (default)
• only: include only relati |

Sample Call

epilot entity getRelationsV3 \
  -p slug=contact \
  -p id=123e4567-e89b-12d3-a456-426614174000

Using positional args for path parameters:

epilot entity getRelationsV3 contact 123e4567-e89b-12d3-a456-426614174000

With JSONata filter:

epilot entity getRelationsV3 -p slug=contact -p id=123e4567-e89b-12d3-a456-426614174000 --jsonata 'hits[0]'

Sample Response

{
  "hits": 1,
  "relations": [
    {
      "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "org_id": "string",
      "_schema": "contact",
      "attribute": "string",
      "_tags": ["string"],
      "reverse": true
    },
    {
      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "_org": "123",
      "_owners": [
        {
          "org_id": "123",
          "user_id": "123"
        }
      ],
      "_schema": "contact",
      "_tags": ["example", "mock"],
      "_created_at": "2021-02-09T12:41:43.662Z",
      "_updated_at": "2021-02-09T12:41:43.662Z",
      "_acl": {
        "view": ["org:456", "org:789"],
        "edit": ["org:456"],
        "delete": ["org:456"]
      },
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
    }
  ]
}

---

getRelatedEntitiesCount

Returns the amount of unique related entities for an entity - includes direct and reverse relations.

GET /v2/entity/{slug}/{id}/relations/count

Parameters

Name	In	Type	Required	Description
slug	path	string	Yes	Entity Type
id	path	string (uuid)	Yes	Entity id
exclude_schemas	query	string[]	No	Filter results to exclude schemas

Sample Call

epilot entity getRelatedEntitiesCount \
  -p slug=contact \
  -p id=123e4567-e89b-12d3-a456-426614174000

Using positional args for path parameters:

epilot entity getRelatedEntitiesCount contact 123e4567-e89b-12d3-a456-426614174000

With JSONata filter:

epilot entity getRelatedEntitiesCount -p slug=contact -p id=123e4567-e89b-12d3-a456-426614174000 --jsonata 'hits[0]'

Sample Response

{
  "hits": 1
}

---

updateRelation

Updates an existing relation between two entities.

PUT /v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}

Parameters

Name	In	Type	Required	Description
slug	path	string	Yes	Entity Type
id	path	string (uuid)	Yes	Entity id
attribute	path	string	Yes	The attribute that express meaning
entity_id	path	string	Yes	The attribute that express meaning
async	query	boolean	No	Don't wait for updated entity to become available in Search API. Useful for large migrations
activity_id	query	string (ulid) | "" | null	No	Activity to include in event feed

Request Body

Sample Call

epilot entity updateRelation \
  -p slug=contact \
  -p id=123e4567-e89b-12d3-a456-426614174000 \
  -p attribute=example \
  -p entity_id=123e4567-e89b-12d3-a456-426614174000 \
  -d '{"_tags":["string"]}'

Using positional args for path parameters:

epilot entity updateRelation contact 123e4567-e89b-12d3-a456-426614174000 example 123e4567-e89b-12d3-a456-426614174000

Using stdin pipe:

cat body.json | epilot entity updateRelation -p slug=contact -p id=123e4567-e89b-12d3-a456-426614174000 -p attribute=example -p entity_id=123e4567-e89b-12d3-a456-426614174000

With JSONata filter:

epilot entity updateRelation -p slug=contact -p id=123e4567-e89b-12d3-a456-426614174000 -p attribute=example -p entity_id=123e4567-e89b-12d3-a456-426614174000 --jsonata 'entity_id'

Sample Response

{
  "entity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "org_id": "string",
  "_schema": "contact",
  "attribute": "string",
  "_tags": ["string"],
  "reverse": true
}

---

deleteRelation

Removes relation between two entities

DELETE /v1/entity/{slug}/{id}/relations/{attribute}/{entity_id}

Parameters

Name	In	Type	Required	Description
slug	path	string	Yes	Entity Type
id	path	string (uuid)	Yes	Entity id
attribute	path	string	Yes	The attribute that express meaning
entity_id	path	string	Yes	The attribute that express meaning
async	query	boolean	No	Don't wait for updated entity to become available in Search API. Useful for large migrations
activity_id	query	string (ulid) | "" | null	No	Activity to include in event feed

Sample Call

epilot entity deleteRelation \
  -p slug=contact \
  -p id=123e4567-e89b-12d3-a456-426614174000 \
  -p attribute=example \
  -p entity_id=123e4567-e89b-12d3-a456-426614174000

Using positional args for path parameters:

epilot entity deleteRelation contact 123e4567-e89b-12d3-a456-426614174000 example 123e4567-e89b-12d3-a456-426614174000

With JSONata filter:

epilot entity deleteRelation -p slug=contact -p id=123e4567-e89b-12d3-a456-426614174000 -p attribute=example -p entity_id=123e4567-e89b-12d3-a456-426614174000 --jsonata '$'

---

exportEntities

Export entity data in a CSV-format. The export will export data as close as possible to what is visible on Entity UI tab

POST /v1/entity:export

Parameters

Name	In	Type	Required	Description
job_id	query	string	No	Export Job Id to get the result
is_template	query	boolean	No	Pass 'true' to generate import template
language	query	string	No	Export headers translation language

Request Body

Sample Call

epilot entity exportEntities

With request body:

epilot entity exportEntities \
  -d '{
  "q": "_schema:contact AND status:active",
  "include_scores": false,
  "sort": "string",
  "from": 0,
  "size": 10,
  "hydrate": false,
  "fields": ["_id", "_title", "first_name", "account", "!account.*._files", "**._product"],
  "aggs": {
    "contact-count-per-tag": {
      "terms": {
        "field": "_tags.keyword"
      }
    }
  },
  "include_deleted": "false",
  "highlight": {},
  "stable_for": 0,
  "stable_query_id": "string",
  "search_after": ["string"]
}'

Using stdin pipe:

cat body.json | epilot entity exportEntities

With JSONata filter:

epilot entity exportEntities --jsonata '$'

---

importEntities

This endpoint enables the import of entities into the platform.

POST /v1/entity:import

Parameters

Name	In	Type	Required	Description
job_id	query	string	No	The ID of the import job. This ID is used to track the progress and fetch the result of the import operation.

Request Body

Sample Call

epilot entity importEntities \
  -d '{"S3Reference":{"bucket":"my-bucket","key":"imports/my-import.json"},"schema":"contact"}'

Using stdin pipe:

cat body.json | epilot entity importEntities

With JSONata filter:

epilot entity importEntities --jsonata '$'

---

listSavedViews

Get the Saved Views based on the schema

GET /v1/entity/views

Parameters

Name	In	Type	Required	Description
slug	query	string	No	Return views belonging to this schema
sort	query	string	No	The sort key to use if present
from	query	number	No
size	query	number	No	Number of saved views to return
fields	query	string[]	No

Sample Call

epilot entity listSavedViews

With JSONata filter:

epilot entity listSavedViews --jsonata 'results[0]'

Sample Response

{
  "hits": 1,
  "results": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "created_at": "string",
      "updated_at": "string",
      "slug": ["contact"],
      "name": "View listing German",
      "org": "66",
      "shared": true,
      "isFavoritedBy": ["11701"],
      "created_by": {
        "user_id": "10598"
      },
      "ui_config": {
        "filters": {
          "customer_name": "suresh test",
          "_tags": "360"
        },
        "table_layout": {
          "opportunity": {
            "page": 1,
            "sort": "_created_at:desc",
            "pageSize": 25,
            "columnSettings": []
          }
        }
      },
      "shared_with": ["112233"]
    }
  ]
}

---

createSavedView

Creates a new saved view

POST /v1/entity/view

Request Body

Sample Call

epilot entity createSavedView

With request body:

epilot entity createSavedView \
  -d '{
  "slug": ["contact"],
  "name": "View listing German",
  "org": "66",
  "shared": true,
  "isFavoritedBy": ["11701"],
  "created_by": {
    "user_id": "10598"
  },
  "ui_config": {
    "filters": {
      "customer_name": "suresh test",
      "_tags": "360"
    },
    "table_layout": {
      "opportunity": {
        "page": 1,
        "sort": "_created_at:desc",
        "pageSize": 25,
        "columnSettings": []
      }
    }
  },
  "shared_with": ["112233"]
}'

Using stdin pipe:

cat body.json | epilot entity createSavedView

With JSONata filter:

epilot entity createSavedView --jsonata '$'

Sample Response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_at": "string",
  "updated_at": "string",
  "slug": ["contact"],
  "name": "View listing German",
  "org": "66",
  "shared": true,
  "isFavoritedBy": ["11701"],
  "created_by": {
    "user_id": "10598"
  },
  "ui_config": {
    "filters": {
      "customer_name": "suresh test",
      "_tags": "360"
    },
    "table_layout": {
      "opportunity": {
        "page": 1,
        "sort": "_created_at:desc",
        "pageSize": 25,
        "columnSettings": []
      }
    }
  },
  "shared_with": ["112233"]
}

---

getSavedView

Gets Saved View configuration by id.

GET /v1/entity/view/{id}

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes	View id

Sample Call

epilot entity getSavedView \
  -p id=123e4567-e89b-12d3-a456-426614174000

Using positional args for path parameters:

epilot entity getSavedView 123e4567-e89b-12d3-a456-426614174000

With JSONata filter:

epilot entity getSavedView -p id=123e4567-e89b-12d3-a456-426614174000 --jsonata '$'

Sample Response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_at": "string",
  "updated_at": "string",
  "slug": ["contact"],
  "name": "View listing German",
  "org": "66",
  "shared": true,
  "isFavoritedBy": ["11701"],
  "created_by": {
    "user_id": "10598"
  },
  "ui_config": {
    "filters": {
      "customer_name": "suresh test",
      "_tags": "360"
    },
    "table_layout": {
      "opportunity": {
        "page": 1,
        "sort": "_created_at:desc",
        "pageSize": 25,
        "columnSettings": []
      }
    }
  },
  "shared_with": ["112233"]
}

---

updateSavedView

Updates a saved view

PUT /v1/entity/view/{id}

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes	View id

Request Body

Sample Call

epilot entity updateSavedView \
  -p id=123e4567-e89b-12d3-a456-426614174000

With request body:

epilot entity updateSavedView \
  -p id=123e4567-e89b-12d3-a456-426614174000 \
  -d '{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_at": "string",
  "updated_at": "string",
  "slug": ["contact"],
  "name": "View listing German",
  "org": "66",
  "shared": true,
  "isFavoritedBy": ["11701"],
  "created_by": {
    "user_id": "10598"
  },
  "ui_config": {
    "filters": {
      "customer_name": "suresh test",
      "_tags": "360"
    },
    "table_layout": {
      "opportunity": {
        "page": 1,
        "sort": "_created_at:desc",
        "pageSize": 25,
        "columnSettings": []
      }
    }
  },
  "shared_with": ["112233"]
}'

Using positional args for path parameters:

epilot entity updateSavedView 123e4567-e89b-12d3-a456-426614174000

Using stdin pipe:

cat body.json | epilot entity updateSavedView -p id=123e4567-e89b-12d3-a456-426614174000

With JSONata filter:

epilot entity updateSavedView -p id=123e4567-e89b-12d3-a456-426614174000 --jsonata '$'

Sample Response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_at": "string",
  "updated_at": "string",
  "slug": ["contact"],
  "name": "View listing German",
  "org": "66",
  "shared": true,
  "isFavoritedBy": ["11701"],
  "created_by": {
    "user_id": "10598"
  },
  "ui_config": {
    "filters": {
      "customer_name": "suresh test",
      "_tags": "360"
    },
    "table_layout": {
      "opportunity": {
        "page": 1,
        "sort": "_created_at:desc",
        "pageSize": 25,
        "columnSettings": []
      }
    }
  },
  "shared_with": ["112233"]
}

---

patchSavedView

Partially updates a saved view with the provided payload. If an updated_at is passed and the server contains a newer ver

PATCH /v1/entity/view/{id}

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes	View id

Request Body

Sample Call

epilot entity patchSavedView \
  -p id=123e4567-e89b-12d3-a456-426614174000

With request body:

epilot entity patchSavedView \
  -p id=123e4567-e89b-12d3-a456-426614174000 \
  -d '{
  "slug": ["contact"],
  "name": "View listing German",
  "org": "66",
  "shared": true,
  "isFavoritedBy": ["11701"],
  "created_by": {
    "user_id": "10598"
  },
  "ui_config": {
    "filters": {
      "customer_name": "suresh test",
      "_tags": "360"
    },
    "table_layout": {
      "opportunity": {
        "page": 1,
        "sort": "_created_at:desc",
        "pageSize": 25,
        "columnSettings": []
      }
    }
  },
  "shared_with": ["112233"]
}'

Using positional args for path parameters:

epilot entity patchSavedView 123e4567-e89b-12d3-a456-426614174000

Using stdin pipe:

cat body.json | epilot entity patchSavedView -p id=123e4567-e89b-12d3-a456-426614174000

With JSONata filter:

epilot entity patchSavedView -p id=123e4567-e89b-12d3-a456-426614174000 --jsonata '$'

Sample Response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_at": "string",
  "updated_at": "string",
  "slug": ["contact"],
  "name": "View listing German",
  "org": "66",
  "shared": true,
  "isFavoritedBy": ["11701"],
  "created_by": {
    "user_id": "10598"
  },
  "ui_config": {
    "filters": {
      "customer_name": "suresh test",
      "_tags": "360"
    },
    "table_layout": {
      "opportunity": {
        "page": 1,
        "sort": "_created_at:desc",
        "pageSize": 25,
        "columnSettings": []
      }
    }
  },
  "shared_with": ["112233"]
}

---

deleteSavedView

Deletes a saved view

DELETE /v1/entity/view/{id}

Parameters

Name	In	Type	Required	Description
id	path	string (uuid)	Yes	View id

Sample Call

epilot entity deleteSavedView \
  -p id=123e4567-e89b-12d3-a456-426614174000

Using positional args for path parameters:

epilot entity deleteSavedView 123e4567-e89b-12d3-a456-426614174000

With JSONata filter:

epilot entity deleteSavedView -p id=123e4567-e89b-12d3-a456-426614174000 --jsonata '$'

---

listFavoriteViewsForUser

Get the Favorite Saved Views for user based on the schema

GET /v1/entity/views/favorites

Sample Call

epilot entity listFavoriteViewsForUser

With JSONata filter:

epilot entity listFavoriteViewsForUser --jsonata 'results[0]'

Sample Response

{
  "results": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "created_at": "string",
      "updated_at": "string",
      "slug": ["contact"],
      "name": "View listing German",
      "org": "66",
      "shared": true,
      "isFavoritedBy": ["11701"],
      "created_by": {
        "user_id": "10598"
      },
      "ui_config": {
        "filters": {
          "customer_name": "suresh test",
          "_tags": "360"
        },
        "table_layout": {
          "opportunity": {
            "page": 1,
            "sort": "_created_at:desc",
            "pageSize": 25,
            "columnSettings": []
          }
        }
      },
      "shared_with": ["112233"]
    }
  ]
}

---

listTaxonomies

List taxonomies in an organization

GET /v1/entity/taxonomies

Parameters

Name	In	Type	Required	Description
include_disabled	query	boolean	No	Include disabled taxonomies
type	query	"entity" | "relation"	No	Type of taxonomy to include

Sample Call

epilot entity listTaxonomies

With JSONata filter:

epilot entity listTaxonomies --jsonata 'results[0]'

Sample Response

{
  "results": [
    {
      "slug": "purpose",
      "name": "Purpose",
      "plural": "Purposes",
      "kind": "system",
      "type": "entity",
      "icon": "purpose",
      "color": "#FF5733",
      "created_at": "1970-01-01T00:00:00.000Z",
      "updated_at": "1970-01-01T00:00:00.000Z",
      "deleted_at": "1970-01-01T00:00:00.000Z",
      "created_by": "10598",
      "enabled": true,
      "order": 10,
      "enabled_locations": ["account", "string"]
    }
  ]
}

---

createTaxonomy

Create a new taxonomy

POST /v1/entity/taxonomies

Request Body

Sample Call

epilot entity createTaxonomy

With request body:

epilot entity createTaxonomy \
  -d '{
  "slug": "purpose",
  "name": "Purpose",
  "plural": "Purposes",
  "kind": "system",
  "type": "entity",
  "icon": "purpose",
  "color": "#FF5733",
  "created_at": "1970-01-01T00:00:00.000Z",
  "updated_at": "1970-01-01T00:00:00.000Z",
  "deleted_at": "1970-01-01T00:00:00.000Z",
  "created_by": "10598",
  "enabled": true,
  "order": 10,
  "enabled_locations": ["account", "string"]
}'

Using stdin pipe:

cat body.json | epilot entity createTaxonomy

With JSONata filter:

epilot entity createTaxonomy --jsonata 'slug'

Sample Response

{
  "slug": "purpose",
  "name": "Purpose",
  "plural": "Purposes",
  "kind": "system",
  "type": "entity",
  "icon": "purpose",
  "color": "#FF5733",
  "created_at": "1970-01-01T00:00:00.000Z",
  "updated_at": "1970-01-01T00:00:00.000Z",
  "deleted_at": "1970-01-01T00:00:00.000Z",
  "created_by": "10598",
  "enabled": true,
  "order": 10,
  "enabled_locations": ["account", "string"]
}

---

getTaxonomy

Get taxonomy by slug

GET /v1/entity/taxonomies/{taxonomySlug}

Parameters

Name	In	Type	Required	Description
taxonomySlug	path	string	Yes	Taxonomy slug

Sample Call

epilot entity getTaxonomy \
  -p taxonomySlug=example

Using positional args for path parameters:

epilot entity getTaxonomy example

With JSONata filter:

epilot entity getTaxonomy -p taxonomySlug=example --jsonata 'slug'

Sample Response

{
  "slug": "purpose",
  "name": "Purpose",
  "plural": "Purposes",
  "kind": "system",
  "type": "entity",
  "icon": "purpose",
  "color": "#FF5733",
  "created_at": "1970-01-01T00:00:00.000Z",
  "updated_at": "1970-01-01T00:00:00.000Z",
  "deleted_at": "1970-01-01T00:00:00.000Z",
  "created_by": "10598",
  "enabled": true,
  "order": 10,
  "enabled_locations": ["account", "string"]
}

---

updateTaxonomy

Update a taxonomy

PUT /v1/entity/taxonomies/{taxonomySlug}

Parameters

Name	In	Type	Required	Description
taxonomySlug	path	string	Yes	Taxonomy slug

Request Body

Sample Call

epilot entity updateTaxonomy \
  -p taxonomySlug=example

With request body:

epilot entity updateTaxonomy \
  -p taxonomySlug=example \
  -d '{
  "slug": "purpose",
  "name": "Purpose",
  "plural": "Purposes",
  "kind": "system",
  "type": "entity",
  "icon": "purpose",
  "color": "#FF5733",
  "created_at": "1970-01-01T00:00:00.000Z",
  "updated_at": "1970-01-01T00:00:00.000Z",
  "deleted_at": "1970-01-01T00:00:00.000Z",
  "created_by": "10598",
  "enabled": true,
  "order": 10,
  "enabled_locations": ["account", "string"]
}'

Using positional args for path parameters:

epilot entity updateTaxonomy example

Using stdin pipe:

cat body.json | epilot entity updateTaxonomy -p taxonomySlug=example

With JSONata filter:

epilot entity updateTaxonomy -p taxonomySlug=example --jsonata 'slug'

Sample Response

{
  "slug": "purpose",
  "name": "Purpose",
  "plural": "Purposes",
  "kind": "system",
  "type": "entity",
  "icon": "purpose",
  "color": "#FF5733",
  "created_at": "1970-01-01T00:00:00.000Z",
  "updated_at": "1970-01-01T00:00:00.000Z",
  "deleted_at": "1970-01-01T00:00:00.000Z",
  "created_by": "10598",
  "enabled": true,
  "order": 10,
  "enabled_locations": ["account", "string"]
}

---

deleteTaxonomy

Delete a taxonomy

DELETE /v1/entity/taxonomies/{taxonomySlug}

Parameters

Name	In	Type	Required	Description
taxonomySlug	path	string	Yes	Taxonomy slug
permanent	query	boolean	No	⚠️ NOT IMPLEMENTED - If true, the taxonomy will be permanently deleted

Sample Call

epilot entity deleteTaxonomy \
  -p taxonomySlug=example

Using positional args for path parameters:

epilot entity deleteTaxonomy example

With JSONata filter:

epilot entity deleteTaxonomy -p taxonomySlug=example --jsonata '$'

---

updateClassificationsForTaxonomy

Update the classifications for a taxonomy

POST /v1/entity/taxonomies/{taxonomySlug}/classifications

Parameters

Name	In	Type	Required	Description
taxonomySlug	path	string	Yes	Taxonomy slug

Request Body

Sample Call

epilot entity updateClassificationsForTaxonomy \
  -p taxonomySlug=example

With request body:

epilot entity updateClassificationsForTaxonomy \
  -p taxonomySlug=example \
  -d '{
  "create": [
    {
      "id": "taxonomy-slug:classification-slug",
      "slug": "wallbox-pv",
      "name": "Wallbox PV",
      "parents": ["taxonomy-slug:classification-slug"],
      "color": "#FF5733",
      "created_at": "1970-01-01T00:00:00.000Z",
      "updated_at": "1970-01-01T00:00:00.000Z",
      "archived": false,
      "starred": false,
      "enabled_locations": ["account", "string"],
      "enabled_purposes": ["string"],
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
    }
  ],
  "update": [
    {
      "id": "taxonomy-slug:classification-slug",
      "slug": "wallbox-pv",
      "name": "Wallbox PV",
      "parents": ["taxonomy-slug:classification-slug"],
      "color": "#FF5733",
      "created_at": "1970-01-01T00:00:00.000Z",
      "updated_at": "1970-01-01T00:00:00.000Z",
      "archived": false,
      "starred": false,
      "enabled_locations": ["account", "string"],
      "enabled_purposes": ["string"],
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
    }
  ],
  "delete": ["taxonomy-slug:classification-slug", "taxonomy-slug:classification-slug"]
}'

Using positional args for path parameters:

epilot entity updateClassificationsForTaxonomy example

Using stdin pipe:

cat body.json | epilot entity updateClassificationsForTaxonomy -p taxonomySlug=example

With JSONata filter:

epilot entity updateClassificationsForTaxonomy -p taxonomySlug=example --jsonata 'created'

Sample Response

{
  "created": [
    {
      "id": "taxonomy-slug:classification-slug",
      "slug": "wallbox-pv",
      "name": "Wallbox PV",
      "parents": ["taxonomy-slug:classification-slug"],
      "color": "#FF5733",
      "created_at": "1970-01-01T00:00:00.000Z",
      "updated_at": "1970-01-01T00:00:00.000Z",
      "archived": false,
      "starred": false,
      "enabled_locations": ["account", "string"],
      "enabled_purposes": ["string"],
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
    }
  ],
  "updated": [
    {
      "id": "taxonomy-slug:classification-slug",
      "slug": "wallbox-pv",
      "name": "Wallbox PV",
      "parents": ["taxonomy-slug:classification-slug"],
      "color": "#FF5733",
      "created_at": "1970-01-01T00:00:00.000Z",
      "updated_at": "1970-01-01T00:00:00.000Z",
      "archived": false,
      "starred": false,
      "enabled_locations": ["account", "string"],
      "enabled_purposes": ["string"],
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
    }
  ],
  "deleted": {}
}

---

createTaxonomyClassification

Create a new classification for a taxonomy

POST /v2/entity/taxonomies/classifications

Request Body

Sample Call

epilot entity createTaxonomyClassification

With request body:

epilot entity createTaxonomyClassification \
  -d '{
  "id": "taxonomy-slug:classification-slug",
  "slug": "wallbox-pv",
  "name": "Wallbox PV",
  "parents": ["taxonomy-slug:classification-slug"],
  "color": "#FF5733",
  "created_at": "1970-01-01T00:00:00.000Z",
  "updated_at": "1970-01-01T00:00:00.000Z",
  "archived": false,
  "starred": false,
  "enabled_locations": ["account", "string"],
  "enabled_purposes": ["string"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
}'

Using stdin pipe:

cat body.json | epilot entity createTaxonomyClassification

With JSONata filter:

epilot entity createTaxonomyClassification --jsonata 'id'

Sample Response

{
  "id": "taxonomy-slug:classification-slug",
  "slug": "wallbox-pv",
  "name": "Wallbox PV",
  "parents": ["taxonomy-slug:classification-slug"],
  "color": "#FF5733",
  "created_at": "1970-01-01T00:00:00.000Z",
  "updated_at": "1970-01-01T00:00:00.000Z",
  "archived": false,
  "starred": false,
  "enabled_locations": ["account", "string"],
  "enabled_purposes": ["string"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
}

---

getTaxonomyClassification

Get a classification for a taxonomy by slug

GET /v2/entity/taxonomies/classifications/{classificationSlug}

Parameters

Name	In	Type	Required	Description
classificationSlug	path	string	Yes	Taxonomy Classification slug

Sample Call

epilot entity getTaxonomyClassification \
  -p classificationSlug=purpose:<name>

Using positional args for path parameters:

epilot entity getTaxonomyClassification purpose:<name>

With JSONata filter:

epilot entity getTaxonomyClassification -p classificationSlug=purpose:<name> --jsonata 'id'

Sample Response

{
  "id": "taxonomy-slug:classification-slug",
  "slug": "wallbox-pv",
  "name": "Wallbox PV",
  "parents": ["taxonomy-slug:classification-slug"],
  "color": "#FF5733",
  "created_at": "1970-01-01T00:00:00.000Z",
  "updated_at": "1970-01-01T00:00:00.000Z",
  "archived": false,
  "starred": false,
  "enabled_locations": ["account", "string"],
  "enabled_purposes": ["string"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
}

---

updateTaxonomyClassification

Update a classification for a taxonomy

PUT /v2/entity/taxonomies/classifications/{classificationSlug}

Parameters

Name	In	Type	Required	Description
classificationSlug	path	string	Yes	Taxonomy Classification slug

Request Body

Sample Call

epilot entity updateTaxonomyClassification \
  -p classificationSlug=purpose:<name>

With request body:

epilot entity updateTaxonomyClassification \
  -p classificationSlug=purpose:<name> \
  -d '{
  "id": "taxonomy-slug:classification-slug",
  "slug": "wallbox-pv",
  "name": "Wallbox PV",
  "parents": ["taxonomy-slug:classification-slug"],
  "color": "#FF5733",
  "created_at": "1970-01-01T00:00:00.000Z",
  "updated_at": "1970-01-01T00:00:00.000Z",
  "archived": false,
  "starred": false,
  "enabled_locations": ["account", "string"],
  "enabled_purposes": ["string"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
}'

Using positional args for path parameters:

epilot entity updateTaxonomyClassification purpose:<name>

Using stdin pipe:

cat body.json | epilot entity updateTaxonomyClassification -p classificationSlug=purpose:<name>

With JSONata filter:

epilot entity updateTaxonomyClassification -p classificationSlug=purpose:<name> --jsonata 'id'

Sample Response

{
  "id": "taxonomy-slug:classification-slug",
  "slug": "wallbox-pv",
  "name": "Wallbox PV",
  "parents": ["taxonomy-slug:classification-slug"],
  "color": "#FF5733",
  "created_at": "1970-01-01T00:00:00.000Z",
  "updated_at": "1970-01-01T00:00:00.000Z",
  "archived": false,
  "starred": false,
  "enabled_locations": ["account", "string"],
  "enabled_purposes": ["string"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
}

---

deleteTaxonomyClassification

Delete a classification for a taxonomy

DELETE /v2/entity/taxonomies/classifications/{classificationSlug}

Parameters

Name	In	Type	Required	Description
classificationSlug	path	string	Yes	Taxonomy Classification slug

Sample Call

epilot entity deleteTaxonomyClassification \
  -p classificationSlug=purpose:<name>

Using positional args for path parameters:

epilot entity deleteTaxonomyClassification purpose:<name>

With JSONata filter:

epilot entity deleteTaxonomyClassification -p classificationSlug=purpose:<name> --jsonata 'id'

Sample Response

{
  "id": "taxonomy-slug:classification-slug",
  "slug": "wallbox-pv",
  "name": "Wallbox PV",
  "parents": ["taxonomy-slug:classification-slug"],
  "color": "#FF5733",
  "created_at": "1970-01-01T00:00:00.000Z",
  "updated_at": "1970-01-01T00:00:00.000Z",
  "archived": false,
  "starred": false,
  "enabled_locations": ["account", "string"],
  "enabled_purposes": ["string"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
}

---

taxonomyAutocomplete

Taxonomies autocomplete

GET /v1/entity/taxonomies/{taxonomySlug}:autocomplete

Parameters

Name	In	Type	Required	Description
taxonomySlug	path	string	Yes	Taxonomy slug
query	query	string	No	Input to autocomplete
size	query	number	No	Minimum number of results to return

Sample Call

epilot entity taxonomyAutocomplete \
  -p taxonomySlug=example

Using positional args for path parameters:

epilot entity taxonomyAutocomplete example

With JSONata filter:

epilot entity taxonomyAutocomplete -p taxonomySlug=example --jsonata 'results[0]'

Sample Response

{
  "results": [
    {
      "id": "taxonomy-slug:classification-slug",
      "slug": "wallbox-pv",
      "name": "Wallbox PV",
      "parents": ["taxonomy-slug:classification-slug"],
      "color": "#FF5733",
      "created_at": "1970-01-01T00:00:00.000Z",
      "updated_at": "1970-01-01T00:00:00.000Z",
      "archived": false,
      "starred": false,
      "enabled_locations": ["account", "string"],
      "enabled_purposes": ["string"],
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
    }
  ]
}

---

taxonomiesClassificationsSearch

List taxonomy classifications in an organization based on taxonomy slug

POST /v1/entity/taxonomies/classifications:search

Parameters

Name	In	Type	Required	Description
taxonomySlug	query	string | string[]	No	The taxonomy slug(s) to search within. When provided with multiple taxonomy slugs, the search will be performed across all the provided taxonomies.
query	query	string	No	The label names to search for (lowercase insensitive)
archived	query	boolean	No	Filter by archived status. Deprecated. Use include_archived instead.
include_archived	query	"true" | "false" | "only"	No

Request Body

Sample Call

epilot entity taxonomiesClassificationsSearch \
  -d '{"classificationIds":["taxonomy-slug:classification-slug",{"pattern":"taxonomy-slug:*"}]}'

Using stdin pipe:

cat body.json | epilot entity taxonomiesClassificationsSearch

With JSONata filter:

epilot entity taxonomiesClassificationsSearch --jsonata 'results[0]'

Sample Response

{
  "results": [
    {
      "id": "taxonomy-slug:classification-slug",
      "slug": "wallbox-pv",
      "name": "Wallbox PV",
      "parents": ["taxonomy-slug:classification-slug"],
      "color": "#FF5733",
      "created_at": "1970-01-01T00:00:00.000Z",
      "updated_at": "1970-01-01T00:00:00.000Z",
      "archived": false,
      "starred": false,
      "enabled_locations": ["account", "string"],
      "enabled_purposes": ["string"],
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
    }
  ],
  "hits": 10
}

---

listTaxonomyClassificationsForSchema

List taxonomy classifications for a given schema

GET /v1/entity/schemas/{slug}/taxonomy/{taxonomySlug}

Parameters

Name	In	Type	Required	Description
slug	path	string	Yes	Entity Type
taxonomySlug	path	string	Yes	Taxonomy slug
query	query	string	No
size	query	number	No

Sample Call

epilot entity listTaxonomyClassificationsForSchema \
  -p slug=contact \
  -p taxonomySlug=example

Using positional args for path parameters:

epilot entity listTaxonomyClassificationsForSchema contact example

With JSONata filter:

epilot entity listTaxonomyClassificationsForSchema -p slug=contact -p taxonomySlug=example --jsonata 'results[0]'

Sample Response

{
  "results": [
    {
      "id": "taxonomy-slug:classification-slug",
      "slug": "wallbox-pv",
      "name": "Wallbox PV",
      "parents": ["taxonomy-slug:classification-slug"],
      "color": "#FF5733",
      "created_at": "1970-01-01T00:00:00.000Z",
      "updated_at": "1970-01-01T00:00:00.000Z",
      "archived": false,
      "starred": false,
      "enabled_locations": ["account", "string"],
      "enabled_purposes": ["string"],
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"]
    }
  ]
}

---

getTaxonomyBulkActionJobs

Gets bulk actions jobs by job status:

GET /v1/entity/taxonomies/bulk-jobs

Parameters

Name	In	Type	Required	Description
status	query	string[]	No	The status of the jobs to return
size	query	number	No
created_after	query	string (date-time)	No
sort_pending_first	query	boolean	No
scope	query	"me" | "all"	No

Sample Call

epilot entity getTaxonomyBulkActionJobs

With JSONata filter:

epilot entity getTaxonomyBulkActionJobs --jsonata '$'

Sample Response

[
  {
    "job_id": "123e4567-e89b-12d3-a456-426614174000",
    "status": "PENDING",
    "action_type": "MOVE_CLASSIFICATIONS",
    "created_by": "10598",
    "created_at": "2024-01-01T00:00:00.000Z",
    "updated_at": "2024-01-01T00:00:00.000Z",
    "org": "66"
  }
]

---

getTaxonomyBulkActionJobById

Gets a bulk action job by job id

GET /v1/entity/taxonomies/bulk-jobs/{job_id}

Parameters

Name	In	Type	Required	Description
job_id	path	string	Yes

Sample Call

epilot entity getTaxonomyBulkActionJobById \
  -p job_id=123e4567-e89b-12d3-a456-426614174000

Using positional args for path parameters:

epilot entity getTaxonomyBulkActionJobById 123e4567-e89b-12d3-a456-426614174000

With JSONata filter:

epilot entity getTaxonomyBulkActionJobById -p job_id=123e4567-e89b-12d3-a456-426614174000 --jsonata 'job_id'

Sample Response

{
  "job_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "PENDING",
  "action_type": "MOVE_CLASSIFICATIONS",
  "created_by": "10598",
  "created_at": "2024-01-01T00:00:00.000Z",
  "updated_at": "2024-01-01T00:00:00.000Z",
  "org": "66"
}

---

cancelBulkAction

Cancels a running bulk action job. The job status will be updated to CANCELLED

POST /v1/entity/taxonomies/bulk-jobs/{job_id}/cancel

Parameters

Name	In	Type	Required	Description
job_id	path	string	Yes	Job ID of the bulk operation to cancel

Sample Call

epilot entity cancelBulkAction \
  -p job_id=123e4567-e89b-12d3-a456-426614174000

Using positional args for path parameters:

epilot entity cancelBulkAction 123e4567-e89b-12d3-a456-426614174000

With JSONata filter:

epilot entity cancelBulkAction -p job_id=123e4567-e89b-12d3-a456-426614174000 --jsonata 'job_id'

Sample Response

{
  "job_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "PENDING",
  "action_type": "MOVE_CLASSIFICATIONS",
  "created_by": "10598",
  "created_at": "2024-01-01T00:00:00.000Z",
  "updated_at": "2024-01-01T00:00:00.000Z",
  "org": "66"
}

---

bulkMoveClassifications

Moves classifications from one taxonomy to another, through a bulk async operation which

POST /v1/entity/taxonomies/classifications:move

Request Body

Sample Call

epilot entity bulkMoveClassifications \
  -d '{"job_id":"string","target_taxonomy":"purpose","classification_ids":["taxonomy-slug:classification-slug"]}'

Using stdin pipe:

cat body.json | epilot entity bulkMoveClassifications

With JSONata filter:

epilot entity bulkMoveClassifications --jsonata 'job_id'

Sample Response

{
  "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "PENDING"
}

---

bulkMergeClassifications

Merges classifications from one taxonomy into one individual classification, through a bulk async operation which

POST /v1/entity/taxonomies/classifications:merge

Request Body

Sample Call

epilot entity bulkMergeClassifications \
  -d '{"job_id":"string","target_classification":"purpose","classification_ids":["taxonomy-slug:classification-slug"]}'

Using stdin pipe:

cat body.json | epilot entity bulkMergeClassifications

With JSONata filter:

epilot entity bulkMergeClassifications --jsonata 'job_id'

Sample Response

{
  "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "PENDING"
}

---

bulkDeleteClassifications

Permanently deletes taxonomy classifications. The classifications are deleted through a bulk

POST /v1/entity/taxonomies/classifications:delete

Request Body

Sample Call

epilot entity bulkDeleteClassifications \
  -d '{"job_id":"string","classification_ids":["taxonomy-slug:classification-slug"]}'

Using stdin pipe:

cat body.json | epilot entity bulkDeleteClassifications

With JSONata filter:

epilot entity bulkDeleteClassifications --jsonata 'job_id'

Sample Response

{
  "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "PENDING"
}

---

createSchemaAttribute

Create a schema attribute

POST /v1/entity/schemas/attributes

Request Body

Sample Call

epilot entity createSchemaAttribute

With request body:

epilot entity createSchemaAttribute \
  -d '{
  "id": "d5839b94-ba20-4225-a78e-76951d352bd6",
  "name": "string",
  "label": "string",
  "placeholder": "string",
  "hidden": false,
  "show_in_table": true,
  "sortable": true,
  "required": false,
  "readonly": false,
  "deprecated": false,
  "default_value": {},
  "group": "string",
  "order": 0,
  "layout": "full_width",
  "hide_label": true,
  "icon": "string",
  "render_condition": "string",
  "_purpose": ["taxonomy-slug:classification-slug"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
  "constraints": {
    "disablePast": true
  },
  "feature_flag": "FF_MY_FEATURE_FLAG",
  "settings_flag": [
    {
      "name": "string",
      "enabled": true
    }
  ],
  "value_formatter": "string",
  "preview_value_formatter": "string",
  "entity_builder_disable_edit": false,
  "protected": true,
  "info_helpers": {
    "hint_text": "string",
    "hint_text_key": "string",
    "hint_custom_component": "string",
    "hint_tooltip_placement": "top"
  },
  "explicit_searchable": false,
  "exclude_from_search": false,
  "repeatable": true,
  "has_primary": true,
  "type": "string",
  "multiline": true,
  "rich_text": true,
  "rows": 3
}'

Using stdin pipe:

cat body.json | epilot entity createSchemaAttribute

With JSONata filter:

epilot entity createSchemaAttribute --jsonata '$'

Sample Response

{
  "id": "d5839b94-ba20-4225-a78e-76951d352bd6",
  "name": "string",
  "label": "string",
  "placeholder": "string",
  "hidden": false,
  "show_in_table": true,
  "sortable": true,
  "required": false,
  "readonly": false,
  "deprecated": false,
  "default_value": {},
  "group": "string",
  "order": 0,
  "layout": "full_width",
  "hide_label": true,
  "icon": "string",
  "render_condition": "string",
  "_purpose": ["taxonomy-slug:classification-slug"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
  "constraints": {
    "disablePast": true
  },
  "feature_flag": "FF_MY_FEATURE_FLAG",
  "settings_flag": [
    {
      "name": "string",
      "enabled": true
    }
  ],
  "value_formatter": "string",
  "preview_value_formatter": "string",
  "entity_builder_disable_edit": false,
  "protected": true,
  "info_helpers": {
    "hint_text": "string",
    "hint_text_key": "string",
    "hint_custom_component": "string",
    "hint_tooltip_placement": "top"
  },
  "explicit_searchable": false,
  "exclude_from_search": false,
  "repeatable": true,
  "has_primary": true,
  "type": "string",
  "multiline": true,
  "rich_text": true,
  "rows": 3
}

---

getSchemaAttribute

Get a schema attribute from given attribute ID

GET /v1/entity/schemas/attributes/{composite_id}

Parameters

Name	In	Type	Required	Description
composite_id	path	string	Yes	Schema Slug and the Attribute ID

Sample Call

epilot entity getSchemaAttribute \
  -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d

Using positional args for path parameters:

epilot entity getSchemaAttribute contact:97644baa-083f-4e49-9188-fcff2ecaad7d

With JSONata filter:

epilot entity getSchemaAttribute -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d --jsonata '$'

Sample Response

{
  "id": "d5839b94-ba20-4225-a78e-76951d352bd6",
  "name": "string",
  "label": "string",
  "placeholder": "string",
  "hidden": false,
  "show_in_table": true,
  "sortable": true,
  "required": false,
  "readonly": false,
  "deprecated": false,
  "default_value": {},
  "group": "string",
  "order": 0,
  "layout": "full_width",
  "hide_label": true,
  "icon": "string",
  "render_condition": "string",
  "_purpose": ["taxonomy-slug:classification-slug"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
  "constraints": {
    "disablePast": true
  },
  "feature_flag": "FF_MY_FEATURE_FLAG",
  "settings_flag": [
    {
      "name": "string",
      "enabled": true
    }
  ],
  "value_formatter": "string",
  "preview_value_formatter": "string",
  "entity_builder_disable_edit": false,
  "protected": true,
  "info_helpers": {
    "hint_text": "string",
    "hint_text_key": "string",
    "hint_custom_component": "string",
    "hint_tooltip_placement": "top"
  },
  "explicit_searchable": false,
  "exclude_from_search": false,
  "repeatable": true,
  "has_primary": true,
  "type": "string",
  "multiline": true,
  "rich_text": true,
  "rows": 3
}

---

putSchemaAttribute

Updates an attribute in the schema

PUT /v1/entity/schemas/attributes/{composite_id}

Parameters

Name	In	Type	Required	Description
composite_id	path	string	Yes	Schema Slug and the Attribute ID

Request Body

Sample Call

epilot entity putSchemaAttribute \
  -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d

With request body:

epilot entity putSchemaAttribute \
  -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d \
  -d '{
  "id": "d5839b94-ba20-4225-a78e-76951d352bd6",
  "name": "string",
  "label": "string",
  "placeholder": "string",
  "hidden": false,
  "show_in_table": true,
  "sortable": true,
  "required": false,
  "readonly": false,
  "deprecated": false,
  "default_value": {},
  "group": "string",
  "order": 0,
  "layout": "full_width",
  "hide_label": true,
  "icon": "string",
  "render_condition": "string",
  "_purpose": ["taxonomy-slug:classification-slug"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
  "constraints": {
    "disablePast": true
  },
  "feature_flag": "FF_MY_FEATURE_FLAG",
  "settings_flag": [
    {
      "name": "string",
      "enabled": true
    }
  ],
  "value_formatter": "string",
  "preview_value_formatter": "string",
  "entity_builder_disable_edit": false,
  "protected": true,
  "info_helpers": {
    "hint_text": "string",
    "hint_text_key": "string",
    "hint_custom_component": "string",
    "hint_tooltip_placement": "top"
  },
  "explicit_searchable": false,
  "exclude_from_search": false,
  "repeatable": true,
  "has_primary": true,
  "type": "string",
  "multiline": true,
  "rich_text": true,
  "rows": 3
}'

Using positional args for path parameters:

epilot entity putSchemaAttribute contact:97644baa-083f-4e49-9188-fcff2ecaad7d

Using stdin pipe:

cat body.json | epilot entity putSchemaAttribute -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d

With JSONata filter:

epilot entity putSchemaAttribute -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d --jsonata '$'

Sample Response

{
  "id": "d5839b94-ba20-4225-a78e-76951d352bd6",
  "name": "string",
  "label": "string",
  "placeholder": "string",
  "hidden": false,
  "show_in_table": true,
  "sortable": true,
  "required": false,
  "readonly": false,
  "deprecated": false,
  "default_value": {},
  "group": "string",
  "order": 0,
  "layout": "full_width",
  "hide_label": true,
  "icon": "string",
  "render_condition": "string",
  "_purpose": ["taxonomy-slug:classification-slug"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
  "constraints": {
    "disablePast": true
  },
  "feature_flag": "FF_MY_FEATURE_FLAG",
  "settings_flag": [
    {
      "name": "string",
      "enabled": true
    }
  ],
  "value_formatter": "string",
  "preview_value_formatter": "string",
  "entity_builder_disable_edit": false,
  "protected": true,
  "info_helpers": {
    "hint_text": "string",
    "hint_text_key": "string",
    "hint_custom_component": "string",
    "hint_tooltip_placement": "top"
  },
  "explicit_searchable": false,
  "exclude_from_search": false,
  "repeatable": true,
  "has_primary": true,
  "type": "string",
  "multiline": true,
  "rich_text": true,
  "rows": 3
}

---

deleteSchemaAttribute

Deletes an attribute from a schema

DELETE /v1/entity/schemas/attributes/{composite_id}

Parameters

Name	In	Type	Required	Description
composite_id	path	string	Yes	Schema Slug and the Attribute ID

Sample Call

epilot entity deleteSchemaAttribute \
  -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d

Using positional args for path parameters:

epilot entity deleteSchemaAttribute contact:97644baa-083f-4e49-9188-fcff2ecaad7d

With JSONata filter:

epilot entity deleteSchemaAttribute -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d --jsonata '$'

Sample Response

{
  "id": "d5839b94-ba20-4225-a78e-76951d352bd6",
  "name": "string",
  "label": "string",
  "placeholder": "string",
  "hidden": false,
  "show_in_table": true,
  "sortable": true,
  "required": false,
  "readonly": false,
  "deprecated": false,
  "default_value": {},
  "group": "string",
  "order": 0,
  "layout": "full_width",
  "hide_label": true,
  "icon": "string",
  "render_condition": "string",
  "_purpose": ["taxonomy-slug:classification-slug"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
  "constraints": {
    "disablePast": true
  },
  "feature_flag": "FF_MY_FEATURE_FLAG",
  "settings_flag": [
    {
      "name": "string",
      "enabled": true
    }
  ],
  "value_formatter": "string",
  "preview_value_formatter": "string",
  "entity_builder_disable_edit": false,
  "protected": true,
  "info_helpers": {
    "hint_text": "string",
    "hint_text_key": "string",
    "hint_custom_component": "string",
    "hint_tooltip_placement": "top"
  },
  "explicit_searchable": false,
  "exclude_from_search": false,
  "repeatable": true,
  "has_primary": true,
  "type": "string",
  "multiline": true,
  "rich_text": true,
  "rows": 3
}

---

createSchemaCapability

Create a schema capability

POST /v1/entity/schemas/capabilities

Request Body

Sample Call

epilot entity createSchemaCapability

With request body:

epilot entity createSchemaCapability \
  -d '{
  "id": "d5839b94-ba20-4225-a78e-76951d352bd6",
  "name": "customer_messaging",
  "title": "Messaging",
  "attributes": [
    {
      "id": "d5839b94-ba20-4225-a78e-76951d352bd6",
      "name": "string",
      "label": "string",
      "placeholder": "string",
      "hidden": false,
      "show_in_table": true,
      "sortable": true,
      "required": false,
      "readonly": false,
      "deprecated": false,
      "default_value": {},
      "group": "string",
      "order": 0,
      "layout": "full_width",
      "hide_label": true,
      "icon": "string",
      "render_condition": "string",
      "_purpose": ["taxonomy-slug:classification-slug"],
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
      "constraints": {},
      "feature_flag": "FF_MY_FEATURE_FLAG",
      "settings_flag": [],
      "value_formatter": "string",
      "preview_value_formatter": "string",
      "entity_builder_disable_edit": false,
      "protected": true,
      "info_helpers": {},
      "explicit_searchable": false,
      "exclude_from_search": false,
      "repeatable": true,
      "has_primary": true,
      "type": "string",
      "multiline": true,
      "rich_text": true,
      "rows": 3
    },
    {
      "id": "d5839b94-ba20-4225-a78e-76951d352bd6",
      "name": "string",
      "label": "string",
      "placeholder": "string",
      "hidden": false,
      "show_in_table": true,
      "sortable": true,
      "required": false,
      "readonly": false,
      "deprecated": false,
      "default_value": {},
      "group": "string",
      "order": 0,
      "layout": "full_width",
      "hide_label": true,
      "icon": "string",
      "render_condition": "string",
      "_purpose": ["taxonomy-slug:classification-slug"],
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
      "constraints": {},
      "feature_flag": "FF_MY_FEATURE_FLAG",
      "settings_flag": [],
      "value_formatter": "string",
      "preview_value_formatter": "string",
      "entity_builder_disable_edit": false,
      "protected": true,
      "info_helpers": {},
      "explicit_searchable": false,
      "exclude_from_search": false,
      "repeatable": true,
      "has_primary": true,
      "type": "link"
    }
  ],
  "_purpose": ["taxonomy-slug:classification-slug"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
  "app_id": "123e4567-e89b-12d3-a456-426614174000",
  "ui_config": {
    "is_filterable": true
  },
  "ui_hooks": [
    {
      "hook": "EntityDetailsV2:Tab",
      "render_condition": "_is_composite_price = \"false\"",
      "order": 10,
      "title": "Notes",
      "group_expanded": true,
      "import": "@epilot360/notes",
      "component": "PricingItems",
      "route": "notes",
      "icon": "email",
      "disabled": true,
      "header": true,
      "requiredPermission": {}
    }
  ],
  "feature_flag": "FF_MY_FEATURE_FLAG",
  "settings_flag": [
    {
      "name": "string",
      "enabled": true
    }
  ],
  "composite_id": "contact:97644baa-083f-4e49-9188-fcff2ecaad7d",
  "schema": "contact"
}'

Using stdin pipe:

cat body.json | epilot entity createSchemaCapability

With JSONata filter:

epilot entity createSchemaCapability --jsonata '$'

Sample Response

{
  "id": "d5839b94-ba20-4225-a78e-76951d352bd6",
  "name": "customer_messaging",
  "title": "Messaging",
  "attributes": [
    {
      "id": "d5839b94-ba20-4225-a78e-76951d352bd6",
      "name": "string",
      "label": "string",
      "placeholder": "string",
      "hidden": false,
      "show_in_table": true,
      "sortable": true,
      "required": false,
      "readonly": false,
      "deprecated": false,
      "default_value": {},
      "group": "string",
      "order": 0,
      "layout": "full_width",
      "hide_label": true,
      "icon": "string",
      "render_condition": "string",
      "_purpose": ["taxonomy-slug:classification-slug"],
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
      "constraints": {},
      "feature_flag": "FF_MY_FEATURE_FLAG",
      "settings_flag": [],
      "value_formatter": "string",
      "preview_value_formatter": "string",
      "entity_builder_disable_edit": false,
      "protected": true,
      "info_helpers": {},
      "explicit_searchable": false,
      "exclude_from_search": false,
      "repeatable": true,
      "has_primary": true,
      "type": "string",
      "multiline": true,
      "rich_text": true,
      "rows": 3
    },
    {
      "id": "d5839b94-ba20-4225-a78e-76951d352bd6",
      "name": "string",
      "label": "string",
      "placeholder": "string",
      "hidden": false,
      "show_in_table": true,
      "sortable": true,
      "required": false,
      "readonly": false,
      "deprecated": false,
      "default_value": {},
      "group": "string",
      "order": 0,
      "layout": "full_width",
      "hide_label": true,
      "icon": "string",
      "render_condition": "string",
      "_purpose": ["taxonomy-slug:classification-slug"],
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
      "constraints": {},
      "feature_flag": "FF_MY_FEATURE_FLAG",
      "settings_flag": [],
      "value_formatter": "string",
      "preview_value_formatter": "string",
      "entity_builder_disable_edit": false,
      "protected": true,
      "info_helpers": {},
      "explicit_searchable": false,
      "exclude_from_search": false,
      "repeatable": true,
      "has_primary": true,
      "type": "link"
    }
  ],
  "_purpose": ["taxonomy-slug:classification-slug"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
  "app_id": "123e4567-e89b-12d3-a456-426614174000",
  "ui_config": {
    "is_filterable": true
  },
  "ui_hooks": [
    {
      "hook": "EntityDetailsV2:Tab",
      "render_condition": "_is_composite_price = \"false\"",
      "order": 10,
      "title": "Notes",
      "group_expanded": true,
      "import": "@epilot360/notes",
      "component": "PricingItems",
      "route": "notes",
      "icon": "email",
      "disabled": true,
      "header": true,
      "requiredPermission": {}
    }
  ],
  "feature_flag": "FF_MY_FEATURE_FLAG",
  "settings_flag": [
    {
      "name": "string",
      "enabled": true
    }
  ],
  "composite_id": "contact:97644baa-083f-4e49-9188-fcff2ecaad7d",
  "schema": "contact"
}

---

getSchemaCapability

Get a schema capability from given capability ID

GET /v1/entity/schemas/capabilities/{composite_id}

Parameters

Name	In	Type	Required	Description
composite_id	path	string	Yes	Schema Slug and the Attribute ID

Sample Call

epilot entity getSchemaCapability \
  -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d

Using positional args for path parameters:

epilot entity getSchemaCapability contact:97644baa-083f-4e49-9188-fcff2ecaad7d

With JSONata filter:

epilot entity getSchemaCapability -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d --jsonata '$'

Sample Response

{
  "id": "d5839b94-ba20-4225-a78e-76951d352bd6",
  "name": "customer_messaging",
  "title": "Messaging",
  "attributes": [
    {
      "id": "d5839b94-ba20-4225-a78e-76951d352bd6",
      "name": "string",
      "label": "string",
      "placeholder": "string",
      "hidden": false,
      "show_in_table": true,
      "sortable": true,
      "required": false,
      "readonly": false,
      "deprecated": false,
      "default_value": {},
      "group": "string",
      "order": 0,
      "layout": "full_width",
      "hide_label": true,
      "icon": "string",
      "render_condition": "string",
      "_purpose": ["taxonomy-slug:classification-slug"],
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
      "constraints": {},
      "feature_flag": "FF_MY_FEATURE_FLAG",
      "settings_flag": [],
      "value_formatter": "string",
      "preview_value_formatter": "string",
      "entity_builder_disable_edit": false,
      "protected": true,
      "info_helpers": {},
      "explicit_searchable": false,
      "exclude_from_search": false,
      "repeatable": true,
      "has_primary": true,
      "type": "string",
      "multiline": true,
      "rich_text": true,
      "rows": 3
    },
    {
      "id": "d5839b94-ba20-4225-a78e-76951d352bd6",
      "name": "string",
      "label": "string",
      "placeholder": "string",
      "hidden": false,
      "show_in_table": true,
      "sortable": true,
      "required": false,
      "readonly": false,
      "deprecated": false,
      "default_value": {},
      "group": "string",
      "order": 0,
      "layout": "full_width",
      "hide_label": true,
      "icon": "string",
      "render_condition": "string",
      "_purpose": ["taxonomy-slug:classification-slug"],
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
      "constraints": {},
      "feature_flag": "FF_MY_FEATURE_FLAG",
      "settings_flag": [],
      "value_formatter": "string",
      "preview_value_formatter": "string",
      "entity_builder_disable_edit": false,
      "protected": true,
      "info_helpers": {},
      "explicit_searchable": false,
      "exclude_from_search": false,
      "repeatable": true,
      "has_primary": true,
      "type": "link"
    }
  ],
  "_purpose": ["taxonomy-slug:classification-slug"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
  "app_id": "123e4567-e89b-12d3-a456-426614174000",
  "ui_config": {
    "is_filterable": true
  },
  "ui_hooks": [
    {
      "hook": "EntityDetailsV2:Tab",
      "render_condition": "_is_composite_price = \"false\"",
      "order": 10,
      "title": "Notes",
      "group_expanded": true,
      "import": "@epilot360/notes",
      "component": "PricingItems",
      "route": "notes",
      "icon": "email",
      "disabled": true,
      "header": true,
      "requiredPermission": {}
    }
  ],
  "feature_flag": "FF_MY_FEATURE_FLAG",
  "settings_flag": [
    {
      "name": "string",
      "enabled": true
    }
  ],
  "composite_id": "contact:97644baa-083f-4e49-9188-fcff2ecaad7d",
  "schema": "contact"
}

---

putSchemaCapability

Adds or updates an capability in the schema

PUT /v1/entity/schemas/capabilities/{composite_id}

Parameters

Name	In	Type	Required	Description
composite_id	path	string	Yes	Schema Slug and the Attribute ID

Request Body

Sample Call

epilot entity putSchemaCapability \
  -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d

With request body:

epilot entity putSchemaCapability \
  -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d \
  -d '{
  "id": "d5839b94-ba20-4225-a78e-76951d352bd6",
  "name": "customer_messaging",
  "title": "Messaging",
  "attributes": [
    {
      "id": "d5839b94-ba20-4225-a78e-76951d352bd6",
      "name": "string",
      "label": "string",
      "placeholder": "string",
      "hidden": false,
      "show_in_table": true,
      "sortable": true,
      "required": false,
      "readonly": false,
      "deprecated": false,
      "default_value": {},
      "group": "string",
      "order": 0,
      "layout": "full_width",
      "hide_label": true,
      "icon": "string",
      "render_condition": "string",
      "_purpose": ["taxonomy-slug:classification-slug"],
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
      "constraints": {},
      "feature_flag": "FF_MY_FEATURE_FLAG",
      "settings_flag": [],
      "value_formatter": "string",
      "preview_value_formatter": "string",
      "entity_builder_disable_edit": false,
      "protected": true,
      "info_helpers": {},
      "explicit_searchable": false,
      "exclude_from_search": false,
      "repeatable": true,
      "has_primary": true,
      "type": "string",
      "multiline": true,
      "rich_text": true,
      "rows": 3
    },
    {
      "id": "d5839b94-ba20-4225-a78e-76951d352bd6",
      "name": "string",
      "label": "string",
      "placeholder": "string",
      "hidden": false,
      "show_in_table": true,
      "sortable": true,
      "required": false,
      "readonly": false,
      "deprecated": false,
      "default_value": {},
      "group": "string",
      "order": 0,
      "layout": "full_width",
      "hide_label": true,
      "icon": "string",
      "render_condition": "string",
      "_purpose": ["taxonomy-slug:classification-slug"],
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
      "constraints": {},
      "feature_flag": "FF_MY_FEATURE_FLAG",
      "settings_flag": [],
      "value_formatter": "string",
      "preview_value_formatter": "string",
      "entity_builder_disable_edit": false,
      "protected": true,
      "info_helpers": {},
      "explicit_searchable": false,
      "exclude_from_search": false,
      "repeatable": true,
      "has_primary": true,
      "type": "link"
    }
  ],
  "_purpose": ["taxonomy-slug:classification-slug"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
  "app_id": "123e4567-e89b-12d3-a456-426614174000",
  "ui_config": {
    "is_filterable": true
  },
  "ui_hooks": [
    {
      "hook": "EntityDetailsV2:Tab",
      "render_condition": "_is_composite_price = \"false\"",
      "order": 10,
      "title": "Notes",
      "group_expanded": true,
      "import": "@epilot360/notes",
      "component": "PricingItems",
      "route": "notes",
      "icon": "email",
      "disabled": true,
      "header": true,
      "requiredPermission": {}
    }
  ],
  "feature_flag": "FF_MY_FEATURE_FLAG",
  "settings_flag": [
    {
      "name": "string",
      "enabled": true
    }
  ],
  "composite_id": "contact:97644baa-083f-4e49-9188-fcff2ecaad7d",
  "schema": "contact"
}'

Using positional args for path parameters:

epilot entity putSchemaCapability contact:97644baa-083f-4e49-9188-fcff2ecaad7d

Using stdin pipe:

cat body.json | epilot entity putSchemaCapability -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d

With JSONata filter:

epilot entity putSchemaCapability -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d --jsonata '$'

Sample Response

{
  "id": "d5839b94-ba20-4225-a78e-76951d352bd6",
  "name": "customer_messaging",
  "title": "Messaging",
  "attributes": [
    {
      "id": "d5839b94-ba20-4225-a78e-76951d352bd6",
      "name": "string",
      "label": "string",
      "placeholder": "string",
      "hidden": false,
      "show_in_table": true,
      "sortable": true,
      "required": false,
      "readonly": false,
      "deprecated": false,
      "default_value": {},
      "group": "string",
      "order": 0,
      "layout": "full_width",
      "hide_label": true,
      "icon": "string",
      "render_condition": "string",
      "_purpose": ["taxonomy-slug:classification-slug"],
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
      "constraints": {},
      "feature_flag": "FF_MY_FEATURE_FLAG",
      "settings_flag": [],
      "value_formatter": "string",
      "preview_value_formatter": "string",
      "entity_builder_disable_edit": false,
      "protected": true,
      "info_helpers": {},
      "explicit_searchable": false,
      "exclude_from_search": false,
      "repeatable": true,
      "has_primary": true,
      "type": "string",
      "multiline": true,
      "rich_text": true,
      "rows": 3
    },
    {
      "id": "d5839b94-ba20-4225-a78e-76951d352bd6",
      "name": "string",
      "label": "string",
      "placeholder": "string",
      "hidden": false,
      "show_in_table": true,
      "sortable": true,
      "required": false,
      "readonly": false,
      "deprecated": false,
      "default_value": {},
      "group": "string",
      "order": 0,
      "layout": "full_width",
      "hide_label": true,
      "icon": "string",
      "render_condition": "string",
      "_purpose": ["taxonomy-slug:classification-slug"],
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
      "constraints": {},
      "feature_flag": "FF_MY_FEATURE_FLAG",
      "settings_flag": [],
      "value_formatter": "string",
      "preview_value_formatter": "string",
      "entity_builder_disable_edit": false,
      "protected": true,
      "info_helpers": {},
      "explicit_searchable": false,
      "exclude_from_search": false,
      "repeatable": true,
      "has_primary": true,
      "type": "link"
    }
  ],
  "_purpose": ["taxonomy-slug:classification-slug"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
  "app_id": "123e4567-e89b-12d3-a456-426614174000",
  "ui_config": {
    "is_filterable": true
  },
  "ui_hooks": [
    {
      "hook": "EntityDetailsV2:Tab",
      "render_condition": "_is_composite_price = \"false\"",
      "order": 10,
      "title": "Notes",
      "group_expanded": true,
      "import": "@epilot360/notes",
      "component": "PricingItems",
      "route": "notes",
      "icon": "email",
      "disabled": true,
      "header": true,
      "requiredPermission": {}
    }
  ],
  "feature_flag": "FF_MY_FEATURE_FLAG",
  "settings_flag": [
    {
      "name": "string",
      "enabled": true
    }
  ],
  "composite_id": "contact:97644baa-083f-4e49-9188-fcff2ecaad7d",
  "schema": "contact"
}

---

deleteSchemaCapability

Deletes a Capability from a schema

DELETE /v1/entity/schemas/capabilities/{composite_id}

Parameters

Name	In	Type	Required	Description
composite_id	path	string	Yes	Schema Slug and the Attribute ID

Sample Call

epilot entity deleteSchemaCapability \
  -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d

Using positional args for path parameters:

epilot entity deleteSchemaCapability contact:97644baa-083f-4e49-9188-fcff2ecaad7d

With JSONata filter:

epilot entity deleteSchemaCapability -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d --jsonata '$'

Sample Response

{
  "id": "d5839b94-ba20-4225-a78e-76951d352bd6",
  "name": "customer_messaging",
  "title": "Messaging",
  "attributes": [
    {
      "id": "d5839b94-ba20-4225-a78e-76951d352bd6",
      "name": "string",
      "label": "string",
      "placeholder": "string",
      "hidden": false,
      "show_in_table": true,
      "sortable": true,
      "required": false,
      "readonly": false,
      "deprecated": false,
      "default_value": {},
      "group": "string",
      "order": 0,
      "layout": "full_width",
      "hide_label": true,
      "icon": "string",
      "render_condition": "string",
      "_purpose": ["taxonomy-slug:classification-slug"],
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
      "constraints": {},
      "feature_flag": "FF_MY_FEATURE_FLAG",
      "settings_flag": [],
      "value_formatter": "string",
      "preview_value_formatter": "string",
      "entity_builder_disable_edit": false,
      "protected": true,
      "info_helpers": {},
      "explicit_searchable": false,
      "exclude_from_search": false,
      "repeatable": true,
      "has_primary": true,
      "type": "string",
      "multiline": true,
      "rich_text": true,
      "rows": 3
    },
    {
      "id": "d5839b94-ba20-4225-a78e-76951d352bd6",
      "name": "string",
      "label": "string",
      "placeholder": "string",
      "hidden": false,
      "show_in_table": true,
      "sortable": true,
      "required": false,
      "readonly": false,
      "deprecated": false,
      "default_value": {},
      "group": "string",
      "order": 0,
      "layout": "full_width",
      "hide_label": true,
      "icon": "string",
      "render_condition": "string",
      "_purpose": ["taxonomy-slug:classification-slug"],
      "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
      "constraints": {},
      "feature_flag": "FF_MY_FEATURE_FLAG",
      "settings_flag": [],
      "value_formatter": "string",
      "preview_value_formatter": "string",
      "entity_builder_disable_edit": false,
      "protected": true,
      "info_helpers": {},
      "explicit_searchable": false,
      "exclude_from_search": false,
      "repeatable": true,
      "has_primary": true,
      "type": "link"
    }
  ],
  "_purpose": ["taxonomy-slug:classification-slug"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
  "app_id": "123e4567-e89b-12d3-a456-426614174000",
  "ui_config": {
    "is_filterable": true
  },
  "ui_hooks": [
    {
      "hook": "EntityDetailsV2:Tab",
      "render_condition": "_is_composite_price = \"false\"",
      "order": 10,
      "title": "Notes",
      "group_expanded": true,
      "import": "@epilot360/notes",
      "component": "PricingItems",
      "route": "notes",
      "icon": "email",
      "disabled": true,
      "header": true,
      "requiredPermission": {}
    }
  ],
  "feature_flag": "FF_MY_FEATURE_FLAG",
  "settings_flag": [
    {
      "name": "string",
      "enabled": true
    }
  ],
  "composite_id": "contact:97644baa-083f-4e49-9188-fcff2ecaad7d",
  "schema": "contact"
}

---

createSchemaGroup

Create a schema group

POST /v1/entity/schemas/group

Request Body

Sample Call

epilot entity createSchemaGroup

With request body:

epilot entity createSchemaGroup \
  -d '{
  "label": "Contact Details",
  "id": "e18a532b-ae79-4d86-a6a5-e5dbfb579d14",
  "order": 0,
  "expanded": false,
  "render_condition": "_is_composite_price = \"false\"",
  "_purpose": ["taxonomy-slug:classification-slug"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
  "feature_flag": "FF_MY_FEATURE_FLAG",
  "settings_flag": [
    {
      "name": "string",
      "enabled": true
    }
  ],
  "info_tooltip_title": {
    "key": "string",
    "default": "string"
  },
  "composite_id": "contact:e18a532b-ae79-4d86-a6a5-e5dbfb579d14",
  "schema": "contact"
}'

Using stdin pipe:

cat body.json | epilot entity createSchemaGroup

With JSONata filter:

epilot entity createSchemaGroup --jsonata '$'

Sample Response

{
  "label": "Contact Details",
  "id": "e18a532b-ae79-4d86-a6a5-e5dbfb579d14",
  "order": 0,
  "expanded": false,
  "render_condition": "_is_composite_price = \"false\"",
  "_purpose": ["taxonomy-slug:classification-slug"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
  "feature_flag": "FF_MY_FEATURE_FLAG",
  "settings_flag": [
    {
      "name": "string",
      "enabled": true
    }
  ],
  "info_tooltip_title": {
    "key": "string",
    "default": "string"
  },
  "composite_id": "contact:e18a532b-ae79-4d86-a6a5-e5dbfb579d14",
  "schema": "contact"
}

---

getSchemaGroup

Get a schema group from given group composite ID

GET /v1/entity/schemas/group/{composite_id}

Parameters

Name	In	Type	Required	Description
composite_id	path	string	Yes	Schema Slug and the Group ID

Sample Call

epilot entity getSchemaGroup \
  -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d

Using positional args for path parameters:

epilot entity getSchemaGroup contact:97644baa-083f-4e49-9188-fcff2ecaad7d

With JSONata filter:

epilot entity getSchemaGroup -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d --jsonata '$'

Sample Response

{
  "label": "Contact Details",
  "id": "e18a532b-ae79-4d86-a6a5-e5dbfb579d14",
  "order": 0,
  "expanded": false,
  "render_condition": "_is_composite_price = \"false\"",
  "_purpose": ["taxonomy-slug:classification-slug"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
  "feature_flag": "FF_MY_FEATURE_FLAG",
  "settings_flag": [
    {
      "name": "string",
      "enabled": true
    }
  ],
  "info_tooltip_title": {
    "key": "string",
    "default": "string"
  },
  "composite_id": "contact:e18a532b-ae79-4d86-a6a5-e5dbfb579d14",
  "schema": "contact"
}

---

putSchemaGroup

Adds or updates an capability in the schema

PUT /v1/entity/schemas/group/{composite_id}

Parameters

Name	In	Type	Required	Description
composite_id	path	string	Yes	Schema Slug and the Group ID

Request Body

Sample Call

epilot entity putSchemaGroup \
  -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d

With request body:

epilot entity putSchemaGroup \
  -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d \
  -d '{
  "label": "Contact Details",
  "id": "e18a532b-ae79-4d86-a6a5-e5dbfb579d14",
  "order": 0,
  "expanded": false,
  "render_condition": "_is_composite_price = \"false\"",
  "_purpose": ["taxonomy-slug:classification-slug"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
  "feature_flag": "FF_MY_FEATURE_FLAG",
  "settings_flag": [
    {
      "name": "string",
      "enabled": true
    }
  ],
  "info_tooltip_title": {
    "key": "string",
    "default": "string"
  },
  "composite_id": "contact:e18a532b-ae79-4d86-a6a5-e5dbfb579d14",
  "schema": "contact"
}'

Using positional args for path parameters:

epilot entity putSchemaGroup contact:97644baa-083f-4e49-9188-fcff2ecaad7d

Using stdin pipe:

cat body.json | epilot entity putSchemaGroup -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d

With JSONata filter:

epilot entity putSchemaGroup -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d --jsonata '$'

Sample Response

{
  "label": "Contact Details",
  "id": "e18a532b-ae79-4d86-a6a5-e5dbfb579d14",
  "order": 0,
  "expanded": false,
  "render_condition": "_is_composite_price = \"false\"",
  "_purpose": ["taxonomy-slug:classification-slug"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
  "feature_flag": "FF_MY_FEATURE_FLAG",
  "settings_flag": [
    {
      "name": "string",
      "enabled": true
    }
  ],
  "info_tooltip_title": {
    "key": "string",
    "default": "string"
  },
  "composite_id": "contact:e18a532b-ae79-4d86-a6a5-e5dbfb579d14",
  "schema": "contact"
}

---

deleteSchemaGroup

Deletes a Capability from a schema

DELETE /v1/entity/schemas/group/{composite_id}

Parameters

Name	In	Type	Required	Description
composite_id	path	string	Yes	Schema Slug and the Group ID

Sample Call

epilot entity deleteSchemaGroup \
  -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d

Using positional args for path parameters:

epilot entity deleteSchemaGroup contact:97644baa-083f-4e49-9188-fcff2ecaad7d

With JSONata filter:

epilot entity deleteSchemaGroup -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d --jsonata '$'

Sample Response

{
  "label": "Contact Details",
  "id": "e18a532b-ae79-4d86-a6a5-e5dbfb579d14",
  "order": 0,
  "expanded": false,
  "render_condition": "_is_composite_price = \"false\"",
  "_purpose": ["taxonomy-slug:classification-slug"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
  "feature_flag": "FF_MY_FEATURE_FLAG",
  "settings_flag": [
    {
      "name": "string",
      "enabled": true
    }
  ],
  "info_tooltip_title": {
    "key": "string",
    "default": "string"
  },
  "composite_id": "contact:e18a532b-ae79-4d86-a6a5-e5dbfb579d14",
  "schema": "contact"
}

---

createSchemaGroupHeadline

Create a headline in a schema group

POST /v1/entity/schemas/headline

Request Body

Sample Call

epilot entity createSchemaGroupHeadline

With request body:

epilot entity createSchemaGroupHeadline \
  -d '{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "label": "string",
  "layout": "string",
  "group": "string",
  "order": 0,
  "type": "headline",
  "enable_divider": false,
  "divider": "top_divider",
  "_purpose": ["taxonomy-slug:classification-slug"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
  "composite_id": "contact:97644baa-083f-4e49-9188-fcff2ecaad7d",
  "schema": "contact"
}'

Using stdin pipe:

cat body.json | epilot entity createSchemaGroupHeadline

With JSONata filter:

epilot entity createSchemaGroupHeadline --jsonata '$'

Sample Response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "label": "string",
  "layout": "string",
  "group": "string",
  "order": 0,
  "type": "headline",
  "enable_divider": false,
  "divider": "top_divider",
  "_purpose": ["taxonomy-slug:classification-slug"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
  "composite_id": "contact:97644baa-083f-4e49-9188-fcff2ecaad7d",
  "schema": "contact"
}

---

getSchemaGroupHeadline

Get a group headline from schema from given headline composite ID

GET /v1/entity/schemas/headline/{composite_id}

Parameters

Name	In	Type	Required	Description
composite_id	path	string	Yes	Schema Slug and the Schema Group ID

Sample Call

epilot entity getSchemaGroupHeadline \
  -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d

Using positional args for path parameters:

epilot entity getSchemaGroupHeadline contact:97644baa-083f-4e49-9188-fcff2ecaad7d

With JSONata filter:

epilot entity getSchemaGroupHeadline -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d --jsonata '$'

Sample Response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "label": "string",
  "layout": "string",
  "group": "string",
  "order": 0,
  "type": "headline",
  "enable_divider": false,
  "divider": "top_divider",
  "_purpose": ["taxonomy-slug:classification-slug"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
  "composite_id": "contact:97644baa-083f-4e49-9188-fcff2ecaad7d",
  "schema": "contact"
}

---

putSchemaGroupHeadline

Adds or updates a group headline in the schema

PUT /v1/entity/schemas/headline/{composite_id}

Parameters

Name	In	Type	Required	Description
composite_id	path	string	Yes	Schema Slug and the Schema Group ID

Request Body

Sample Call

epilot entity putSchemaGroupHeadline \
  -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d

With request body:

epilot entity putSchemaGroupHeadline \
  -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d \
  -d '{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "label": "string",
  "layout": "string",
  "group": "string",
  "order": 0,
  "type": "headline",
  "enable_divider": false,
  "divider": "top_divider",
  "_purpose": ["taxonomy-slug:classification-slug"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
  "composite_id": "contact:97644baa-083f-4e49-9188-fcff2ecaad7d",
  "schema": "contact"
}'

Using positional args for path parameters:

epilot entity putSchemaGroupHeadline contact:97644baa-083f-4e49-9188-fcff2ecaad7d

Using stdin pipe:

cat body.json | epilot entity putSchemaGroupHeadline -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d

With JSONata filter:

epilot entity putSchemaGroupHeadline -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d --jsonata '$'

Sample Response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "label": "string",
  "layout": "string",
  "group": "string",
  "order": 0,
  "type": "headline",
  "enable_divider": false,
  "divider": "top_divider",
  "_purpose": ["taxonomy-slug:classification-slug"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
  "composite_id": "contact:97644baa-083f-4e49-9188-fcff2ecaad7d",
  "schema": "contact"
}

---

deleteSchemaGroupHeadline

Deletes a group headline from a schema

DELETE /v1/entity/schemas/headline/{composite_id}

Parameters

Name	In	Type	Required	Description
composite_id	path	string	Yes	Schema Slug and the Schema Group ID

Sample Call

epilot entity deleteSchemaGroupHeadline \
  -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d

Using positional args for path parameters:

epilot entity deleteSchemaGroupHeadline contact:97644baa-083f-4e49-9188-fcff2ecaad7d

With JSONata filter:

epilot entity deleteSchemaGroupHeadline -p composite_id=contact:97644baa-083f-4e49-9188-fcff2ecaad7d --jsonata '$'

Sample Response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "label": "string",
  "layout": "string",
  "group": "string",
  "order": 0,
  "type": "headline",
  "enable_divider": false,
  "divider": "top_divider",
  "_purpose": ["taxonomy-slug:classification-slug"],
  "_manifest": ["123e4567-e89b-12d3-a456-426614174000"],
  "composite_id": "contact:97644baa-083f-4e49-9188-fcff2ecaad7d",
  "schema": "contact"
}

---