Superthread

https://superthread.com/docs/
Admin
Superthread is a collaborative workspace platform that combines task management, note-taking,...
Tokens:320,497
Snippets:531
Trust Score:8.2
Update:1 year ago
Show doc for...
Tokens:
Raw
### Example Superthread Board Configuration

Source: https://superthread.com/docs/api-docs/boards/get-a-board

Illustrates a typical JSON configuration for a Superthread board, including settings for watching, webhook notifications to Slack, tags, archiving status, and version control system mappings for pull request states.

```json
{
  "webhook_notifications": [
    {
      "webhook": {
        "destination_type": "slack_channel_webhook",
        "integration_id": "42"
      },
      "options": {
        "card_created": true,
        "card_moved": true,
        "card_commented": true,
        "card_due_date": true
      }
    }
  ],
  "tags": [
    {
      "id": "u-dsu0j19",
      "team_id": "u-dsu0j19",
      "project_id": "5",
      "name": "todo",
      "slug": "todo",
      "color": "blue",
      "total_cards": 17
    }
  ],
  "archived": {
    "user_id": "uDsu0j19",
    "time_archived": 1608742037016
  },
  "is_watching": true,
  "is_bookmarked": true,
  "vcs_mapping": {
    "pr_draft": "41",
    "pr_open": "41",
    "pr_review_requested": "41",
    "pr_merged": "41",
    "pr_closed": "41",
    "branches": [
      {
        "name": "development",
        "pr_draft": "41",
        "pr_open": "41",
        "pr_review_requested": "41",
        "pr_merged": "41",
        "pr_closed": "41",
        "time_created": 1608742037016
      }
    ]
  },
  "layout": "board",
  "email": {
    "email": "board+engineering-board-b2L2jKl@inbound.superthread.com",
    "active": true
  }
}
```

--------------------------------

### Get Epics Response Example - JSON

Source: https://superthread.com/docs/api-docs/projects/get-projects

An example JSON response for the 'Get Epics' endpoint, illustrating the structure of epic data including user information, timestamps, and associated lists with cards.

```json
{
  "team_id": "tDsu0j19",
  "user_id_updated": "u2erXoQq",
  "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
    }
  },
  "time_updated": 1608742037016,
  "lists": [
    {
      "id": "41",
      "team_id": "tDsu0j19",
      "title": "My list",
      "content": "<string>",
      "behavior": "backlog",
      "board_id": "43",
      "user_id": "u981hdaT",
      "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
        }
      },
      "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
        }
      },
      "project_id": "5",
      "icon": "shield",
      "color": "<string>",
      "card_order": {},
      "total_cards": 5,
      "time_created": 1608742037016,
      "time_updated": 1608742037016,
      "cards": [
        {
          "id": "2700",
          "type": "card",
          "icon": {
            "type": "image",
            "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
            "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
            "color": "black",
            "emoji": "thumbsup"
          },
          "team_id": "tDsu0j19",
          "title": "My Card",
          "content": "Some card content",
          "schema": 1,
          "collaboration": {
            "token": "<string>"
          },
          "status": "started",
          "priority": 1,
          "board_id": "12",
          "board_title": "<string>",
          "list_id": "41",
          "list_color": "<string>",
          "list_title": "<string>",
          "sprint_id": "4s12",
          "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": "somebody@example.com",
              "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": "somebody@example.com",
              "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
            }
          ]
        }
      ]
    }
  ]
}
```

--------------------------------

### Create Pages with 'P' Shortcut

Source: https://superthread.com/docs/help/quick-start-guide

Users can quickly create new pages for documentation or notes using the 'P' shortcut. This facilitates efficient content creation.

```text
P
```

--------------------------------

### Example Response for Get All Team Notes

Source: https://superthread.com/docs/api-docs/notes/get-notes

Provides an example JSON response structure for the 'Get All Team Notes' API endpoint. It includes cursor, count, and an array of note objects with detailed attributes.

```json
{
  "cursor": "dmsjqh9d8w1hdjosjaasda",
  "count": 14,
  "notes": [
    {
      "id": "",
      "title": "Team Note",
      "transcript": "<string>",
      "transcripts": [
        {
          "content": "This is a transcript",
          "source": "author",
          "id": "43",
          "time_created": 1608742037016,
          "time_updated": 1608742037016
        }
      ],
      "user_notes": "<string>",
      "ai_notes": [
        {
          "id": "866a3b86-4651-482c-bb69-61921ea4548c",
          "note_template_id": "1da3b68c-3a82-495c-a6c9-e7a494281a36",
          "title": "Team Note",
          "content": "<string>",
          "time_updated": 1608742037016,
          "related_resources": [
            {
              "id": "123",
              "type": "card",
              "cosine_similarity": 0.8
            }
          ]
        }
      ],
      "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
        }
      },
      "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
        }
      },
      "team_id": "tdsu0j19",
      "last_note_template_id": "<string>",
      "is_public": false,
      "public_settings": {
        "url": "https://notes.superthread.com/n/1"
      },
      "time_created": 1608742037016,
      "time_updated": 1608742037016,
      "meeting_metadata": {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "links": [
          {
            "provider": "google",
            "link": "<string>"
          }
        ],
        "location": "<string>",
        "start_time": 1608742037016,
        "end_time": 1608742037016
      },
      "meeting_date": 1608742037016,
      "meeting_time": 1608742037016,
      "meeting_organizer": {
        "user_id": "uDsu0j19",
        "email": "username@example.com",
        "name": "John Doe"
      },
      "meeting_attendees": [
        {
          "user_id": "uDsu0j19",
          "email": "username@example.com",
          "name": "John Doe"
        }
      ]
    }
  ]
}
```

