👨‍💻 API Reference 📣 Release Notes 📺 Request a Demo

Projects REST API Guide

PreviousComprehensive API Reference NextModel REST API Guide

Last updated 7 hours ago

Was this helpful?

List of projects

get

/v3/projects

Authorizations

Query parameters

filterstring

Allows you to filter by any field.

searchstring

Allows you to search by any field.

orderingstring

Allows you to order results by any field. For desc order prefix field name with - and provide comman separated values for multiple fields

limitinteger

Limit for the pagination

offsetinteger

Offset for the pagination

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v3/projects' \
  --header 'Authorization: Bearer <token>'

200

400

500

{
  "api_version": "3.0",
  "kind": "PAGINATED",
  "data": {
    "items": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "organization": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        },
        "created_at": "2025-02-06T09:51:28.020Z",
        "updated_at": "2025-02-06T09:51:28.020Z"
      }
    ]
  }
}

List of projects

Create new project

post

/v3/projects

Authorizations

Body

namestringrequired

Name of the project

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v3/projects' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text"}'

200

400

500

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "organization": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "created_at": "2025-02-06T09:51:28.020Z",
    "updated_at": "2025-02-06T09:51:28.020Z"
  }
}

Details of the created project

Detail info of a project for the specified project id

Detail info of a project

get

/v3/projects/{project_id}

Authorizations

Path parameters

project_idstring uuidrequired

Path parameter for unique identifier of a project

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v3/projects/{project_id}' \
  --header 'Authorization: Bearer <token>'

200

400

404

500

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "organization": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "created_at": "2025-02-06T09:51:28.020Z",
    "updated_at": "2025-02-06T09:51:28.020Z"
  }
}

Detail info of the project