Archive a project

PATCH

{team_id}

epics

{epic_id}

Update an epic

curl --request PATCH \
  --url https://api.superthread.com/v1/{team_id}/epics/{epic_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "icon": {
    "type": "image",
    "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
    "id": "<string>",
    "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
    "color": "black",
    "emoji": "thumbsup"
  },
  "title": "My Card",
  "list_id": "114",
  "owner_id": "<string>",
  "start_date": 1608742037016,
  "due_date": 1608742037016,
  "position": 5,
  "priority": 1,
  "archived": true,
  "cover_image": {
    "type": "image",
    "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
    "id": "<string>",
    "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
    "color": "black",
    "emoji": "thumbsup",
    "positionY": 123,
    "object_fit": "contain"
  }
}
'

{
  "epic": {
    "id": "2700",
    "type": "epic",
    "team_id": "tDsu0j19",
    "icon": {
      "type": "image",
      "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
      "id": "<string>",
      "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
      "color": "black",
      "emoji": "thumbsup"
    },
    "title": "My Card",
    "schema": 1,
    "content": "Some card content",
    "collaboration": {
      "token": "<string>"
    },
    "list_id": "41",
    "list_color": "<string>",
    "list_title": "<string>",
    "status": "started",
    "priority": 1,
    "owner_id": "uR2dws11",
    "user_id": "uR2dws11",
    "user_id_updated": "u2erXoQq",
    "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
      }
    },
    "start_date": 1608742037016,
    "due_date": 1608742037016,
    "completed_date": 1608742037016,
    "time_created": 1608742037016,
    "time_updated": 1608742037016,
    "members": [
      {
        "user_id": "u-dsu0j19",
        "assigned_date": 1608742037016,
        "role": "admin"
      }
    ],
    "checklists": [
      {
        "id": "232",
        "title": "My Checklist",
        "content": "Some description",
        "card_id": "32",
        "user_id": "uG2sdaOn",
        "time_created": 1608742037016,
        "time_updated": 1608742037016,
        "items": [
          {
            "id": "4312",
            "title": "Some title",
            "content": "Some description",
            "checklist_id": "432",
            "user_id": "u-du9saoj1",
            "time_created": 1608742037016,
            "time_updated": 1608742037016,
            "checked": true
          }
        ]
      }
    ],
    "checklist_order": {},
    "checklist_item_order": {},
    "child_cards": [
      {
        "title": "Create illustration for upcoming holidays",
        "card_id": "42",
        "user_id": "us4Fsfed",
        "project_id": "3",
        "board_id": "15",
        "board_title": "Ideas",
        "list_id": "55",
        "list_title": "Done",
        "list_color": "<string>",
        "status": "started",
        "archived": {
          "user_id": "uDsu0j19",
          "time_archived": 1608742037016
        }
      }
    ],
    "child_card_order": {},
    "linked_cards": [
      {
        "title": "Create illustration for upcoming holidays",
        "card_id": "42",
        "user_id": "42",
        "project_id": "3",
        "board_id": "15",
        "board_title": "Ideas",
        "list_id": "list 1",
        "list_title": "list 1",
        "status": "started",
        "archived": {
          "user_id": "uDsu0j19",
          "time_archived": 1608742037016
        },
        "linked_card_type": "blocks"
      }
    ],
    "archived": {
      "user_id": "uDsu0j19",
      "time_archived": 1608742037016
    },
    "archived_list": false,
    "tags": [
      {
        "id": "u-dsu0j19",
        "team_id": "u-dsu0j19",
        "project_id": "5",
        "name": "todo",
        "slug": "todo",
        "color": "blue",
        "total_cards": 17
      }
    ],
    "total_comments": 3,
    "total_files": 1,
    "is_watching": true,
    "external_links": [
      {
        "type": "github_pull_request",
        "github_pull_request": {
          "id": 123,
          "number": 123,
          "state": "<string>",
          "title": "<string>",
          "body": "<string>",
          "html_url": "<string>",
          "time_created": 1608742037016,
          "time_updated": 1608742037016,
          "time_closed": 1608742037016,
          "time_merged": 1608742037016,
          "head": {
            "label": "<string>",
            "ref": "<string>"
          },
          "base": {
            "label": "<string>",
            "ref": "<string>"
          },
          "draft": true,
          "merged": true
        },
        "generic": {
          "url": "<string>",
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "display_text": "<string>",
          "time_added": 1608742037016
        }
      }
    ],
    "hints": [
      {
        "type": "tag",
        "tag": {
          "name": "bug"
        },
        "relation": {
          "card": {
            "title": "Create illustration for upcoming holidays",
            "card_id": "42",
            "user_id": "us4Fsfed",
            "project_id": "3",
            "board_id": "15",
            "board_title": "Ideas",
            "list_id": "55",
            "list_title": "Done",
            "list_color": "<string>",
            "status": "started"
          },
          "similarity": 0.8
        }
      }
    ],
    "cover_image": {
      "type": "image",
      "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
      "id": "<string>",
      "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
      "color": "black",
      "emoji": "thumbsup",
      "positionY": 123,
      "object_fit": "contain"
    }
  }
}

