Quizzes

Download schema

Quiz pages and quiz records.

List quizzes

GET

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

/quizzes

Quiz ids come from the quiz record (qid), which is not always the same as the page id.

Required scope: pages:read.

List quizzes › query Parameters

limit

integer · min: 1 · max: 100

Maximum number of records. Defaults to 50 and cannot exceed 100.

Default: 50

page

integer · min: 0

Zero-based page index. The API returns limit records starting at page × limit.

Default: 0

query

string

Case-insensitive text matched against the record name and related fields.

page_id

string

Only quizzes on this page.

quiz_id

string

Exact quiz id.

List quizzes › Responses

Matching records. The body is a JSON array.

Quiz[]

Quiz

id

string

Quiz id (qid).

name

string

Display name, with the page name when known.

quiz_name

string

Quiz name.

page_id

string | null

Page that hosts the quiz.

page_name

string | null

Host page name.

site_id

string | null

Site id.

project_id

string | null

Project id.

created_at

string | null

ISO-8601 timestamp.

updated_at

string | null

ISO-8601 timestamp.

Create a quiz page

POST

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

/quizzes

Required scope: pages:write.

Create a quiz page › Request Body

QuizCreate

name

string · required

Quiz page name.

project_id

string

Project id.

site_id

string

Site id.

Create a quiz page › Responses

The created quiz page.

A newly created quiz page. id is the page id. Later list calls return the quiz qid, which can differ.

QuizPage

id

string

Page id.

quiz_id

string

Same as id on create.

is_quiz

boolean

Always true.

name

string

Page name.

page_name

string

Page name.

project_id

string | null

Project id.

site_id

string | null

Site id.

edit_url

string

Builder URL.

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

Search quizzes

GET

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

/search/quizzes

Same filters and response as GET /quizzes.

Required scope: pages:read.

Search quizzes › query Parameters

limit

integer · min: 1 · max: 100

Maximum number of records. Defaults to 50 and cannot exceed 100.

Default: 50

page

integer · min: 0

Zero-based page index. The API returns limit records starting at page × limit.

Default: 0

query

string

Case-insensitive text matched against the record name and related fields.

page_id

string

Page id.

quiz_id

string

Quiz id.

Search quizzes › Responses

Matching records. The body is a JSON array.

Quiz[]

Quiz

id

string

Quiz id (qid).

name

string

Display name, with the page name when known.

quiz_name

string

Quiz name.

page_id

string | null

Page that hosts the quiz.

page_name

string | null

Host page name.

site_id

string | null

Site id.

project_id

string | null

Project id.

created_at

string | null

ISO-8601 timestamp.

updated_at

string | null

ISO-8601 timestamp.

Get a quiz

GET

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

/quizzes/{quizId}

quizId can be a quiz id (qid) or the id of a page marked as a quiz.

Required scope: pages:read.

Get a quiz › path Parameters

quizId

string · required

Quiz id or quiz page id.

Get a quiz › Responses

The quiz.

Quiz

id

string

Quiz id (qid).

name

string

Display name, with the page name when known.

quiz_name

string

Quiz name.

page_id

string | null

Page that hosts the quiz.

page_name

string | null

Host page name.

site_id

string | null

Site id.

project_id

string | null

Project id.

created_at

string | null

ISO-8601 timestamp.

updated_at

string | null

ISO-8601 timestamp.

Create a quiz from a template

POST

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

/quizzes/from-template

Required scope: pages:write.

Create a quiz from a template › Request Body

PageFromTemplate

template_id

string · required

Template id from GET /templates.

name

string

Name for the new page.

site_id

string

Site to attach, if any.

project_id

string

Project id.

Create a quiz from a template › Responses

The created quiz page.

A newly created quiz page. id is the page id. Later list calls return the quiz qid, which can differ.

QuizPage

id

string

Page id.

quiz_id

string

Same as id on create.

is_quiz

boolean

Always true.

name

string

Page name.

page_name

string

Page name.

project_id

string | null

Project id.

site_id

string | null

Site id.

