Projects

Download schema

Agrupa páginas, sites, funis e produtos.

Listar projetos

GET

https://automation.atomicat-api.com/api/automation/v1

/projects

Os projetos agrupam páginas, sites, funis e produtos.

Escopo exigido: projects:read.

Listar projetos › query Parameters

limit

integer · min: 1 · max: 100

Quantidade máxima de registros. O padrão é 50 e o máximo é 100.

Default: 50

page

integer · min: 0

Índice de página começando em zero. A API devolve limit registros a partir de page × limit.

Default: 0

Listar projetos › Responses

Registros correspondentes. O corpo é um array JSON.

Project[]

Project

id

string

Id do projeto.

name

string

Nome.

description

string | null

Descrição.

context

string | null

Brief da marca. Presente ao criar e atualizar.

active

boolean

false quando o projeto está inativo.

created_at

string | null

Timestamp ISO-8601.

updated_at

string | null

Timestamp ISO-8601.

Criar um projeto

POST

https://automation.atomicat-api.com/api/automation/v1

/projects

name é obrigatório. description precisa de pelo menos 50 caracteres. context precisa de pelo menos 200 caracteres. É necessário um plano pago.

Escopo exigido: projects:write.

Criar um projeto › Request Body

ProjectCreate

name

string · required

Nome do projeto.

Example: Spring campaign

description

string · minLength: 50 · required

Pelo menos 50 caracteres.

Example: Campaign assets for the spring launch across offers and traffic sources.

context

string · minLength: 200 · required

Pelo menos 200 caracteres sobre a marca e a oferta.

Example: Spring campaign sells a 6-week fitness program for busy professionals. The brand voice is direct and encouraging. The offer is a starter kit plus one coaching call. Pages should speak to people who started short workouts and quit, explain the weekly plan and the support included, and state the refund window before the call to action.

Criar um projeto › Responses

O projeto criado.

Project

id

string

Id do projeto.

name

string

Nome.

description

string | null

Descrição.

context

string | null

Brief da marca. Presente ao criar e atualizar.

active

boolean

false quando o projeto está inativo.

created_at

string | null

Timestamp ISO-8601.

updated_at

string | null

Timestamp ISO-8601.

POST/projects

curl --request POST \
  --url https://automation.atomicat-api.com/api/automation/v1/projects \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Spring campaign",
  "description": "Campaign assets for the spring launch across offers and traffic sources.",
  "context": "Spring campaign sells a 6-week fitness program for busy professionals. The brand voice is direct and encouraging. The offer is a starter kit plus one coaching call. Pages should speak to people who started short workouts and quit, explain the weekly plan and the support included, and state the refund window before the call to action."
}
'

Example Request Body

{
  "name": "Spring campaign",
  "description": "Campaign assets for the spring launch across offers and traffic sources.",
  "context": "Spring campaign sells a 6-week fitness program for busy professionals. The brand voice is direct and encouraging. The offer is a starter kit plus one coaching call. Pages should speak to people who started short workouts and quit, explain the weekly plan and the support included, and state the refund window before the call to action."
}

json

Example Responses

{
  "id": "project_123",
  "name": "Spring campaign",
  "description": "Campaign assets for the spring launch across offers and traffic sources.",
  "active": true,
  "created_at": "2026-09-26T12:00:00.000Z",
  "updated_at": "2026-09-26T12:00:00.000Z",
  "context": "Spring campaign sells a 6-week fitness program for busy professionals. The brand voice is direct and encouraging. The offer is a starter kit plus one coaching call. Pages should speak to people who started short workouts and quit, explain the weekly plan and the support included, and state the refund window before the call to action."
}

json

application/json

Buscar projetos

GET

https://automation.atomicat-api.com/api/automation/v1

/search/projects

Passe project_id para um, ou query para nome e descrição. Sempre devolve um array.

Escopo exigido: projects:read.

Buscar projetos › query Parameters

limit

integer · min: 1 · max: 100

Quantidade máxima de registros. O padrão é 50 e o máximo é 100.

Default: 50

query

string

Texto sem distinção de maiúsculas comparado com o nome e os campos relacionados.

project_id

string

Id exato do projeto.

Buscar projetos › Responses

Registros correspondentes. O corpo é um array JSON.

Project[]

Project

id

string

Id do projeto.

name

string

Nome.

description

string | null

Descrição.

context

string | null

Brief da marca. Presente ao criar e atualizar.

active

boolean

false quando o projeto está inativo.

created_at

string | null

Timestamp ISO-8601.

updated_at

string | null

Timestamp ISO-8601.

Obter um projeto

GET

https://automation.atomicat-api.com/api/automation/v1

/projects/{projectId}

Escopo exigido: projects:read.

Obter um projeto › path Parameters

projectId

string · required

Id do projeto.

Obter um projeto › Responses

O projeto.

Project

id

string

Id do projeto.

name

string

Nome.

description

string | null

Descrição.

context

string | null

Brief da marca. Presente ao criar e atualizar.

active

boolean

false quando o projeto está inativo.

created_at

string | null

Timestamp ISO-8601.

updated_at

string | null

Timestamp ISO-8601.

Excluir um projeto sem uso

DELETE

https://automation.atomicat-api.com/api/automation/v1

/projects/{projectId}

Exclui o projeto só se nenhuma página, produto, site ou funil o referencia. Caso contrário, responde 409 project_in_use.

Escopo exigido: projects:write.

Excluir um projeto sem uso › path Parameters

projectId

string · required

Id do projeto.

Excluir um projeto sem uso › Responses

O registro foi excluído.

Deleted

success

boolean

true quando a exclusão teve sucesso.