--------------------------------

### Create Board - Example Request Body

Source: https://superthread.com/docs/api-docs/boards/create-a-board

Example JSON payload for creating a new board within a project. It includes board title, content, icon, color, associated list and member data, layout preferences, and webhook notification configurations.

```json
{
  "project_id": "5",
  "title": "My New Board",
  "content": "This is a sample board.",
  "icon": "clipboard",
  "color": "#FF5733",
  "layout": "board",
  "lists": [
    {
      "name": "To Do",
      "position": 0
    },
    {
      "name": "In Progress",
      "position": 1
    }
  ],
  "members": [
    {
      "user_id": "u123xyz",
      "role": "editor"
    }
  ],
  "webhook_notifications": [
    {
      "webhook": {
        "destination_type": "slack_channel_webhook",
        "integration_id": "42"
      },
      "options": {
        "card_created": true,
        "card_moved": true
      }
    }
  ]
}
```

--------------------------------

### Get User Details via API

Source: https://superthread.com/docs/api-docs/auth

This example demonstrates how to make a GET request to retrieve the current user's details using their Personal Access Token (PAT) for authentication.

```shell
curl \
  -H "Authorization: Bearer <YOUR_PAT>" \
  https://api.superthread.com/v1/users/me
```

--------------------------------

### Board Configuration Example

Source: https://superthread.com/docs/api-docs/boards/create-a-board

A sample JSON object representing the configuration of a Superthread board. It includes details about archived status, watching status, version control mappings, layout, email notifications, and webhook configurations for various card activities.

```json
{
  "archived": {
    "user_id": "uDsu0j19",
    "time_archived": 1608742037016
  },
  "is_watching": true,
  "webhook_notifications": [
    {
      "webhook": {
        "destination_type": "slack_channel_webhook",
        "integration_id": "42"
      },
      "options": {
        "card_created": true,
        "card_moved": true,
        "card_commented": true,
        "card_due_date": true
      }
    }
  ],
  "vcs_mapping": {
    "pr_draft": "41",
    "pr_open": "41",
    "pr_review_requested": "41",
    "pr_merged": "41",
    "pr_closed": "41",
    "branches": [
      {
        "name": "development",
        "pr_draft": "41",
        "pr_open": "41",
        "pr_review_requested": "41",
        "pr_merged": "41",
        "pr_closed": "41",
        "time_created": 1608742037016
      }
    ]
  },
  "layout": "board",
  "email": {
    "email": "board+engineering-board-b2L2jKl@inbound.superthread.com",
    "active": true
  }
}
```

--------------------------------

### Sample JSON Response for Get All Boards

Source: https://superthread.com/docs/api-docs/boards/get-boards

This is an example of the JSON response structure returned by the Superthread API when fetching all boards for a team. It includes details about the boards, their order, and associated list and card information.

```json
{
  "cursor": "dmsjqh9d8w1hdjosjaasda",
  "count": 14,
  "board_order": {},
  "boards": [
    {
      "id": "24",
      "project_id": "3",
      "team_id": "tDsu0j19",
      "title": "My Board",
      "content": "<string>",
      "icon": "shield",
      "color": "<string>",
      "image_urls": "<string>",
      "thumbnail_url": "https://s3.....com/thumbnail.png",
      "user_id": "u2erXoQq",
      "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": "somebody@example.com",
          "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": "somebody@example.com",
          "email_verified": false
        }
      },
      "time_created": 1608742037016,
      "time_updated": 1608742037016,
      "members": [
        {
          "user_id": "u-dsu0j19",
          "assigned_date": 1608742037016,
          "role": "admin"
        }
      ],
      "lists": [
        {
          "id": "41",
          "team_id": "tDsu0j19",
          "title": "My list",
          "content": "<string>",
          "behavior": "backlog",
          "board_id": "43",
          "user_id": "u981hdaT",
          "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
            }
          },
          "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
            }
          },
          "project_id": "5",
          "icon": "shield",
          "color": "<string>",
          "card_order": {},
          "total_cards": 5,
          "time_created": 1608742037016,
          "time_updated": 1608742037016,
          "cards": [
            {
              "id": "2700",
              "type": "card",
              "icon": {
                "type": "image",
                "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
                "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
                "color": "black",
                "emoji": "thumbsup"
              },
              "team_id": "tDsu0j19",
              "title": "My Card",
              "content": "Some card content",
              "schema": 1,
              "collaboration": {
                "token": "<string>"
              },
              "status": "started",
              "priority": 1,
              "board_id": "12",
              "board_title": "<string>",
              "list_id": "41",
              "list_color": "<string>",
              "list_title": "<string>",
              "sprint_id": "4s12",
              "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": "somebody@example.com",
                  "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": "somebody@example.com",
                  "email_verified": false
                }
              }
            }
          ]
        }
      ]
    }
  ]
}
```

