Keystone Developers
Open Keystone
API reference

Internal API

Data models

2 endpoints.

GET/api/v1/internal/businesses/{business_id}/data-models

List mutable business data models (workflow catalog)

Return catalog of entity types the agent workflow may update. Validates business exists.

Parameters

NameInTypeDescription
business_idrequiredpathstring (uuid)
x-internal-api-keyheaderstring | null

Responses

200Successful Response
application/jsonSuccessResponse_DataModelCatalogData_
FieldTypeDescription
request_idrequiredstring
successtruedefault true
datarequiredDataModelCatalogData
DataModelCatalogData fields
FieldTypeDescription
business_idrequiredstring
modelsrequiredDataModelCatalogEntry[]
DataModelCatalogEntry[] fields

DataModelCatalogEntry (not expanded)

metadataResponseMetadata | null
ResponseMetadata fields
FieldTypeDescription
paginationPaginationMetadata | null
PaginationMetadata fields
FieldTypeDescription
limitrequiredinteger
next_cursorstring | null
prev_cursorstring | null
has_morerequiredboolean
has_prevbooleandefault false
total_countinteger | null
status_countsobject | null
object | null fields

Map of string to integer

lifecycle_countsLifecycleCounts | null
LifecycleCounts fields
FieldTypeDescription
leadintegerdefault 0
prospectintegerdefault 0
customerintegerdefault 0
former_customerintegerdefault 0
classification_countsClassificationCounts | null
ClassificationCounts fields
FieldTypeDescription
signalobject
object fields

Nested object (not expanded)

touchobject
object fields

Nested object (not expanded)

stageobject
object fields

Nested object (not expanded)

metaResponseMeta | null
ResponseMeta fields
FieldTypeDescription
totalinteger | null
total_countinteger | null
pageinteger | null
per_pageinteger | null
  • 400Bad request
  • 401Unauthorized
  • 403Forbidden
  • 404Not found
  • 422Validation error
  • 500Internal server error
  • 503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/internal/businesses/{business_id}/data-models/{entity}/update-schema

JSON Schema for create/update bodies of a business data entity

Return Pydantic-derived JSON Schemas for the entity's create and update bodies.

Parameters

NameInTypeDescription
business_idrequiredpathstring (uuid)
entityrequiredpathstring
x-internal-api-keyheaderstring | null

Responses

200Successful Response
application/jsonSuccessResponse_DataModelUpdateSchemaData_
FieldTypeDescription
request_idrequiredstring
successtruedefault true
datarequiredDataModelUpdateSchemaData
DataModelUpdateSchemaData fields
FieldTypeDescription
entity_idrequiredstring
display_namerequiredstring
requires_target_identifier_for_modify_deletebooleandefault false
target_identifier_hintstring | null
create_body_json_schemarequiredobject
update_body_json_schemarequiredobject
fields_summaryrequiredFieldSummaryRow[]
FieldSummaryRow[] fields

FieldSummaryRow (not expanded)

metadataResponseMetadata | null
ResponseMetadata fields

ResponseMetadata, expanded above.

metaResponseMeta | null
ResponseMeta fields

ResponseMeta, expanded above.

  • 400Bad request
  • 401Unauthorized
  • 403Forbidden
  • 404Not found
  • 422Validation error
  • 500Internal server error
  • 503Service unavailable

Error bodies: ErrorResponse. See Errors.