edit_url

string

Builder URL.

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

List quizzes

GET

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

/quizzes

Quiz ids come from the quiz record (qid), which is not always the same as the page id.

Required scope: pages:read.

List quizzes › query Parameters

limit

integer · min: 1 · max: 100

Maximum number of records. Defaults to 50 and cannot exceed 100.

Default: 50

page

integer · min: 0

Zero-based page index. The API returns limit records starting at page × limit.

Default: 0

query

string

Case-insensitive text matched against the record name and related fields.

page_id

string

Only quizzes on this page.

quiz_id

string

Exact quiz id.

List quizzes › Responses

Matching records. The body is a JSON array.

Quiz[]

Quiz

id

string

Quiz id (qid).

name

string

Display name, with the page name when known.

quiz_name

string

Quiz name.

page_id

string | null

Page that hosts the quiz.

page_name

string | null

Host page name.

site_id

string | null

Site id.

project_id

string | null

Project id.

created_at

string | null

ISO-8601 timestamp.

updated_at

string | null

ISO-8601 timestamp.

Create a quiz page

POST

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

/quizzes

Required scope: pages:write.

Create a quiz page › Request Body

QuizCreate

name

string · required

Quiz page name.

project_id

string

Project id.

site_id

string

Site id.

Create a quiz page › Responses

The created quiz page.

A newly created quiz page. id is the page id. Later list calls return the quiz qid, which can differ.

QuizPage

id

string

Page id.

quiz_id

string

Same as id on create.

is_quiz

boolean

Always true.

name

string

Page name.

page_name

string

Page name.

project_id

string | null

Project id.

site_id

string | null

Site id.

edit_url

string

Builder URL.

Search quizzes

GET

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

/search/quizzes

Same filters and response as GET /quizzes.

Required scope: pages:read.

Search quizzes › query Parameters

limit

integer · min: 1 · max: 100

Maximum number of records. Defaults to 50 and cannot exceed 100.

Default: 50

page

integer · min: 0

Zero-based page index. The API returns limit records starting at page × limit.

Default: 0

query

string

Case-insensitive text matched against the record name and related fields.

page_id

string

Page id.

quiz_id

string

Quiz id.

Search quizzes › Responses

Matching records. The body is a JSON array.

Quiz[]

Quiz

id

string

Quiz id (qid).

name

string

Display name, with the page name when known.

quiz_name

string

Quiz name.

page_id

string | null

Page that hosts the quiz.

page_name

string | null

Host page name.

site_id

string | null

Site id.

project_id

string | null

Project id.

created_at

string | null

ISO-8601 timestamp.

updated_at

string | null

ISO-8601 timestamp.

Get a quiz

GET

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

/quizzes/{quizId}

quizId can be a quiz id (qid) or the id of a page marked as a quiz.

Required scope: pages:read.

Get a quiz › path Parameters

quizId

string · required

Quiz id or quiz page id.

Get a quiz › Responses

The quiz.

Quiz

id

string

Quiz id (qid).

name

string

Display name, with the page name when known.

quiz_name

string

Quiz name.

page_id

string | null

Page that hosts the quiz.

page_name

string | null

Host page name.

site_id

string | null

Site id.

project_id

string | null

Project id.

created_at

string | null

ISO-8601 timestamp.

updated_at

string | null

ISO-8601 timestamp.

Create a quiz from a template

POST

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

/quizzes/from-template

Required scope: pages:write.

Create a quiz from a template › Request Body

PageFromTemplate

template_id

string · required

Template id from GET /templates.

name

string

Name for the new page.

site_id

string

Site to attach, if any.

project_id

string

Project id.

Create a quiz from a template › Responses

The created quiz page.

A newly created quiz page. id is the page id. Later list calls return the quiz qid, which can differ.

QuizPage

id

string

Page id.

quiz_id

string

Same as id on create.

is_quiz

boolean

Always true.

name

string

Page name.

page_name

string

Page name.

project_id

string | null

Project id.

site_id

string | null

Site id.

edit_url

string

Builder URL.