id

string

Id do registro excluído.

deleted

boolean

true quando o registro foi removido.

Atualizar um projeto

PATCH

https://automation.atomicat-api.com/api/automation/v1

/projects/{projectId}

Envie apenas os campos que deseja alterar.

Escopo exigido: projects:write.

Atualizar um projeto › path Parameters

projectId

string · required

Id do projeto.

Atualizar um projeto › Request Body

ProjectUpdate

name

string

Novo nome.

description

string

Nova descrição.

context

string

Novo brief.

Atualizar um projeto › Responses

O projeto atualizado.

Project

id

string

Id do projeto.

name

string

Nome.

description

string | null

Descrição.

context

string | null

Brief da marca. Presente ao criar e atualizar.

active

boolean

false quando o projeto está inativo.

created_at

string | null

Timestamp ISO-8601.

updated_at

string | null

Timestamp ISO-8601.

Account Sites

Listar projetos

GET

https://automation.atomicat-api.com/api/automation/v1

/projects

Os projetos agrupam páginas, sites, funis e produtos.

Escopo exigido: projects:read.

Listar projetos › query Parameters

limit

integer · min: 1 · max: 100

Quantidade máxima de registros. O padrão é 50 e o máximo é 100.

Default: 50

page

integer · min: 0

Índice de página começando em zero. A API devolve limit registros a partir de page × limit.

Default: 0

Listar projetos › Responses

Registros correspondentes. O corpo é um array JSON.

Project[]

Project

id

string

Id do projeto.

name

string

Nome.

description

string | null

Descrição.

context

string | null

Brief da marca. Presente ao criar e atualizar.

active

boolean

false quando o projeto está inativo.

created_at

string | null

Timestamp ISO-8601.

updated_at

string | null

Timestamp ISO-8601.

Criar um projeto

POST

https://automation.atomicat-api.com/api/automation/v1

/projects

name é obrigatório. description precisa de pelo menos 50 caracteres. context precisa de pelo menos 200 caracteres. É necessário um plano pago.

Escopo exigido: projects:write.

Criar um projeto › Request Body

ProjectCreate

name

string · required

Nome do projeto.

Example: Spring campaign

description

string · minLength: 50 · required

Pelo menos 50 caracteres.

Example: Campaign assets for the spring launch across offers and traffic sources.

context

string · minLength: 200 · required

Pelo menos 200 caracteres sobre a marca e a oferta.

Criar um projeto › Responses

O projeto criado.

Project

id

string

Id do projeto.

name

string

Nome.

description

string | null

Descrição.

context

string | null

Brief da marca. Presente ao criar e atualizar.

active

boolean

false quando o projeto está inativo.

created_at

string | null

Timestamp ISO-8601.

updated_at

string | null

Timestamp ISO-8601.

Buscar projetos

GET

https://automation.atomicat-api.com/api/automation/v1

/search/projects

Passe project_id para um, ou query para nome e descrição. Sempre devolve um array.

Escopo exigido: projects:read.

Buscar projetos › query Parameters

limit

integer · min: 1 · max: 100

Quantidade máxima de registros. O padrão é 50 e o máximo é 100.

Default: 50

query

string

Texto sem distinção de maiúsculas comparado com o nome e os campos relacionados.

project_id

string

Id exato do projeto.

Buscar projetos › Responses

Registros correspondentes. O corpo é um array JSON.

Project[]

Project

id

string

Id do projeto.

name

string

Nome.

description

string | null

Descrição.

context

string | null

Brief da marca. Presente ao criar e atualizar.

active

boolean

false quando o projeto está inativo.

created_at

string | null

Timestamp ISO-8601.

updated_at

string | null

Timestamp ISO-8601.

Obter um projeto

GET

https://automation.atomicat-api.com/api/automation/v1

/projects/{projectId}

Escopo exigido: projects:read.

Obter um projeto › path Parameters

projectId

string · required

Id do projeto.

Obter um projeto › Responses

O projeto.

Project

id

string

Id do projeto.

name

string

Nome.

description

string | null

Descrição.

context

string | null

Brief da marca. Presente ao criar e atualizar.

active

boolean

false quando o projeto está inativo.

created_at

string | null

Timestamp ISO-8601.

updated_at

string | null

Timestamp ISO-8601.

Excluir um projeto sem uso

DELETE

https://automation.atomicat-api.com/api/automation/v1

/projects/{projectId}

Exclui o projeto só se nenhuma página, produto, site ou funil o referencia. Caso contrário, responde 409 project_in_use.

Escopo exigido: projects:write.

Excluir um projeto sem uso › path Parameters

projectId

string · required

Id do projeto.

Excluir um projeto sem uso › Responses

O registro foi excluído.

Deleted

success

boolean

true quando a exclusão teve sucesso.

id

string

Id do registro excluído.

deleted

boolean

true quando o registro foi removido.

Atualizar um projeto

PATCH

https://automation.atomicat-api.com/api/automation/v1

/projects/{projectId}

Envie apenas os campos que deseja alterar.

Escopo exigido: projects:write.

Atualizar um projeto › path Parameters

projectId

string · required

Id do projeto.

Atualizar um projeto › Request Body

ProjectUpdate

name

string

Novo nome.

description

string

Nova descrição.

context

string

Novo brief.

Atualizar um projeto › Responses

O projeto atualizado.

Project

id

string

Id do projeto.

name

string

Nome.

description

string | null

Descrição.

context

string | null

Brief da marca. Presente ao criar e atualizar.

active

boolean

false quando o projeto está inativo.

created_at

string | null

Timestamp ISO-8601.

updated_at

string | null

Timestamp ISO-8601.