Quizzes

Download schema

Páginas de quiz e registros de quiz.

Listar quizzes

GET

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

/quizzes

Os ids de quiz vêm do registro (qid) e nem sempre são o id da página.

Escopo exigido: pages:read.

Listar quizzes › 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

query

string

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

page_id

string

Apenas quizzes desta página.

quiz_id

string

Id exato do quiz.

Listar quizzes › Responses

Registros correspondentes. O corpo é um array JSON.

Quiz[]

Quiz

id

string

Id do quiz (qid).

name

string

Nome de exibição, com o nome da página quando conhecido.

quiz_name

string

Nome do quiz.

page_id

string | null

Página que hospeda o quiz.

page_name

string | null

Nome da página.

site_id

string | null

Id do site.

project_id

string | null

Id do projeto.

created_at

string | null

Timestamp ISO-8601.

updated_at

string | null

Timestamp ISO-8601.

Criar uma página de quiz

POST

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

/quizzes

Escopo exigido: pages:write.

Criar uma página de quiz › Request Body

QuizCreate

name

string · required

Nome da página de quiz.

project_id

string

Id do projeto.

site_id

string

Id do site.

Criar uma página de quiz › Responses

A página de quiz criada.

Uma página de quiz recém-criada. id é o id da página. Listagens posteriores devolvem o qid, que pode ser diferente.

QuizPage

id

string

Id da página.

quiz_id

string

Igual a id na criação.

is_quiz

boolean

Sempre true.

name

string

Nome.

page_name

string

Nome.

project_id

string | null

Id do projeto.

site_id

string | null

Id do site.

edit_url

string

URL do construtor.

POST/quizzes

curl --request POST \
  --url https://automation.atomicat-api.com/api/automation/v1/quizzes \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "project_id": "project_id",
  "site_id": "site_id"
}
'

Example Request Body

{
  "name": "name",
  "project_id": "project_id",
  "site_id": "site_id"
}

json

Example Responses

{
  "id": "page_123",
  "name": "Main Offer",
  "page_name": "Main Offer",
  "status": "draft",
  "is_quiz": true,
  "project_id": "project_123",
  "site_id": null,
  "site_name": null,
  "domain": null,
  "slug": "",
  "url": null,
  "edit_url": "https://app.atomicat.com.br/builder/page_123",
  "created_at": "2026-09-26T12:00:00.000Z",
  "updated_at": "2026-09-26T12:00:00.000Z",
  "published_at": null,
  "quiz_id": "page_123"
}

json

application/json

Buscar quizzes

GET

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

/search/quizzes

Os mesmos filtros e a mesma resposta de GET /quizzes.

Escopo exigido: pages:read.

Buscar quizzes › 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

query

string

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

page_id

string

Id da página.

quiz_id

string

Id do quiz.

Buscar quizzes › Responses

Registros correspondentes. O corpo é um array JSON.

Quiz[]

Quiz

id

string

Id do quiz (qid).

name

string

Nome de exibição, com o nome da página quando conhecido.

quiz_name

string

Nome do quiz.

page_id

string | null

Página que hospeda o quiz.

page_name

string | null

Nome da página.

site_id

string | null

Id do site.

project_id

string | null

Id do projeto.

created_at

string | null

Timestamp ISO-8601.

updated_at

string | null

Timestamp ISO-8601.

Obter um quiz

GET

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

/quizzes/{quizId}

quizId pode ser o id do quiz (qid) ou o id de uma página marcada como quiz.

Escopo exigido: pages:read.

Obter um quiz › path Parameters

quizId

string · required

Id do quiz ou da página quiz.

Obter um quiz › Responses

O quiz.

Quiz

id

string

Id do quiz (qid).

name

string

Nome de exibição, com o nome da página quando conhecido.

quiz_name

string

Nome do quiz.

page_id

string | null

Página que hospeda o quiz.

page_name

string | null

Nome da página.

site_id

string | null

Id do site.

project_id

string | null

Id do projeto.

created_at

string | null

Timestamp ISO-8601.

updated_at

string | null

Timestamp ISO-8601.

Criar um quiz a partir de um modelo

POST

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

/quizzes/from-template

Escopo exigido: pages:write.

Criar um quiz a partir de um modelo › Request Body

PageFromTemplate

template_id

string · required

Id do modelo de GET /templates.

name

string

Nome da nova página.

site_id

string

Site para ligar, se houver.

project_id

string

Id do projeto.

Criar um quiz a partir de um modelo › Responses

A página de quiz criada.

Uma página de quiz recém-criada. id é o id da página. Listagens posteriores devolvem o qid, que pode ser diferente.

QuizPage

id

string

Id da página.

quiz_id

string

Igual a id na criação.

is_quiz

boolean

Sempre true.

name

string

Nome.

page_name

string

Nome.

project_id

string | null

Id do projeto.

site_id

string | null

Id do site.

edit_url

string

URL do construtor.

POST/quizzes/from-template

