Skip to main content
POST
/
{team_id}
/
projects
Create a new project
curl --request POST \
  --url https://api.superthread.com/v1/{team_id}/projects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "My Project Title",
  "description": "Project description",
  "is_public": false,
  "is_private": false,
  "overview_page_id": "22",
  "members": [
    {
      "user_id": "u-dsu0j19"
    }
  ],
  "is_view_only": true
}
'
{
  "project": {
    "id": "421",
    "team_id": "tDsu0j19",
    "title": "My Project",
    "description": "<string>",
    "icon": {
      "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
      "id": "<string>",
      "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
      "color": "black",
      "emoji": "thumbsup"
    },
    "overview_page_id": "<string>",
    "user_id": "u-dsu0j19",
    "user_id_updated": "uDsu0j19",
    "user": {
      "user_id": "uDsu0j19",
      "type": "user",
      "source": {
        "type": "oauth",
        "client_id": "oczapier",
        "import_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
        "agent_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
        "email_addr": "somebody@example.com",
        "email_verified": false,
        "on_behalf_of": "<string>"
      }
    },
    "user_updated": {
      "user_id": "uDsu0j19",
      "type": "user",
      "source": {
        "type": "oauth",
        "client_id": "oczapier",
        "import_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
        "agent_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
        "email_addr": "somebody@example.com",
        "email_verified": false,
        "on_behalf_of": "<string>"
      }
    },
    "time_created": 1608742037016,
    "time_updated": 1608742037016,
    "time_expires": 1608742037016,
    "members": [
      {
        "user_id": "u-dsu0j19",
        "assigned_date": 1608742037016
      }
    ],
    "is_member": true,
    "total_members": 7,
    "total_members_online": 2,
    "is_public": true,
    "is_private": true,
    "page_order": [
      {}
    ],
    "pages": [
      {
        "id": "<string>",
        "title": "<string>",
        "icon": {
          "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
          "id": "<string>",
          "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
          "color": "black",
          "emoji": "thumbsup"
        }
      }
    ],
    "trashed": {
      "user_deleted": {
        "user_id": "uDsu0j19",
        "type": "user",
        "source": {
          "type": "oauth",
          "client_id": "oczapier",
          "import_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
          "agent_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
          "email_addr": "somebody@example.com",
          "email_verified": false,
          "on_behalf_of": "<string>"
        }
      },
      "time_deleted": 1608742037016
    },
    "archive_page_order": [
      {}
    ],
    "archive_pages": [
      {
        "id": "<string>",
        "title": "<string>",
        "icon": {
          "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
          "id": "<string>",
          "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
          "color": "black",
          "emoji": "thumbsup"
        }
      }
    ],
    "board_order": {},
    "boards": [
      {
        "id": "<string>",
        "title": "<string>"
      }
    ],
    "sprints": [
      {
        "id": "<string>",
        "title": "<string>",
        "start_date": 1608742037016,
        "end_date": 1608742037016
      }
    ],
    "is_view_only": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://superthread.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
team_id
string
required

Team ID is an alphanumerical string that identifies a Team. This is externally referred to as a "Workspace".

Body

application/json

Project object that needs to be created

​
title
string
required
Example:

"My Project Title"

​
description
string
Example:

"Project description"

​
icon
object
​
is_public
boolean | null

Deprecated. Use is_private instead.

Example:

false

​
is_private
boolean | null
Example:

false

​
overview_page_id
string
Example:

"22"

​
members
object[]
Maximum array length: 20
​
estimate_system
enum<string>
Available options:
,
fibonacci,
exponential,
tshirt
​
is_view_only
boolean | null

Response

Newly created project

​
project
object