Path Parameters

team_id

string

required

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

epic_id

string

required

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

Body

application/json

Card fields that need to be updated. All omitted fields are left unmodified.

icon

object

Show child attributes

icon.type

enum<string>

required

Available options:

image,

icon,

emoji

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=="

icon.id

string

Unique identifier for the image (optional).

icon.blurhash

string

Example:

"LEHV6nWB2yk8pyoJadR*.7kCMdnj"

icon.color

string

Example:

"black"

icon.emoji

string

Emoji string ID

Example:

"thumbsup"

title

string | null

Example:

"My Card"

list_id

string | null

Example:

"114"

owner_id

string | null

start_date

integer<int64> | null

unix timestamp in seconds

Example:

1608742037016

due_date

integer<int64> | null

unix timestamp in seconds

Example:

1608742037016

position

integer | null

a position where the epic should be placed in the list

Example:

5

priority

integer | null

Required range: 0 <= x <= 4

Example:

1

archived

boolean | null

make this card archived/unarchived

Example:

true

cover_image

object

Show child attributes

cover_image.type

enum<string>

required

Available options:

image,

icon,

emoji

cover_image.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=="

cover_image.id

string

Unique identifier for the image (optional).

cover_image.blurhash

string

Example:

"LEHV6nWB2yk8pyoJadR*.7kCMdnj"

cover_image.color

string

Example:

"black"

cover_image.emoji

string

Emoji string ID

Example:

"thumbsup"

cover_image.positionY

number

cover_image.object_fit

enum<string> | null

Available options:

contain,

cover

Response

updated epic card

epic

object

Show child attributes

epic.id

string

Example:

"2700"

epic.type

string

Type of the object being returned

Example:

"epic"

epic.team_id

string

Example:

"tDsu0j19"

epic.icon

object

Show child attributes

epic.icon.type

enum<string>

required

Available options:

image,

icon,

emoji

epic.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=="

epic.icon.id

string

Unique identifier for the image (optional).

epic.icon.blurhash

string

Example:

"LEHV6nWB2yk8pyoJadR*.7kCMdnj"

epic.icon.color

string

Example:

"black"

epic.icon.emoji

string

Emoji string ID

Example:

"thumbsup"

epic.title

string

Example:

"My Card"

epic.schema

integer

Content schema version

Example:

1

epic.content

string

Maximum string length: 102400

Example:

"Some card content"

epic.collaboration

object

Show child attributes

epic.collaboration.token

string

Security token used to start a collaboration session

epic.list_id

string

Example:

"41"

epic.list_color

string

cached field

epic.list_title

string

cached field

epic.status

enum<string>

Available options:

committed,

started,

completed,

cancelled

Example:

"started"

epic.priority

integer

Example:

1

epic.owner_id

string

Example:

"uR2dws11"

epic.user_id

string

Example:

"uR2dws11"

