Get a space

GET

{team_id}

projects

{project_id}

Get a project

curl --request GET \
  --url https://api.superthread.com/v1/{team_id}/projects/{project_id}

{
  "project": {
    "id": "421",
    "team_id": "tDsu0j19",
    "title": "My Project",
    "description": "<string>",
    "icon": {
      "type": "image",
      "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": "[email protected]",
        "email_verified": false
      }
    },
    "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": "[email protected]",
        "email_verified": false
      }
    },
    "time_created": 1608742037016,
    "time_updated": 1608742037016,
    "time_expires": 1608742037016,
    "members": [
      {
        "user_id": "u-dsu0j19",
        "assigned_date": 1608742037016,
        "role": "admin"
      }
    ],
    "is_member": true,
    "total_members": 7,
    "total_members_online": 2,
    "is_public": true,
    "is_private": true,
    "page_order": [
      {}
    ],
    "pages": [
      {
        "id": "<string>",
        "title": "<string>",
        "icon": {
          "type": "image",
          "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": "[email protected]",
          "email_verified": false
        }
      },
      "time_deleted": 1608742037016
    },
    "archive_page_order": [
      {}
    ],
    "archive_pages": [
      {
        "id": "<string>",
        "title": "<string>",
        "icon": {
          "type": "image",
          "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
      }
    ],
    "estimate_system": "",
    "is_view_only": true
  }
}

Path Parameters

team_id

string

required

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

project_id

string

required

Project ID is a numerical string that identifies a Project. This is externally referred to as a "Space".

Response

Project response

project

object

Show child attributes

project.id

string

Example:

"421"

project.team_id

string

Example:

"tDsu0j19"

project.title

string

Example:

"My Project"

project.description

string

project.icon

object

Show child attributes

project.icon.type

enum<string>

required

Available options:

image,

icon,

emoji

project.icon.src

string

required

Depending on the type this can be a URL, base64 image data, emoji unicode or an icon name

Example:

"data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="

project.icon.id

string

Unique identifier for the image (optional).

project.icon.blurhash

string

Example:

"LEHV6nWB2yk8pyoJadR*.7kCMdnj"

project.icon.color

string

Example:

"black"

project.icon.emoji

string

Emoji string ID

Example:

"thumbsup"

project.overview_page_id

string

project.user_id

string

Example:

"u-dsu0j19"

project.user_id_updated

string

Example:

"uDsu0j19"

project.user

Actor · object

describes a user or robot that created or updated a resource

Show child attributes

project.user.user_id

string

Example:

"uDsu0j19"

project.user.type

enum<string>

default:user

Available options:

user,

robot,

system

Example:

"user"

project.user.source

ActorSource · object

describes the source of an actor

Show child attributes

project.user.source.type

enum<string>

Available options:

oauth,

import,

email,

agent

Example:

"oauth"

project.user.source.client_id

string

client ID if the resource was created via oauth2 app

Example:

"oczapier"

project.user.source.import_id

string

import ID if the resource was created by an import

Example:

"bf1b9f76-3f95-42fc-bd7f-050b2f5f4197"

project.user.source.agent_id

string

agent ID if the resource was created by an agent

Example:

"bf1b9f76-3f95-42fc-bd7f-050b2f5f4197"

project.user.source.email_addr

string

email address if the resource was created via an email

Example:

"[email protected]"

project.user.source.email_verified

boolean

whether the email sender was verified

Example:

false

project.user_updated

Actor · object

describes a user or robot that created or updated a resource

Show child attributes

project.user_updated.user_id

string

Example:

"uDsu0j19"

project.user_updated.type

enum<string>

default:user

Available options:

user,

robot,

system

Example:

"user"

project.user_updated.source

ActorSource · object

describes the source of an actor

Show child attributes

project.user_updated.source.type

enum<string>

Available options:

oauth,

import,

email,

agent

Example:

"oauth"

project.user_updated.source.client_id

string

client ID if the resource was created via oauth2 app

Example:

"oczapier"

project.user_updated.source.import_id

string

import ID if the resource was created by an import

Example:

"bf1b9f76-3f95-42fc-bd7f-050b2f5f4197"

project.user_updated.source.agent_id

string

agent ID if the resource was created by an agent

Example:

"bf1b9f76-3f95-42fc-bd7f-050b2f5f4197"

project.user_updated.source.email_addr

string

email address if the resource was created via an email

Example:

"[email protected]"

project.user_updated.source.email_verified

boolean

whether the email sender was verified

Example:

false

project.time_created

integer<int64>

unix timestamp in seconds

Example:

1608742037016

project.time_updated

integer<int64>

unix timestamp in seconds

Example:

1608742037016

project.time_expires

integer<int64>

unix timestamp in seconds

Example:

1608742037016

project.members

object[]

Show child attributes

project.members.user_id

string

Example:

"u-dsu0j19"

project.members.assigned_date

integer<int64>

unix timestamp in seconds

Example:

1608742037016

project.members.role

enum<string>

Available options:

admin,

member,

viewer

project.is_member

boolean

true if currently logged in user is a member of this project

