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

Projects REST API Guide

PreviousComprehensive REST API Reference NextModel REST API Guide

Last updated 1 month ago

Was this helpful?

Detail info of a project for the specified project id

get

Detail info of a project

Authorizations

Path parameters

project_idstring · uuidRequired

Path parameter for unique identifier of a project

Responses

application/json

all ofOptional

Response object for standard API responses.

application/json

get

GET /v3/projects/{project_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "api_version": "2.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "organization": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "created_at": "2025-04-18T22:32:46.302Z",
    "updated_at": "2025-04-18T22:32:46.302Z"
  }
}

List of projects

get

List of projects

Authorizations

Query parameters

filterstringOptional

Allows you to filter by any field.

searchstringOptional

Allows you to search by any field.

orderingstringOptional

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

limitintegerOptional

Limit for the pagination

offsetintegerOptional

Offset for the pagination

Responses

application/json

all ofOptional

Response object for paginated API responses.

application/json

get

GET /v3/projects HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "api_version": "2.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-04-18T22:32:46.302Z",
        "updated_at": "2025-04-18T22:32:46.302Z"
      }
    ]
  }
}

Create new project

post

Create new project

Authorizations

Body

Request body for creating a project

namestringRequired

Name of the project

Responses

application/json

all ofOptional

Response object for standard API responses.

application/json

post

POST /v3/projects HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "api_version": "2.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "organization": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "created_at": "2025-04-18T22:32:46.302Z",
    "updated_at": "2025-04-18T22:32:46.302Z"
  }
}