epic.user_id_updated

string

Example:

"u2erXoQq"

epic.user

Actor · object

describes a user or robot that created or updated a resource

Show child attributes

epic.user.user_id

string

Example:

"uDsu0j19"

epic.user.type

enum<string>

default:user

Available options:

user,

robot,

system

Example:

"user"

epic.user.source

ActorSource · object

describes the source of an actor

Show child attributes

epic.user.source.type

enum<string>

Available options:

oauth,

import,

email,

agent

Example:

"oauth"

epic.user.source.client_id

string

client ID if the resource was created via oauth2 app

Example:

"oczapier"

epic.user.source.import_id

string

import ID if the resource was created by an import

Example:

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

epic.user.source.agent_id

string

agent ID if the resource was created by an agent

Example:

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

epic.user.source.email_addr

string

email address if the resource was created via an email

Example:

"[email protected]"

epic.user.source.email_verified

boolean

whether the email sender was verified

Example:

false

epic.user_updated

Actor · object

describes a user or robot that created or updated a resource

Show child attributes

epic.user_updated.user_id

string

Example:

"uDsu0j19"

epic.user_updated.type

enum<string>

default:user

Available options:

user,

robot,

system

Example:

"user"

epic.user_updated.source

ActorSource · object

describes the source of an actor

Show child attributes

epic.user_updated.source.type

enum<string>

Available options:

oauth,

import,

email,

agent

Example:

"oauth"

epic.user_updated.source.client_id

string

client ID if the resource was created via oauth2 app

Example:

"oczapier"

epic.user_updated.source.import_id

string

import ID if the resource was created by an import

Example:

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

epic.user_updated.source.agent_id

string

agent ID if the resource was created by an agent

Example:

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

epic.user_updated.source.email_addr

string

email address if the resource was created via an email

Example:

"[email protected]"

epic.user_updated.source.email_verified

boolean

whether the email sender was verified

Example:

false

epic.start_date

integer<int64>

unix timestamp in seconds

Example:

1608742037016

epic.due_date

integer<int64>

unix timestamp in seconds

Example:

1608742037016

epic.completed_date

integer<int64>

unix timestamp in seconds

Example:

1608742037016

epic.time_created

integer<int64>

unix timestamp in seconds

Example:

1608742037016

epic.time_updated

integer<int64>

unix timestamp in seconds

Example:

1608742037016

epic.members

object[]

Show child attributes

epic.members.user_id

string

Example:

"u-dsu0j19"

epic.members.assigned_date

integer<int64>

unix timestamp in seconds

Example:

1608742037016

epic.members.role

enum<string>

Available options:

admin,

member,

viewer

epic.checklists

object[]

Show child attributes

epic.checklists.id

string

Example:

"232"

epic.checklists.title

string

Example:

"My Checklist"

epic.checklists.content

string

Example:

"Some description"

epic.checklists.card_id

string

Example:

"32"

epic.checklists.user_id

string

Example:

"uG2sdaOn"

epic.checklists.time_created

integer<int64>

unix timestamp in seconds

Example:

1608742037016

epic.checklists.time_updated

integer<int64>

unix timestamp in seconds

Example:

1608742037016

epic.checklists.items

object[]

Show child attributes

epic.checklists.items.id

string

Example:

"4312"

epic.checklists.items.title

string

Example:

"Some title"

epic.checklists.items.content

string

Example:

"Some description"

epic.checklists.items.checklist_id

string

Example:

"432"

epic.checklists.items.user_id

string

Example:

"u-du9saoj1"

epic.checklists.items.time_created

integer<int64>

unix timestamp in seconds

Example:

1608742037016

epic.checklists.items.time_updated

integer<int64>

unix timestamp in seconds

Example:

1608742037016

epic.checklists.items.checked

boolean

Example:

true

epic.checklist_order

object

string array representing an order of IDs

epic.checklist_item_order

object

Show child attributes

epic.checklist_item_order.{key}

object

string array representing an order of IDs

epic.child_cards

object[]

Show child attributes

