List projects
Projects group pages, sites, funnels, and products.
Required scope: projects:read.
query Parameters
limitMaximum number of records. Defaults to 50 and cannot exceed 100.
pageZero-based page index. The API returns limit records starting at page × limit.
List projects › Responses
Matching records. The body is a JSON array.
idProject id.
nameProject name.
descriptionProject description.
contextBrand brief. Present on create and update responses.
activefalse when the project is inactive.
created_atISO-8601 timestamp.
updated_atISO-8601 timestamp.
Create a project
name is required. description must be at least 50 characters. context must be at least 200 characters. A paid plan is required.
Required scope: projects:write.
Create a project › Request Body
nameProject name.
descriptionAt least 50 characters.
contextAt least 200 characters describing the brand and offer.
Create a project › Responses
The created project.
idProject id.
nameProject name.
descriptionProject description.
contextBrand brief. Present on create and update responses.
activefalse when the project is inactive.
created_atISO-8601 timestamp.
updated_atISO-8601 timestamp.
Search projects
Pass project_id to fetch one project, or query to match name and description. Returns an array, including when one id is requested.
Required scope: projects:read.
query Parameters
limitMaximum number of records. Defaults to 50 and cannot exceed 100.
queryCase-insensitive text matched against the record name and related fields.
project_idExact project id.
Search projects › Responses
Matching records. The body is a JSON array.
idProject id.
nameProject name.
descriptionProject description.
contextBrand brief. Present on create and update responses.
activefalse when the project is inactive.
created_atISO-8601 timestamp.
updated_atISO-8601 timestamp.
Get a project
Required scope: projects:read.
path Parameters
projectIdProject id.
Get a project › Responses
The project.
idProject id.
nameProject name.
descriptionProject description.
contextBrand brief. Present on create and update responses.
activefalse when the project is inactive.
created_atISO-8601 timestamp.
updated_atISO-8601 timestamp.
Delete an unused project
Deletes the project only when no page, product, site, or funnel still references it. Otherwise the API returns 409 project_in_use.
Required scope: projects:write.
path Parameters
projectIdProject id.
Delete an unused project › Responses
The record was deleted.
successtrue when the delete succeeded.
idDeleted record id.
deletedtrue when the record was removed.
Update a project
Send only the fields you want to change.
Required scope: projects:write.
path Parameters
projectIdProject id.
Update a project › Request Body
nameNew name.
descriptionNew description.
contextNew brand brief.
Update a project › Responses
The updated project.
idProject id.
nameProject name.
descriptionProject description.
contextBrand brief. Present on create and update responses.
activefalse when the project is inactive.
created_atISO-8601 timestamp.
updated_atISO-8601 timestamp.