Projects
Get all projects
https://automations-api.contentstack.com/v1/projects?limit={limit_value}&skip={skip_value}&asc={field_uid}&desc={field_uid}&include_count={boolean_value}The Get all projects request returns comprehensive information of all the projects related to the Organization in which they are created.
To configure the permissions for your application via OAuth, include the automationhub.projects.management:read scope.
Note If you do not specify a value for the optional “limit” query parameter, the API request will by default return the initial 100 items.
{
"projects": [
{
"title": "demo 14dec",
"description": "",
"user_id": "bltb71****0e9b7facc",
"org_id": "bltc14f1***7416061b",
"shared": [
"blt82dbdb***5e144b53"
],
"tags": [],
"updated_by": "bltb712****e9b7facc",
"type": "standard",
"created_at": "2024-02-04T13:44:35.265Z",
"updated_at": "2024-02-04T14:20:22.442Z",
"id": "bbc469d1f445482****cae6b358479d0",
"created_by": {
"uid": "bltb7128*****9b7facc",
"username": "test1_bltc0ec3c96",
"email": "[email protected]",
"firstName": "John",
"lastName": "Doe",
"active": true
}
},
{
"title": "Demo",
"description": "",
"user_id": "bltb712****e9b7facc",
"org_id": "bltc14f1****416061b",
"shared": [],
"tags": [
"testing"
],
"updated_by": "bltb7128****9b7facc",
"type": "standard",
"created_at": "2024-01-31T06:39:54.994Z",
"updated_at": "2024-01-31T06:39:54.994Z",
"id": "f2065bad17f24****9faba08539b2753",
"created_by": {
"uid": "bltb7128***e9b7facc",
"username": "test2_bltc0ec3c96",
"email": "[email protected]",
"firstName": "John",
"lastName": "Smith",
"active": true
}
}
]
}Get a single project
https://automations-api.contentstack.com/v1/projects/{project_uid}The Get a single project request fetches a specific project created in your organization. When executing the API request, you need to provide the organization UID and your authtoken in the Request Header.
To configure the permissions for your application via OAuth, include the automationhub.projects.management:read scope.
{
"title": "Sample Test Project - Docs",
"description": "",
"user_id": "blt762****ae71c6b33",
"org_id": "blt4051****a6ddf287",
"shared": [],
"tags": [],
"updated_by": "blt76240****71c6b33",
"type": "standard",
"created_at": "2024-02-22T11:31:27.837Z",
"updated_at": "2024-02-22T11:31:27.837Z",
"id": "05732fe9f7d***791715b09a3792f52"
}Create a project
https://automations-api.contentstack.com/v1/projectsThe Create a project request lets you create a project in your organization.
To configure the permissions for your application via OAuth, include the automationhub.projects.management:writescope.
{
"description": "This is a sample project",
"tags": ["sample"],
"title": "Sample Demo Project-Docs"
}{
"title": "Sample Demo Project-Docs",
"description": "This is a sample project",
"user_id": "blt7aa853***b03b79c0",
"org_id": "blt4051c65***ddf287",
"shared": [],
"tags": [
"sample"
],
"updated_by": "blt7aa****ab03b79c0",
"created_at": "2024-02-22T13:01:00.471Z",
"updated_at": "2024-02-22T13:01:00.471Z",
"id": "d8674f45bee847***f044e1da7428a70"
}Update a project
https://automations-api.contentstack.com/v1/projects/{project_uid}The Update a project request lets you update certain details such as the description, tags, and title of an existing project in an Organization.
To configure the permissions for your application via OAuth, include the automationhub.projects.management:write scope.
Here’s an example of the Request body:
{
"description": "New Description",
"tags": ["tag1", "tag2",...],
"title": "New Title"
}{
"description": "This is a New Description for Sample Test",
"tags": ["Sample 1", "Sample 2"],
"title": "Updated Sample Test Project -Docs"
}{
"title": "Updated Sample Test Project -Docs",
"description": "This is a New Description for Sample Test",
"user_id": "blt762****ae71c6b33",
"org_id": "blt4051****a6ddf287",
"shared": [],
"tags": [
"Sample1",
"Sample2"
],
"updated_by": "blt7aa****ab03b79c0",
"created_at": "2024-02-22T11:31:27.837Z",
"updated_at": "2024-02-22T13:09:58.161Z",
"id": "05732fe9f7d***791715b09a3792f52"
}Delete a project
https://automations-api.contentstack.com/v1/projects/{project_uid}The Delete a project request lets you delete an existing project in an organization.
{
"message": "Project deleted successfully."
}