epic.child_cards.title

string

Example:

"Create illustration for upcoming holidays"

epic.child_cards.card_id

string

Example:

"42"

epic.child_cards.user_id

string

Example:

"us4Fsfed"

epic.child_cards.project_id

string

Example:

"3"

epic.child_cards.board_id

string

Example:

"15"

epic.child_cards.board_title

string

Example:

"Ideas"

epic.child_cards.list_id

string

Example:

"55"

epic.child_cards.list_title

string

Example:

"Done"

epic.child_cards.list_color

string

epic.child_cards.status

enum<string>

Available options:

committed,

started,

completed,

cancelled

Example:

"started"

epic.child_cards.archived

object

Show child attributes

epic.child_cards.archived.user_id

string

Example:

"uDsu0j19"

epic.child_cards.archived.time_archived

integer<int64>

unix timestamp in seconds

Example:

1608742037016

epic.child_card_order

object

string array representing an order of IDs

epic.linked_cards

object[]

Show child attributes

epic.linked_cards.title

string

Example:

"Create illustration for upcoming holidays"

epic.linked_cards.card_id

string

Example:

"42"

epic.linked_cards.user_id

string

Example:

"42"

epic.linked_cards.project_id

string

Example:

"3"

epic.linked_cards.board_id

string

Example:

"15"

epic.linked_cards.board_title

string

Example:

"Ideas"

epic.linked_cards.list_id

string

Example:

"list 1"

epic.linked_cards.list_title

string

Example:

"list 1"

epic.linked_cards.status

enum<string>

Available options:

committed,

started,

completed,

cancelled

Example:

"started"

epic.linked_cards.archived

object

Show child attributes

epic.linked_cards.archived.user_id

string

Example:

"uDsu0j19"

epic.linked_cards.archived.time_archived

integer<int64>

unix timestamp in seconds

Example:

1608742037016

epic.linked_cards.linked_card_type

enum<string>

Available options:

blocks,

blocked_by,

related,

duplicates

Example:

"blocks"

epic.archived

object

Show child attributes

epic.archived.user_id

string

Example:

"uDsu0j19"

epic.archived.time_archived

integer<int64>

unix timestamp in seconds

Example:

1608742037016

epic.archived_list

boolean

whether the epic is in an archived list

Example:

false

epic.tags

object[]

Show child attributes

epic.tags.id

string

Example:

"u-dsu0j19"

epic.tags.team_id

string

Example:

"u-dsu0j19"

epic.tags.project_id

string

Example:

"5"

epic.tags.name

string

Example:

"todo"

epic.tags.slug

string

Example:

"todo"

epic.tags.color

enum<string> | null

Available options:

fog,

slate,

grey,

charcoal,

black,

red,

orange,

yellow,

green,

ocean,

blue,

purple,

pink

Example:

"blue"

epic.tags.total_cards

integer

number of cards that use this tag

Example:

17

epic.total_comments

integer

Example:

3

epic.total_files

integer

Example:

1

epic.is_watching

boolean

whether current user is a watcher of this epic

Example:

true

epic.external_links

object[]

Show child attributes

epic.external_links.type

enum<string>

Available options:

github_pull_request,

generic

epic.external_links.github_pull_request

object

Show child attributes

epic.external_links.github_pull_request.id

integer | null

epic.external_links.github_pull_request.number

integer | null

epic.external_links.github_pull_request.state

string | null

epic.external_links.github_pull_request.title

string | null

epic.external_links.github_pull_request.body

string | null

epic.external_links.github_pull_request.html_url

string | null

epic.external_links.github_pull_request.time_created

integer<int64>

unix timestamp in seconds

Example:

1608742037016

epic.external_links.github_pull_request.time_updated

integer<int64>

unix timestamp in seconds

Example:

1608742037016

epic.external_links.github_pull_request.time_closed

integer<int64>

unix timestamp in seconds

Example:

1608742037016

epic.external_links.github_pull_request.time_merged

integer<int64>

unix timestamp in seconds

Example:

1608742037016