--------------------------------

### Markdown Formatting Examples

Source: https://superthread.com/docs/help/pages-and-subpages

Demonstrates various markdown syntax for text formatting, including italics, bold, strikethrough, inline code, lists, code blocks, horizontal rules, and headings. Useful for quickly styling documents.

```markdown
*italic*
_italic_

**bold**
__bold__

~~strikethrough~~

`inline code`

* bullet list
1. numbered list
[] checklist

```code block```

--- page divider

# H1
## H2
### H3
#### H4
```

--------------------------------

### Project Data Structure Example

Source: https://superthread.com/docs/api-docs/cards/create-a-card

This JSON object illustrates the data structure for a project within Superthread. It contains project details, card information, comments, watching/bookmarking status, and associated external links and hints.

```json
{
  "color": "blue",
  "total_cards": 17
}
],
"total_comments": 3,
"total_files": 1,
"is_watching": true,
"is_bookmarked": true,
"project_id": "<string>",
"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
    }
  }
],
"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
    }
  }
],
"estimate": 2,
"epic": {
  "id": "e-123",
  "title": "Epic Title",
  "icon": {
    "type": "image",
    "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
    "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
    "color": "black",
    "emoji": "thumbsup"
  }
}
}
```

--------------------------------

### Superthread Project Card Data Example

Source: https://superthread.com/docs/api-docs/cards/get-a-card

This snippet shows the structure of a project card within Superthread, including details like titles, dates, assigned members, checklists, and related cards. It covers core task management information.

```json
{
  "email_addr": "somebody@example.com",
  "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": {},
"parent_card": {
  "title": "Implement service requirements",
  "card_id": "42",
  "list_color": "<string>",
  "status": "started"
},
"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,
"archived_board": 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,
"is_bookmarked": true,
"project_id": "<string>",
"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
    }
  }
],
"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
    }
  }
],
"estimate": 2,
"epic": {
  "id": "e-123",
  "title": "Epic Title",
  "icon": {
    "type": "image",
    "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
    "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
    "color": "black",
    "emoji": "thumbsup"
  }
}
}
```

--------------------------------

### Create Project with cURL

Source: https://superthread.com/docs/api-docs/spaces/create-a-space

Demonstrates how to create a new project in Superthread using a cURL request. This includes setting project details like title, description, icon, privacy settings, and members. The API expects a JSON payload with these attributes.

```shell
curl --request POST \
  --url https://api.superthread.com/v1/{team_id}/projects \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "My Project Title",
  "description": "Project description",
  "icon": {
    "type": "image",
    "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
    "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
    "color": "black",
    "emoji": "thumbsup"
  },
  "is_public": false,
  "is_private": false,
  "overview_page_id": "22",
  "members": [
    {
      "user_id": "u-dsu0j19",
      "role": "admin"
    }
  ],
  "estimate_system": "",
  "is_view_only": true
}'
```

--------------------------------

### Epic Card JSON Response Structure

Source: https://superthread.com/docs/api-docs/projects/get-a-project

This is an example JSON response for a successful request to get an epic card. It details the various properties of an epic, including its ID, title, content, status, associated users, checklists, and linked cards. This structure is used to represent epic data within the Superthread application.

```json
{
  "epic": {
    "id": "2700",
    "type": "epic",
    "team_id": "tDsu0j19",
    "icon": {
      "type": "image",
      "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
      "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": "somebody@example.com",
        "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": "somebody@example.com",
        "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
        }
      }
    ],
    "hints": [
      {
        "type": "tag",
        "tag": {
          "name": "bug"
        },
        "relation": {
          "card": {
            "title": "Create illustration for upcoming holidays",
            "card_id": "42"
          }
        }
      }
    ]
  }
}
```

--------------------------------

### Get All Boards (cURL)

Source: https://superthread.com/docs/api-docs/boards/get-boards

This snippet demonstrates how to use cURL to make a GET request to the Superthread API to retrieve all boards for a specified team_id. It requires the team_id as a path parameter.

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

--------------------------------

### Create Cards with 'C' Shortcut

Source: https://superthread.com/docs/help/quick-start-guide

The 'C' shortcut allows users to create new cards from anywhere within the application. This streamlines the process of adding new tasks or issues.

```text
C
```
Tokens:
Raw