Voltar para Documentação da API
Entidades Personalizadas
Trabalhe com schemas e registros de entidades personalizadas. Entidades permitem modelar seus dados de negócio com campos e relacionamentos personalizados.
Endpoints (10)
GET
Listar registros da entidade
/entities/{entity_key}/recordsRetorna uma lista paginada de registros de uma entidade.
POST
Criar registro de entidade
/entities/{entity_key}/recordsCria um novo registro para uma entidade.
GET
Obter registro da entidade
/entities/{entity_key}/records/{record_id}Retorna um registro específico de entidade pelo ID.
PATCH
Atualizar registro da entidade
/entities/{entity_key}/records/{record_id}Atualiza um registro existente de entidade.
DELETE
Excluir registro da entidade
/entities/{entity_key}/records/{record_id}Exclui um registro de entidade.
GET
Listar versões da entidade
/entities/{entity_key}/versionsRetorna todas as versões de um schema de entidade.
GET
Obter versão da entidade
/entities/{entity_key}/versions/{version_id}Retorna detalhes de uma versão específica da entidade incluindo campos e layouts.
GET
Obter versão ativa da entidade
/entities/{entity_key}/versions/activeRetorna a versão atualmente ativa de uma entidade com seu schema completo.
GET
Listar schemas de entidades
/entities/schemaRetorna uma lista de todos os schemas de entidades disponíveis na sua organização.
GET
Obter schema de entidade
/entities/schema/{entity_key}Retorna detalhes de um schema de entidade específico pelo entity_key.