epic.external_links.github_pull_request.head

object

Show child attributes

epic.external_links.github_pull_request.head.label

string | null

epic.external_links.github_pull_request.head.ref

string | null

epic.external_links.github_pull_request.base

object

Show child attributes

epic.external_links.github_pull_request.base.label

string | null

epic.external_links.github_pull_request.base.ref

string | null

epic.external_links.github_pull_request.draft

boolean | null

epic.external_links.github_pull_request.merged

boolean | null

epic.external_links.generic

object

Show child attributes

epic.external_links.generic.url

string

required

epic.external_links.generic.id

string

Unique identifier for this external link (UUID)

Example:

"550e8400-e29b-41d4-a716-446655440000"

epic.external_links.generic.display_text

string | null

epic.external_links.generic.time_added

integer<int64>

unix timestamp in seconds

Example:

1608742037016

epic.hints

object[]

Show child attributes

epic.hints.type

enum<string>

defines the type of hint

Available options:

tag,

relation

Example:

"tag"

epic.hints.tag

object

Show child attributes

epic.hints.tag.name

enum<string>

Available options:

bug,

feature

epic.hints.relation

object

Show child attributes

epic.hints.relation.card

object

Show child attributes

epic.hints.relation.card.title

string

Example:

"Create illustration for upcoming holidays"

epic.hints.relation.card.card_id

string

Example:

"42"

epic.hints.relation.card.user_id

string

Example:

"us4Fsfed"

epic.hints.relation.card.project_id

string

Example:

"3"

epic.hints.relation.card.board_id

string

Example:

"15"

epic.hints.relation.card.board_title

string

Example:

"Ideas"

epic.hints.relation.card.list_id

string

Example:

"55"

epic.hints.relation.card.list_title

string

Example:

"Done"

epic.hints.relation.card.list_color

string

epic.hints.relation.card.status

enum<string>

Available options:

committed,

started,

completed,

cancelled

Example:

"started"

epic.hints.relation.similarity

number<float64>

similarity score between 0 and 1

Example:

0.8

epic.cover_image

object

Show child attributes

epic.cover_image.type

enum<string>

required

Available options:

image,

icon,

emoji

epic.cover_image.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=="

epic.cover_image.id

string

Unique identifier for the image (optional).

epic.cover_image.blurhash

string

Example:

"LEHV6nWB2yk8pyoJadR*.7kCMdnj"

epic.cover_image.color

string

Example:

"black"

epic.cover_image.emoji

string

Emoji string ID

Example:

"thumbsup"

epic.cover_image.positionY

number

epic.cover_image.object_fit

enum<string> | null

Available options:

contain,

cover

Delete a projectDelete an epic (project) in a workspace (`team_id`). This operation removes the project but cards associated with the epic remain intact.

⌘I

Update an epic

curl --request PATCH \
  --url https://api.superthread.com/v1/{team_id}/epics/{epic_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "icon": {
    "type": "image",
    "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
    "id": "<string>",
    "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
    "color": "black",
    "emoji": "thumbsup"
  },
  "title": "My Card",
  "list_id": "114",
  "owner_id": "<string>",
  "start_date": 1608742037016,
  "due_date": 1608742037016,
  "position": 5,
  "priority": 1,
  "archived": true,
  "cover_image": {
    "type": "image",
    "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
    "id": "<string>",
    "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
    "color": "black",
    "emoji": "thumbsup",
    "positionY": 123,
    "object_fit": "contain"
  }
}
'

