Projects
Projects are isolated properties within an organization. Projects are often associated with a single website or application but can be associated with many applications across different channels such as mobile and gaming. For example, a company may have a project for their marketing website, their documentation website, and their LMS or training website. Each of these can be associated with their own project. There is no limit to the number of properties you can associate with a project. Each example above can all point to the same project if this is the preference of the organization.
API keys are isolated to a single project and can not be used to reference resources in other projects. Currently, there are no organization-level API methods publicly available to create new projects programmatically.
List a single project with the provided project ID
Required attributes
| projectId | string | Your projectId |
Optional attributes
| None |
Request
Response
Update project information
Required attributes
| projectId | string | Your project ID |
Optional attributes
| title | string | The name or title of your project |
| description | string | The description of your project |
| defaultLanguage | string | The default language for your project (ISO 639) |
| onboarded | boolean | If false, the project owner sees the onboarding UI in the dashboard |
| theme | string | The theme color for your project. Can be one of "slate", "zinc", "neutral", "stone", "red", "orange", "amber", "yellow", "lime", "green", "emerald", "teal", "cyan", "sky", "type", "blue", "indigo", "violet", "purple", "fuchsia", "pink", "rose" |
Request
Response
Transfer project ownership to another project user. This can only be performed by the project owner.
Required attributes
| projectId | string | Your project ID |
| _id | string | The ID of the project user to transfer the project to |
Optional attributes
| None |
Request
Response
This method deletes a project and all data associated with a project. This action cannot be undone. Only project owners can delete a project.
Required attributes
| projectId | string | Your project ID |
Optional attributes
| None |
Request
Response