Example:

true

project.total_members

integer

Example:

7

project.total_members_online

integer

Example:

2

project.is_public

boolean

Deprecated. Use is_private instead

Example:

true

project.is_private

boolean

Example:

true

project.page_order

(object | null)[]

project.pages

object[]

Show child attributes

project.pages.id

string

project.pages.title

string

project.pages.icon

object

Show child attributes

project.pages.icon.type

enum<string>

required

Available options:

image,

icon,

emoji

project.pages.icon.src

string

required

Depending on the type this can be a URL, base64 image data, emoji unicode or an icon name

Example:

"data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="

project.pages.icon.id

string

Unique identifier for the image (optional).

project.pages.icon.blurhash

string

Example:

"LEHV6nWB2yk8pyoJadR*.7kCMdnj"

project.pages.icon.color

string

Example:

"black"

project.pages.icon.emoji

string

Emoji string ID

Example:

"thumbsup"

project.trashed

object

Show child attributes

project.trashed.user_deleted

Actor · object

describes a user or robot that created or updated a resource

Show child attributes

project.trashed.user_deleted.user_id

string

Example:

"uDsu0j19"

project.trashed.user_deleted.type

enum<string>

default:user

Available options:

user,

robot,

system

Example:

"user"

project.trashed.user_deleted.source

ActorSource · object

describes the source of an actor

Show child attributes

project.trashed.user_deleted.source.type

enum<string>

Available options:

oauth,

import,

email,

agent

Example:

"oauth"

project.trashed.user_deleted.source.client_id

string

client ID if the resource was created via oauth2 app

Example:

"oczapier"

project.trashed.user_deleted.source.import_id

string

import ID if the resource was created by an import

Example:

"bf1b9f76-3f95-42fc-bd7f-050b2f5f4197"

project.trashed.user_deleted.source.agent_id

string

agent ID if the resource was created by an agent

Example:

"bf1b9f76-3f95-42fc-bd7f-050b2f5f4197"

project.trashed.user_deleted.source.email_addr

string

email address if the resource was created via an email

Example:

"[email protected]"

project.trashed.user_deleted.source.email_verified

boolean

whether the email sender was verified

Example:

false

project.trashed.time_deleted

integer<int64>

unix timestamp in seconds

Example:

1608742037016

project.archive_page_order

(object | null)[]

project.archive_pages

object[]

Show child attributes

project.archive_pages.id

string

project.archive_pages.title

string

project.archive_pages.icon

object

Show child attributes

project.archive_pages.icon.type

enum<string>

required

Available options:

image,

icon,

emoji

project.archive_pages.icon.src

string

required

Depending on the type this can be a URL, base64 image data, emoji unicode or an icon name

Example:

"data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="

project.archive_pages.icon.id

string

Unique identifier for the image (optional).

project.archive_pages.icon.blurhash

string

Example:

"LEHV6nWB2yk8pyoJadR*.7kCMdnj"

project.archive_pages.icon.color

string

Example:

"black"

project.archive_pages.icon.emoji

string

Emoji string ID

Example:

"thumbsup"

project.board_order

object

string array representing an order of IDs

project.boards

object[]

Show child attributes

project.boards.id

string

project.boards.title

string

project.sprints

object[]

Show child attributes

project.sprints.id

string

project.sprints.title

string

project.sprints.start_date

integer<int64>

unix timestamp in seconds

Example:

1608742037016

project.sprints.end_date

integer<int64>

unix timestamp in seconds

Example:

1608742037016

project.estimate_system

enum<string>

Available options:

fibonacci,

exponential,

tshirt

project.is_view_only

boolean

Get spaces

⌘I

Get a project

curl --request GET \
  --url https://api.superthread.com/v1/{team_id}/projects/{project_id}

{
  "project": {
    "id": "421",
    "team_id": "tDsu0j19",
    "title": "My Project",
    "description": "<string>",
    "icon": {
      "type": "image",
      "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": "[email protected]",
        "email_verified": false
      }
    },
    "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": "[email protected]",
        "email_verified": false
      }
    },
    "time_created": 1608742037016,
    "time_updated": 1608742037016,
    "time_expires": 1608742037016,
    "members": [
      {
        "user_id": "u-dsu0j19",
        "assigned_date": 1608742037016,
        "role": "admin"
      }
    ],
    "is_member": true,
    "total_members": 7,
    "total_members_online": 2,
    "is_public": true,
    "is_private": true,
    "page_order": [
      {}
    ],
    "pages": [
      {
        "id": "<string>",
        "title": "<string>",
        "icon": {
          "type": "image",
          "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": "[email protected]",
          "email_verified": false
        }
      },
      "time_deleted": 1608742037016
    },
    "archive_page_order": [
      {}
    ],
    "archive_pages": [
      {
        "id": "<string>",
        "title": "<string>",
        "icon": {
          "type": "image",
          "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
      }
    ],
    "estimate_system": "",
    "is_view_only": true
  }
}

Get started

Users

Cards

Projects

Notes

Pages

Comments

Boards

Sprints

Spaces

Search

Path Parameters

Response