curl --request POST \
  --url https://automation.atomicat-api.com/api/automation/v1/quizzes/from-template \
  --header 'Content-Type: application/json' \
  --data '
{
  "template_id": "template_id",
  "name": "name",
  "site_id": "site_id",
  "project_id": "project_id"
}
'

Example Request Body

{
  "template_id": "template_id",
  "name": "name",
  "site_id": "site_id",
  "project_id": "project_id"
}

json

Example Responses

{
  "id": "page_123",
  "name": "Main Offer",
  "page_name": "Main Offer",
  "status": "draft",
  "is_quiz": true,
  "project_id": "project_123",
  "site_id": null,
  "site_name": null,
  "domain": null,
  "slug": "",
  "url": null,
  "edit_url": "https://app.atomicat.com.br/builder/page_123",
  "created_at": "2026-09-26T12:00:00.000Z",
  "updated_at": "2026-09-26T12:00:00.000Z",
  "published_at": null,
  "quiz_id": "page_123",
  "from_template": true,
  "template_id": "template_123"
}

json

application/json

Builder Funnels

Listar quizzes

GET

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

/quizzes

Os ids de quiz vêm do registro (qid) e nem sempre são o id da página.

Escopo exigido: pages:read.

Listar quizzes › 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

query

string

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

page_id

string

Apenas quizzes desta página.

quiz_id

string

Id exato do quiz.

Listar quizzes › Responses

Registros correspondentes. O corpo é um array JSON.

Quiz[]

Quiz

id

string

Id do quiz (qid).

name

string

Nome de exibição, com o nome da página quando conhecido.

quiz_name

string

Nome do quiz.

page_id

string | null

Página que hospeda o quiz.

page_name

string | null

Nome da página.

site_id

string | null

Id do site.

project_id

string | null

Id do projeto.

created_at

string | null

Timestamp ISO-8601.

updated_at

string | null

Timestamp ISO-8601.

Criar uma página de quiz

POST

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

/quizzes

Escopo exigido: pages:write.

Criar uma página de quiz › Request Body

QuizCreate

name

string · required

Nome da página de quiz.

project_id

string

Id do projeto.

site_id

string

Id do site.

Criar uma página de quiz › Responses

A página de quiz criada.

Uma página de quiz recém-criada. id é o id da página. Listagens posteriores devolvem o qid, que pode ser diferente.

QuizPage

id

string

Id da página.

quiz_id

string

Igual a id na criação.

is_quiz

boolean

Sempre true.

name

string

Nome.

page_name

string

Nome.

project_id

string | null

Id do projeto.

site_id

string | null

Id do site.

edit_url

string

URL do construtor.

Buscar quizzes

GET

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

/search/quizzes

Os mesmos filtros e a mesma resposta de GET /quizzes.

Escopo exigido: pages:read.

Buscar quizzes › 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

query

string

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

page_id

string

Id da página.

quiz_id

string

Id do quiz.

Buscar quizzes › Responses

Registros correspondentes. O corpo é um array JSON.

Quiz[]

Quiz

id

string

Id do quiz (qid).

name

string

Nome de exibição, com o nome da página quando conhecido.

quiz_name

string

Nome do quiz.

page_id

string | null

Página que hospeda o quiz.

page_name

string | null

Nome da página.

site_id

string | null

Id do site.

project_id

string | null

Id do projeto.

created_at

string | null

Timestamp ISO-8601.

updated_at

string | null

Timestamp ISO-8601.

Obter um quiz

GET

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

/quizzes/{quizId}

quizId pode ser o id do quiz (qid) ou o id de uma página marcada como quiz.

Escopo exigido: pages:read.

Obter um quiz › path Parameters

quizId

string · required

Id do quiz ou da página quiz.

Obter um quiz › Responses

O quiz.

Quiz

id

string

Id do quiz (qid).

name

string

Nome de exibição, com o nome da página quando conhecido.

quiz_name

string

Nome do quiz.

page_id

string | null

Página que hospeda o quiz.

page_name

string | null

Nome da página.

site_id

string | null

Id do site.

project_id

string | null

Id do projeto.

created_at

string | null

Timestamp ISO-8601.

updated_at

string | null

Timestamp ISO-8601.

Criar um quiz a partir de um modelo

POST

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

/quizzes/from-template

Escopo exigido: pages:write.

Criar um quiz a partir de um modelo › Request Body

PageFromTemplate

template_id

string · required

Id do modelo de GET /templates.

name

string

Nome da nova página.

site_id

string

Site para ligar, se houver.

project_id

string

Id do projeto.

Criar um quiz a partir de um modelo › Responses

A página de quiz criada.

Uma página de quiz recém-criada. id é o id da página. Listagens posteriores devolvem o qid, que pode ser diferente.

QuizPage

id

string

Id da página.

quiz_id

string

Igual a id na criação.

is_quiz

boolean

Sempre true.

name

string

Nome.

page_name

string

Nome.

project_id

string | null

Id do projeto.

site_id

string | null

Id do site.

edit_url

string

URL do construtor.