{
  "epic": {
    "id": "2700",
    "type": "epic",
    "team_id": "tDsu0j19",
    "icon": {
      "type": "image",
      "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
      "id": "<string>",
      "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
      "color": "black",
      "emoji": "thumbsup"
    },
    "title": "My Card",
    "schema": 1,
    "content": "Some card content",
    "collaboration": {
      "token": "<string>"
    },
    "list_id": "41",
    "list_color": "<string>",
    "list_title": "<string>",
    "status": "started",
    "priority": 1,
    "owner_id": "uR2dws11",
    "user_id": "uR2dws11",
    "user_id_updated": "u2erXoQq",
    "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
      }
    },
    "start_date": 1608742037016,
    "due_date": 1608742037016,
    "completed_date": 1608742037016,
    "time_created": 1608742037016,
    "time_updated": 1608742037016,
    "members": [
      {
        "user_id": "u-dsu0j19",
        "assigned_date": 1608742037016,
        "role": "admin"
      }
    ],
    "checklists": [
      {
        "id": "232",
        "title": "My Checklist",
        "content": "Some description",
        "card_id": "32",
        "user_id": "uG2sdaOn",
        "time_created": 1608742037016,
        "time_updated": 1608742037016,
        "items": [
          {
            "id": "4312",
            "title": "Some title",
            "content": "Some description",
            "checklist_id": "432",
            "user_id": "u-du9saoj1",
            "time_created": 1608742037016,
            "time_updated": 1608742037016,
            "checked": true
          }
        ]
      }
    ],
    "checklist_order": {},
    "checklist_item_order": {},
    "child_cards": [
      {
        "title": "Create illustration for upcoming holidays",
        "card_id": "42",
        "user_id": "us4Fsfed",
        "project_id": "3",
        "board_id": "15",
        "board_title": "Ideas",
        "list_id": "55",
        "list_title": "Done",
        "list_color": "<string>",
        "status": "started",
        "archived": {
          "user_id": "uDsu0j19",
          "time_archived": 1608742037016
        }
      }
    ],
    "child_card_order": {},
    "linked_cards": [
      {
        "title": "Create illustration for upcoming holidays",
        "card_id": "42",
        "user_id": "42",
        "project_id": "3",
        "board_id": "15",
        "board_title": "Ideas",
        "list_id": "list 1",
        "list_title": "list 1",
        "status": "started",
        "archived": {
          "user_id": "uDsu0j19",
          "time_archived": 1608742037016
        },
        "linked_card_type": "blocks"
      }
    ],
    "archived": {
      "user_id": "uDsu0j19",
      "time_archived": 1608742037016
    },
    "archived_list": false,
    "tags": [
      {
        "id": "u-dsu0j19",
        "team_id": "u-dsu0j19",
        "project_id": "5",
        "name": "todo",
        "slug": "todo",
        "color": "blue",
        "total_cards": 17
      }
    ],
    "total_comments": 3,
    "total_files": 1,
    "is_watching": true,
    "external_links": [
      {
        "type": "github_pull_request",
        "github_pull_request": {
          "id": 123,
          "number": 123,
          "state": "<string>",
          "title": "<string>",
          "body": "<string>",
          "html_url": "<string>",
          "time_created": 1608742037016,
          "time_updated": 1608742037016,
          "time_closed": 1608742037016,
          "time_merged": 1608742037016,
          "head": {
            "label": "<string>",
            "ref": "<string>"
          },
          "base": {
            "label": "<string>",
            "ref": "<string>"
          },
          "draft": true,
          "merged": true
        },
        "generic": {
          "url": "<string>",
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "display_text": "<string>",
          "time_added": 1608742037016
        }
      }
    ],
    "hints": [
      {
        "type": "tag",
        "tag": {
          "name": "bug"
        },
        "relation": {
          "card": {
            "title": "Create illustration for upcoming holidays",
            "card_id": "42",
            "user_id": "us4Fsfed",
            "project_id": "3",
            "board_id": "15",
            "board_title": "Ideas",
            "list_id": "55",
            "list_title": "Done",
            "list_color": "<string>",
            "status": "started"
          },
          "similarity": 0.8
        }
      }
    ],
    "cover_image": {
      "type": "image",
      "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
      "id": "<string>",
      "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
      "color": "black",
      "emoji": "thumbsup",
      "positionY": 123,
      "object_fit": "contain"
    }
  }
}

Get started

Users

Cards

Projects

Notes

Pages

Comments

Boards

Sprints

Spaces

Search

Path Parameters

Body

Response