dist/api.html

<!DOCTYPE html>
<!--[if IE 8]> <html lang="en" class="ie8"> <![endif]-->
<!--[if IE 9]> <html lang="en" class="ie9"> <![endif]-->
<!--[if !IE]><!--> <html lang="en"> <!--<![endif]-->
<head>
    <title>Zube Docs | API Documentation</title>
    <!-- Meta -->
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width,initial-scale=1">
    <meta name="description" content="Learn how to use Zube's API endpoints to supercharge your project management workflow.">
    <link rel="icon" type="image/ico" href="/docs/favicons/76806d705602d86fde0ff7533a567bcd.favicon.ico">
    <link rel="apple-touch-icon" sizes="57x57" href="/docs/favicons/4ee898306d181155970a3ec379fea6b5.apple-icon-57x57.png">
    <link rel="apple-touch-icon" sizes="60x60" href="/docs/favicons/a7cbf04e1e51ceffd5b8b4715caa9bec.apple-icon-60x60.png">
    <link rel="apple-touch-icon" sizes="72x72" href="/docs/favicons/45a0045b5828a0c8719175df9cff4d73.apple-icon-72x72.png">
    <link rel="apple-touch-icon" sizes="76x76" href="/docs/favicons/99bd244d78e20f6a8b6384ac6b450c95.apple-icon-76x76.png">
    <link rel="apple-touch-icon" sizes="114x114" href="/docs/favicons/0df6ea3629cd40e9b11bd3b0c793a998.apple-icon-114x114.png">
    <link rel="apple-touch-icon" sizes="120x120" href="/docs/favicons/21a05b3a4a7db786a72082f5aa74f9b8.apple-icon-120x120.png">
    <link rel="apple-touch-icon" sizes="144x144" href="/docs/favicons/be4b6500f270210c3437facd3322c28b.apple-icon-144x144.png">
    <link rel="apple-touch-icon" sizes="152x152" href="/docs/favicons/4152852cd3be1207fb77de56a272a6cc.apple-icon-152x152.png">
    <link rel="apple-touch-icon" sizes="180x180" href="/docs/favicons/083e6470c41a37c8dbb5b5d4206078b5.apple-icon-180x180.png">
    <link rel="icon" type="image/png" sizes="192x192" href="/docs/favicons/a82779e90d4d46deb2dbc68e0971352b.android-icon-192x192.png">
    <link rel="icon" type="image/png" sizes="32x32" href="/docs/favicons/20612186ed82559c9ddfff6f843ef1f4.favicon-32x32.png">
    <link rel="icon" type="image/png" sizes="96x96" href="/docs/favicons/9437c2b344073f0867b0f3f15179dd35.favicon-96x96.png">
    <link rel="icon" type="image/png" sizes="16x16" href="/docs/favicons/2bdcc1c418cd50d7b58214b7ccf083a8.favicon-16x16.png">
    <link rel="manifest" href="/docs/favicons/b58fcfa7628c9205cb11a1b2c3e8f99a.manifest.json">
    <meta name="msapplication-TileColor" content="#ffffff">
    <meta name="msapplication-TileImage" content="/docs/favicons/be4b6500f270210c3437facd3322c28b.ms-icon-144x144.png">
    <meta name="theme-color" content="#ffffff">
    <link href="https://fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800" rel="stylesheet" type="text/css">
    <link href="//fonts.googleapis.com/css?family=Lato:300,400" rel="stylesheet" type="text/css">

    <link rel="stylesheet" href="/docs/styles/c27c4f91ae58aafe89b55170dbcacd3a.main.css">

    <script src="/docs/scripts/f1eb1d6831216d089fe1c9201cfd2076.vendor.js"></script>
    <script src="/docs/scripts/171b99af38e92de98631e9180b9d6efe.index.js"></script>

    <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
    <!--[if lt IE 9]>
      <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
      <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->

</head>

<body id="api-documentation" class="body-blue">
    <div class="page-wrapper">
        <!-- ******Header****** -->
        <header id="header" class="header">
            <div id="back-to-zube">
                <a href="/"><i class="zubeicon-home"></i> Back to Zube</a>
            </div>
            <div class="container">
                <div class="branding">
                    <h1 class="logo">
                        <a href="/docs">
                            <span aria-hidden="true" class="zubeicon-zube-mark icon"></span>
                            <span class="text-bold">Zube</span> <span class="text-highlight">Docs</span>
                        </a>
                    </h1>
                </div><!--//branding-->
                <ol class="breadcrumb">
                    <li><a href="/docs">Home</a></li>
                    <li class="active">API Documentation</li>
                </ol>
            </div><!--//container-->
        </header><!--//header-->
        <div class="doc-wrapper">
            <div class="container">
                <div id="doc-header" class="doc-header text-center">
                    <h1 class="doc-title"><i class="icon fa fa-paper-plane"></i> API Documentation</h1>
                    <div class="meta"><i class="fa fa-clock-o"></i> Last updated: Oct 25, 2021</div>
                </div><!--//doc-header-->
                <div class="doc-body">
                    <div class="doc-content">
                        <div class="content-inner">
                            <section id="getting-started-section" class="doc-section">
    <h2 class="section-title">Getting Started with the Zube API</h2>
    
        <div id="authentication-section" class="section-block">
            
                <h3 class="block-title">Authentication</h3>
            
            <div id="generating-a-private-key" class="section-block">
    <h4>Generating a Private Key</h4>
    <p>
        To access the Zube API, you first need to generate a private key. You will then use this private key to sign access token requests.
    </p>
    <ol class="list">
        <li>
            Log in to Zube, navigate to your profile settings page and click on the API Access tab.
            <a tabindex="0" data-trigger="focus" data-toggle="popover" data-content="You can find a link to your settings page at the bottom of any project navigation sidebar or by clicking on your picture at the top of the home dashboard screen.">
                <i class="fa fa-question"></i>
            </a>
        </li>
        <li>
            Click the 'Generate an API Key' button. You will be prompted to download a .pem file containing your Private API Key. Click save.
            <div class="callout-block callout-warn">
                <p>
                    Make sure to store this file! Zube only stores the public portion of the key and you will not be able to view this key again.
                </p>
            </div>
        </li>
        <li>
            After you've generated your first private key, you will be issued a Client Id. You will also be shown the fingerprint for your private key, which you can use to <a href="#verifying-a-private-key">verify the key</a> if you wish.
        </li>
    </ol>
    <div class="screenshot-holder">
      <a href="/docs/images/24649cea4ae54ba1c0ffc31994861470.private_key_ids.png" data-toggle="lightbox" data-title="Example API Key Information in Zube"><img class="img-responsive" src="/docs/images/24649cea4ae54ba1c0ffc31994861470.private_key_ids.png" alt="screenshot"></a>
      <a class="mask" href="/docs/images/24649cea4ae54ba1c0ffc31994861470.private_key_ids.png" data-toggle="lightbox" data-title="Example API Key Information in Zube"><i class="icon fa fa-search-plus"></i></a>
    </div>
</div>
<div id="requesting-an-api-access-token" class="section-block">
    <h4>Requesting an API Access Token</h4>
    <p>
        Before you can send requests to Zube's API endpoints, you will need an access token. Before you can request an access token from Zube, you will need to create a refresh <a href="https://jwt.io/introduction/" target="_blank">JSON Web Token (JWT)</a> signed by your private key and encoded using the <code class="inline">RS256</code> algorithm. Zube checks the key of this refresh JWT against the public key stored by Zube and returns a new access JWT that you use to access all other API endpoints.
    </p>
    <div class="code-block">
        As an example, the following Node.js code can be used to generate the refresh JWT used to request an API access token.
        <pre><code class="language-javascript">var fs = require(&#x27;fs&#x27;);
var jsonwebtoken = require(&#x27;jsonwebtoken&#x27;); // $ npm install jsonwebtoken

var client_id = CLIENT_ID;
var private_key = fs.readFileSync(PATH_TO_PEM_FILE);

var now = Math.floor(Date.now() / 1000);
var refresh_jwt = jsonwebtoken.sign({
    iat: now,      // Issued at time
    exp: now + 60, // JWT expiration time (10 minute maximum)
    iss: client_id // Your Zube client id
}, private_key, { algorithm: &#x27;RS256&#x27; });

console.log(refresh_jwt);</code></pre>
    </div>
    <p>
      Replace <code class="inline">CLIENT_ID</code> and <code class="inline">PATH_TO_PEM_FILE</code> in the above code with your information.
    </p>
    <p>
      The code above creates a refresh JWT with a one minute expiry. You can create your refresh JWT with an expiry of up to 10 minutes. Once your refresh JWT is expired, you will need to generate a new refresh JWT to request new access tokens.
    </p>
    <p>
      After creating the refresh JWT, you can request a new access token. Set your refresh JWT and Client Id in the <code class="inline">Header</code> of the API request to the tokens endpoint:
    </p>
    <p>
      <pre><code class="language-bash">curl -i \
-H &#x22;Authorization: Bearer REFRESH_JWT&#x22; \
-H &#x22;X-Client-ID: CLIENT_ID&#x22; \
-H &#x22;Accept: application/json&#x22; \
-X POST \
https://zube.io/api/users/tokens</code></pre>
    </p>
    <p>
      <code class="inline">REFRESH_JWT</code> and <code class="inline">CLIENT_ID</code> are the values you must replace.
    </p>
    <p>
      The API request above will return an access token, your <code class="inline">ACCESS_JWT</code>, which you can use to make further requests to Zube's API endpoints.
    </p>
    <pre><code class="language-bash">curl -i \
-H &#x22;Authorization: Bearer ACCESS_JWT&#x22; \
-H &#x22;X-Client-ID: CLIENT_ID&#x22; \
-H &#x22;Accept: application/json&#x22; \
https://zube.io/api/ANY_END_POINT</code></pre>
  <p>
    NOTE: The access JWT in only valid for 24 hours, after which you will need to request a new access token by repeating the steps outlined above.
  </p>
</div>
<div id="verifying-a-private-key" class="section-block">
  <h4>Verifying a Private Key</h4>
  <p>
    Zube generates a fingerprint for your private and public key pair using a SHA-1 hash function. You can verify that your private key matches the public key stored on Zube by generating the fingerprint of your private key and comparing it to the fingerprint displayed on Zube.

    To verify your private key:
    </p><ol class="list">
      <li>
        Generate the fingerprint for your private key locally with the following command:
        <pre><code class="language-bash">openssl rsa -in PATH_TO_PEM_FILE -pubout -outform DER | openssl sha1 -c</code></pre>
      </li>
      <li>
        Compare the resulting fingerprint to the fingerprint displayed on Zube for your private key. They should match.
      </li>
    </ol>
  <p></p>
  <div class="screenshot-holder">
    <a href="/docs/images/24649cea4ae54ba1c0ffc31994861470.private_key_ids.png" data-toggle="lightbox" data-title="Example API Key Information in Zube"><img class="img-responsive" src="/docs/images/24649cea4ae54ba1c0ffc31994861470.private_key_ids.png" alt="screenshot"></a>
    <a class="mask" href="/docs/images/24649cea4ae54ba1c0ffc31994861470.private_key_ids.png" data-toggle="lightbox" data-title="Example API Key Information in Zube"><i class="icon fa fa-search-plus"></i></a>
  </div>
</div>
<div id="deleting-a-private-key" class="section-block">
  <h4>Deleting a Private Key</h4>
  <p>
    You can remove a lost, compromised or unwanted private key by deleting it in the Zube interface. After you have deleted your private key, you will be able to generate a new one.
  </p>
</div>

        </div>
    
        <div id="example-request-response-section" class="section-block">
            
                <h3 class="block-title">Example Request Response</h3>
            
            <div id="example-request" class="section-block">
    <h4>Example Request</h4>
    <p>
      You can find instructions for getting your <code class="inline">CLIENT_ID</code> and generating your <code class="inline">ACCESS_JWT</code> in the <a href="#authentication">Authentication</a> section above.
    </p>
    <p>
      To send a request to a Zube API endpoint, include your <code class="inline">ACCESS_JWT</code> and <code class="inline">CLIENT_ID</code> in the <code class="inline">Header</code> for your request.
    </p>
    <p>
      The code below will send a <code class="inline">GET</code> request to the <code class="inline">projects</code> endpoint.
    </p>
    <pre><code class="language-bash">curl -i \
-H &#x22;Authorization: Bearer ACCESS_JWT&#x22; \
-H &#x22;X-Client-ID: CLIENT_ID&#x22; \
-H &#x22;Accept: application/json&#x22; \
https://zube.io/api/projects</code></pre>
</div>
<div id="example-response" class="section-block">
    <h4>Example Response</h4>
    <p>
      The code above will return a JSON object:
    </p>

    <pre><code class="language-json">{
  "pagination":{
    "page":1,
    "per_page":30,
    "total_pages":1,
    "total":1
  },
  "data":[
    {
      "id":123456,
      "account_id":54321,
      "description":"The place to organize our web application",
      "name":"Web Project",
      "created_at":"2018-07-06T03:52:29.513Z",
      "updated_at":"2018-07-06T03:52:29.513Z",
      "slug":"web-project",
      "private":true,
      "priority_format":"number",
      "priority":true,
      "points":true,
      "triage":false,
      "upvotes":false,
      "sources":[
        {
          "id":123456789,
          "github_owner_id":87654321,
          "description":"Javascript frontend repository",
          "full_name":"zubeio/js-frontend",
          "homepage":null,
          "html_url":"https://github.com/zubeio/js-frontend",
          "name":"js-frontend",
          "private":true,
          "created_at":"2018-09-13T19:53:09.000Z",
          "updated_at":"2019-07-02T22:25:48.000Z",
          "webhook_verified_at":"2019-07-03T23:29:09.894Z",
          "initial_import_at":"2018-12-17T04:09:49.348Z"
        }
      ],
      "workspaces":[
        {
          "id":654321,
          "project_id":123456,
          "description":null,
          "name":"Product Team Workspace",
          "slug":"product-team-workspace",
          "private":true,
          "priority_format":"number",
          "priority":true,
          "points":true,
          "upvotes":false,
          "created_at":"2018-12-17T04:09:49.348Z",
          "updated_at":"2018-12-17T04:09:49.348Z",
          "archive_merged_prs":false,
          "use_category_labels":false
        }
      ]
    }
  ]
}</code></pre>
</div>

        </div>
    
        <div id="request-parameters-section" class="section-block">
            
                <h3 class="block-title">Request Parameters</h3>
            
            <div id="pagination-params" class="section-block">
    <h4>Pagination</h4>
    <p>
      Most endpoints that return lists will return their data as paginated collections defaulting to 30 items per page. You can specify further pages by passing the <code class="inline">page</code> parameter. For pages that allow customized pagination, you can set the number of results per page with the <code class="inline">per_page</code> parameter.
    </p>
    <pre><code class="language-bash">curl -i \
-H "Authorization: Bearer ACCESS_JWT" \
-H "X-Client-ID: CLIENT_ID" \
"https://zube.io/api/cards?page=2&per_page=10"</code></pre>
</div>
<div id="ordering-params" class="section-block">
  <h4>Ordering</h4>
  <p>
    Most endpoints that return lists accept <code class="inline">order[by]</code> and <code class="inline">order[direction]</code> parameters. <code class="inline">order[direction]</code> accepts either <code class="inline">asc</code> or <code class="inline">desc</code>. The possible attributes available for <code class="inline">order[by]</code> can be found in the table below the endpoint description.
  </p>
  <pre><code class="language-bash">curl -i \
-H "Authorization: Bearer ACCESS_JWT" \
-H "X-Client-ID: CLIENT_ID" \
"https://zube.io/api/cards?order%5Bby%5D=points&order%5Bdirection%5D=desc"</code></pre>
</div>
<div id="where-params" class="section-block">
    <h4>Filtering</h4>
    <p>
      Most endpoints that return lists can be filtered using <code class="inline">where</code>. For endpoints that support filtering, the attributes available for <code class="inline">where</code> appear in the table below the endpoint. All filtering is scoped under the <code class="inline">where</code> query parameter. For example, you'd use <code class="inline">where[project_id]</code> to filter for a direct match of cards that are on the specified project.
    </p>
    <pre><code class="language-bash">curl -i \
-H "Authorization: Bearer ACCESS_JWT" \
-H "X-Client-ID: CLIENT_ID" \
"https://zube.io/api/cards?where%5Bproject_id%5D=3"</code></pre>
</div>
<div id="selects-params" class="section-block">
  <h4>Select</h4>
  <p>
    For most endpoints that return lists you can specify which data attributes you'd like included in the response using the <code class="inline">select</code> parameter. <code class="inline">select</code> takes an array of attributes. For example to select just the <code class="inline">id</code> and <code class="inline">title</code> attributes of cards you'd use <code class="inline">select[]=id&select[]=title</code>
  </p>
  <p>
    Note: For convenience, many models return with some of their associated models populated. For endpoints where a model returns with associated model data, the associated data will not be removed when a request includes <code class="inline">select</code>, so <code class="inline">select</code> may be of limited use in those cases.
  </p>
    <pre><code class="language-bash">curl -i \
-H "Authorization: Bearer ACCESS_JWT" \
-H "X-Client-ID: CLIENT_ID" \
"https://zube.io/api/cards?select%5B%5D=id&select%5B%5D=title"</code></pre>
</div>

        </div>
    
        <div id="etag-caching-section" class="section-block">
            
                <h3 class="block-title">ETag Caching</h3>
            
            <div id="conditional-requests" class="section-block">
    <h4>Conditional requests</h4>
    <p>
      Most responses will return with an <code class="inline">ETag</code> header. You are highly encouraged to make use of ETags for subsequent requests to the same endpoint. If the response would be the same, a <code class="inline">304 Not Modified</code> will be returned instead.
    </p>
    <p>
      For example, if you received a response to the cards endpoint with the response header <code class="inline">ETag: "27e-BpOwiFj52s046/zdOTfiQ0fepw8"</code>, then you'd include it as the  value of the request header <code class="inline">If-None-Match</code> for subsequent requests like so:
    </p>
    <pre><code class="language-bash">curl -i \
-H "Authorization: Bearer ACCESS_JWT" \
-H "X-Client-ID: CLIENT_ID" \
-H 'If-None-Match: "27e-BpOwiFj52s046/zdOTfiQ0fepw8"' \
https://zube.io/api/cards</code></pre>
</div>

        </div>
    
        <div id="data-mutations" class="section-block">
            
                <h3 class="block-title">Data Mutations</h3>
            
            <div id="Data Mutations" class="section-block">
    <h4>Body Data</h4>
    <p>
      When body data is sent for <code class="inline">POST</code> or <code class="inline">PUT</code> requests, it should be sent as valid JSON. Any request that sends body data should also include the required header <code class="inline">"Content-Type: application/json"</code>.
    </p>
    <pre><code class="language-bash">curl -i \
-H "Authorization: Bearer ACCESS_JWT" \
-H "X-Client-ID: CLIENT_ID" \
-H "Content-Type: application/json" \
-d '{"project_id":YOUR_PROJECT_ID,"title":"Hello World"}' \
-X POST \
https://zube.io/api/cards</code></pre>
</div>

        </div>
    
        <div id="responsible-usage-section" class="section-block">
            
                <h3 class="block-title">Responsible Usage</h3>
            
            <div id="rate-limiting" class="section-block">
    <h4>Rate Limiting</h4>
    <p>
      You can can make at most one (1) request per second. While short bursts of a few requests at a slightly higher rate are permitted, exceeding one request per second for any extended duration will result in rejection of your requests and may constitute abuse.
    </p>
</div>
<div id="abuse" class="section-block">
    <h4>Abuse</h4>
    <p>
      Never make concurrent requests or make requests at a rate faster than one per second. If you accidentally hit the rate limit, please back off the rate of your requests immediately. If you happen to trigger abuse detection, please do your best not to trigger it again. Failure to observe these rules will result in rejection of your requests and possible suspension from future API usage.
    </p>
</div>

        </div>
    
</section>
<section id="api-endpoints-section" class="doc-section">
    <h2 class="section-title">API Endpoints</h2>
    <div id="person" class="section-block endpoint-section">
  <h3 class="block-title section">Person</h3>
  
  
  <div class="endpoint">
  <h5 class="endpoint-name" id="get-the-current-persons-information">Get the current person&#39;s information</h5>
  <div class="endpoint-path">
    GET /api/current_person
  </div>
  

  
  
</div>

</div>
<div id="accounts" class="section-block endpoint-section">
  <h3 class="block-title section">Accounts</h3>
  
  
    <div class="note">
      Note: Zube Organizations are referred to as <code class="inline">accounts</code> in the Zube API.
    </div>
  
  <div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-accounts">Get a list of accounts</h5>
  <div class="endpoint-path">
    GET /api/accounts
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
              <tr>
                <td class="name">
                  <code class="inline">annual_amount</code>
                </td>
                <td class="type">
                  <span>numeric</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">discount</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">display_name</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">first_billable_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">has_annual_billing</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">has_github_billing</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">private_users_count</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">seats</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">slug</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">status</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-an-account">Get an account</h5>
  <div class="endpoint-path">
    GET /api/accounts/:account_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-account-admins">Get a list of account admins</h5>
  <div class="endpoint-path">
    GET /api/accounts/:account_id/admin_members
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">avatar_path_is_locked</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">github_user_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">is_user</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">name</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">name_is_locked</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">username</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="create-an-account-admin">Create an account admin</h5>
  <div class="endpoint-path">
    POST /api/accounts/:account_id/admin_members
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">person_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="remove-an-account-admin">Remove an account admin</h5>
  <div class="endpoint-path">
    DELETE /api/accounts/:account_id/admin_members/:admin_member_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-account-members">Get a list of account members</h5>
  <div class="endpoint-path">
    GET /api/accounts/:account_id/members
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">avatar_path_is_locked</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">github_user_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">is_user</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">name</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">name_is_locked</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">username</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="create-an-account-member">Create an account member</h5>
  <div class="endpoint-path">
    POST /api/accounts/:account_id/members
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">person_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="remove-an-account-member">Remove an account member</h5>
  <div class="endpoint-path">
    DELETE /api/accounts/:account_id/members/:member_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-projects-for-an-account">Get a list of projects for an account</h5>
  <div class="endpoint-path">
    GET /api/accounts/:account_id/projects
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
              <tr>
                <td class="name">
                  <code class="inline">account_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">auto_add_github_users</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">default_epic_list_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">name</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
          
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">private</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">should_use_fibonacci_scale</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">slug</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>

</div>
<div id="cards" class="section-block endpoint-section">
  <h3 class="block-title section">Cards</h3>
  
  
  <div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-cards">Get a list of cards</h5>
  <div class="endpoint-path">
    GET /api/cards
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
              <tr>
                <td class="name">
                  <code class="inline">body</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">category_name</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">closed_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">closer_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">comments_count</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">creator_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">epic_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">last_comment_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">number</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">points</code>
                </td>
                <td class="type">
                  <span>number</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">priority</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">project_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">search_key</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">sprint_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">state</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">status</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">upvotes_count</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">was_archived_from_404</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">workspace_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
        <h4>Extended Parameters</h4>
        <div class="note">
          <strong>Note:</strong> This endpoint accepts the following extended query parameters
        </div>
        <table class="table table-bordered">
          <thead>
              <tr>
                  <th>name</th><th>type</th><th>required</th><th>notes</th>
              </tr>
          </thead>
          <tbody>
            
                <tr>
                  <td class="name">
                    <code class="inline">where[created_after]</code>
                  </td>
                  <td class="type">
                    <span>timestamp</span>
                  </td>
                  <td class="required">
                    <span></span>
                  </td>
                  <td class="note">
                    <span></span>
                  </td>
                </tr>
            
                <tr>
                  <td class="name">
                    <code class="inline">where[updated_after]</code>
                  </td>
                  <td class="type">
                    <span>timestamp</span>
                  </td>
                  <td class="required">
                    <span></span>
                  </td>
                  <td class="note">
                    <span></span>
                  </td>
                </tr>
            
          </tbody>
        </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="create-a-card">Create a card</h5>
  <div class="endpoint-path">
    POST /api/cards
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">assignee_ids</code>
              </td>
              <td class="type">
                <span>Array</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span>Array of <code class="inline">assignee.id</code>s</span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">body</code>
              </td>
              <td class="type">
                <span>Text</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">category_name</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">epic_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">github_issue[milestone_id]</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">github_issue[source_id]</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span>Required if <code class="inline">github_issue</code> object is sent</span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">label_ids</code>
              </td>
              <td class="type">
                <span>Array</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span>Array of <code class="inline">label.id</code>s</span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">points</code>
              </td>
              <td class="type">
                <span>Number</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">priority</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span>Must be one of <code class="inline">1</code>, <code class="inline">2</code>, <code class="inline">3</code>, <code class="inline">4</code>, <code class="inline">5</code>, or <code class="inline">null</code></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">project_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">sprint_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">title</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">workspace_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-card">Get a card</h5>
  <div class="endpoint-path">
    GET /api/cards/:card_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="update-a-card">Update a card</h5>
  <div class="endpoint-path">
    PUT /api/cards/:card_id
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">assignee_ids</code>
              </td>
              <td class="type">
                <span>Array</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span>Array of <code class="inline">assignee.id</code>s</span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">body</code>
              </td>
              <td class="type">
                <span>Text</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">epic_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">github_issue[milestone_id]</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">label_ids</code>
              </td>
              <td class="type">
                <span>Array</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span>Array of <code class="inline">label.id</code>s</span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">points</code>
              </td>
              <td class="type">
                <span>Number</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">priority</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span>Must be one of <code class="inline">1</code>, <code class="inline">2</code>, <code class="inline">3</code>, <code class="inline">4</code>, <code class="inline">5</code>, or <code class="inline">null</code></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">project_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">sprint_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">state</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span>Only accepts <code class="inline">open</code> or <code class="inline">closed</code></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">title</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">workspace_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="archive-a-card">Archive a card</h5>
  <div class="endpoint-path">
    PUT /api/cards/:card_id/archive
  </div>
  
    <div class="note">
      <strong>Note:</strong> This endpoint does not take any data
    </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="move-a-card">Move a card</h5>
  <div class="endpoint-path">
    PUT /api/cards/:card_id/move
  </div>
  
    <div class="note">
      <strong>Note:</strong> To move a card to a column on a workspace, pass:
        <pre><code class="language-javascript">destination: {
          position: CARD_POSITION,
          type: "category",
          name: NAME_OF_CATEGORY,
          workspace_id: YOUR_WORKSPACE_ID
        }</code></pre>
                To move a card to a project's triage, pass:
                <pre><code class="language-javascript">destination: {
          position: CARD_POSITION,
          type: "project"
        }</code></pre>
        
    </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">destination[name]</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span>Name of the destination category.</span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">destination[position]</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">destination[type]</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span>Only accepts <code class="inline">category</code> or <code class="inline">project</code></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">destination[workspace_id]</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span>Required if sending <code class="inline">destination[type]</code> as <code class="inline">category</code></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="add-a-card-to-a-source-repo">Add a card to a source repo</h5>
  <div class="endpoint-path">
    PUT /api/cards/:card_id/add_to_source
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">source_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span>You cannot change the source for a card that already has a source</span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-card-relations">Get a list of card relations</h5>
  <div class="endpoint-path">
    GET /api/card_relations
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
              <tr>
                <td class="name">
                  <code class="inline">card_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">linked_card_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="create-a-card-relationship">Create a card relationship</h5>
  <div class="endpoint-path">
    POST /api/card_relations
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">card_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">linked_card_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="remove-a-card-relationship">Remove a card relationship</h5>
  <div class="endpoint-path">
    DELETE /api/card_relations/:card_relation_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-card-comments">Get a list of card comments</h5>
  <div class="endpoint-path">
    GET /api/cards/:card_id/comments
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">card_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">creator_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="create-a-new-card-comment">Create a new card comment</h5>
  <div class="endpoint-path">
    POST /api/cards/:card_id/comments
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">body</code>
              </td>
              <td class="type">
                <span>Text</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="update-a-card-comment">Update a card comment</h5>
  <div class="endpoint-path">
    PUT /api/cards/:card_id/comments/:comment_id
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">body</code>
              </td>
              <td class="type">
                <span>Text</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="remove-a-card-comment">Remove a card comment</h5>
  <div class="endpoint-path">
    DELETE /api/cards/:card_id/comments/:comment_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-card-card-custom-field-dates">Get a list of card card custom field dates</h5>
  <div class="endpoint-path">
    GET /api/cards/:card_id/card_custom_field_dates
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
              <tr>
                <td class="name">
                  <code class="inline">card_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">custom_field_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">date</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-card-custom-field-date">Get a card custom field date</h5>
  <div class="endpoint-path">
    GET /api/cards/:card_id/card_custom_field_dates/:card_custom_field_date_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="create-a-new-card-custom-field-date">Create a new card custom field date</h5>
  <div class="endpoint-path">
    POST /api/cards/:card_id/card_custom_field_dates
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">custom_field_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">date</code>
              </td>
              <td class="type">
                <span>Timestamp</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="update-a-card-custom-field-date">Update a card custom field date</h5>
  <div class="endpoint-path">
    PUT /api/cards/:card_id/card_custom_field_dates/:card_custom_field_date_id
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">custom_field_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">date</code>
              </td>
              <td class="type">
                <span>Timestamp</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="remove-a-card-custom-field-date">Remove a card custom field date</h5>
  <div class="endpoint-path">
    DELETE /api/cards/:card_id/card_custom_field_dates/:card_custom_field_date_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-card-card-custom-field-numbers">Get a list of card card custom field numbers</h5>
  <div class="endpoint-path">
    GET /api/cards/:card_id/card_custom_field_numbers
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
              <tr>
                <td class="name">
                  <code class="inline">card_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">custom_field_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">number</code>
                </td>
                <td class="type">
                  <span>double precision</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-card-custom-field-number">Get a card custom field number</h5>
  <div class="endpoint-path">
    GET /api/cards/:card_id/card_custom_field_numbers/:card_custom_field_number_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="create-a-new-card-custom-field-number">Create a new card custom field number</h5>
  <div class="endpoint-path">
    POST /api/cards/:card_id/card_custom_field_numbers
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">custom_field_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">number</code>
              </td>
              <td class="type">
                <span>Float</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="update-a-card-custom-field-number">Update a card custom field number</h5>
  <div class="endpoint-path">
    PUT /api/cards/:card_id/card_custom_field_numbers/:card_custom_field_number_id
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">custom_field_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">number</code>
              </td>
              <td class="type">
                <span>Float</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="remove-a-card-custom-field-number">Remove a card custom field number</h5>
  <div class="endpoint-path">
    DELETE /api/cards/:card_id/card_custom_field_numbers/:card_custom_field_number_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-card-card-custom-field-texts">Get a list of card card custom field texts</h5>
  <div class="endpoint-path">
    GET /api/cards/:card_id/card_custom_field_texts
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
              <tr>
                <td class="name">
                  <code class="inline">card_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">custom_field_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">text</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-card-custom-field-text">Get a card custom field text</h5>
  <div class="endpoint-path">
    GET /api/cards/:card_id/card_custom_field_texts/:card_custom_field_text_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="create-a-new-card-custom-field-text">Create a new card custom field text</h5>
  <div class="endpoint-path">
    POST /api/cards/:card_id/card_custom_field_texts
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">custom_field_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">text</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="update-a-card-custom-field-text">Update a card custom field text</h5>
  <div class="endpoint-path">
    PUT /api/cards/:card_id/card_custom_field_texts/:card_custom_field_text_id
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">custom_field_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">text</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="remove-a-card-custom-field-text">Remove a card custom field text</h5>
  <div class="endpoint-path">
    DELETE /api/cards/:card_id/card_custom_field_texts/:card_custom_field_text_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-card-card-custom-field-single-selections">Get a list of card card custom field single selections</h5>
  <div class="endpoint-path">
    GET /api/cards/:card_id/card_custom_field_single_selections
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
              <tr>
                <td class="name">
                  <code class="inline">card_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">custom_field_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">single_select_option_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-card-custom-field-single-selection">Get a card custom field single selection</h5>
  <div class="endpoint-path">
    GET /api/cards/:card_id/card_custom_field_single_selections/:card_custom_field_single_selection_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="create-a-new-card-custom-field-single-selection">Create a new card custom field single selection</h5>
  <div class="endpoint-path">
    POST /api/cards/:card_id/card_custom_field_single_selections
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">custom_field_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">single_select_option_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="update-a-card-custom-field-single-selection">Update a card custom field single selection</h5>
  <div class="endpoint-path">
    PUT /api/cards/:card_id/card_custom_field_single_selections/:card_custom_field_single_selection_id
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">custom_field_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">single_select_option_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="remove-a-card-custom-field-single-selection">Remove a card custom field single selection</h5>
  <div class="endpoint-path">
    DELETE /api/cards/:card_id/card_custom_field_single_selections/:card_custom_field_single_selection_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-card-events">Get a list of card events</h5>
  <div class="endpoint-path">
    GET /api/cards/:card_id/events
  </div>
  
    <div class="note">
      <strong>Note:</strong> This endpoint does not take any parameters.
    </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-commit-references">Get a list of commit references</h5>
  <div class="endpoint-path">
    GET /api/cards/:card_id/commit_references
  </div>
  
    <div class="note">
      <strong>Note:</strong> This endpoint does not take any parameters.
    </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-card-subscriptions">Get a list of card subscriptions</h5>
  <div class="endpoint-path">
    GET /api/cards/:card_id/subscriptions
  </div>
  
    <div class="note">
      <strong>Note:</strong> Returns either zero or one subscription for the current user. This endpoint does not take any parameters
    </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="create-a-card-subscription">Create a card subscription</h5>
  <div class="endpoint-path">
    POST /api/cards/:card_id/subscriptions
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="remove-a-card-subscription">Remove a card subscription</h5>
  <div class="endpoint-path">
    DELETE /api/cards/:card_id/subscriptions/:subscription_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-related-tickets">Get a list of related tickets</h5>
  <div class="endpoint-path">
    GET /api/cards/:card_id/tickets
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
              <tr>
                <td class="name">
                  <code class="inline">assignee_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">cards_count</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">cards_status</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">closed_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">closer_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">comments_count</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">creator_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">customer_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">due_on</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">number</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">priority</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">project_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">search_key</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">start_date</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">state</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">status</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">title</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">track_cards</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">type</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-upvoters">Get a list of upvoters</h5>
  <div class="endpoint-path">
    GET /api/cards/:card_id/upvoters
  </div>
  
    <div class="note">
      <strong>Note:</strong> This endpoint does not take any parameters.
    </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="create-a-card-upvote">Create a card upvote</h5>
  <div class="endpoint-path">
    POST /api/cards/:card_id/upvotes
  </div>
  
    <div class="note">
      <strong>Note:</strong> Creates a card upvote for the current user. This endpoint does not take any data.
    </div>
  

  
  
</div>

</div>
<div id="categories" class="section-block endpoint-section">
  <h3 class="block-title section">Categories</h3>
  
  
    <div class="note">
      Note: Workspace columns are referred to as <code class="inline">categories</code> in the Zube API.
    </div>
  
  <div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-categories">Get a list of categories</h5>
  <div class="endpoint-path">
    GET /api/workspaces/:workspace_id/categories
  </div>
  
    <div class="note">
      <strong>Note:</strong> This endpoint does not take any parameters.
    </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-category">Get a category</h5>
  <div class="endpoint-path">
    GET /api/workspaces/:workspace_id/categories/:_categoryId
  </div>
  
    <div class="note">
      <strong>Note:</strong> <code class="inline">_categoryId</code> is an <code class="inline">ObjectId</code>, not an <code class="inline">integer</code>.
    </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-categories-metadata">Get a list of categories metadata</h5>
  <div class="endpoint-path">
    GET /api/workspaces/:workspace_id/categories_metadata
  </div>
  
    <div class="note">
      <strong>Note:</strong> Returns a set of categories without their lists of cards. This endpoint does not take any parameters.
    </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-categorys-metadata">Get a category&#39;s metadata</h5>
  <div class="endpoint-path">
    GET /api/workspaces/:workspace_id/categories_metadata/:_categoryId
  </div>
  
    <div class="note">
      <strong>Note:</strong> Returns a single category without it's list of cards. <code class="inline">_categoryId</code> is an <code class="inline">ObjectId</code>, not an <code class="inline">integer</code>.
    </div>
  

  
  
</div>

</div>
<div id="custom-fields" class="section-block endpoint-section">
  <h3 class="block-title section">Custom Fields</h3>
  
  
  <div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-custom-fields">Get a list of custom fields</h5>
  <div class="endpoint-path">
    GET /api/projects/:project_id/custom_fields
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">data_type</code>
                </td>
                <td class="type">
                  <span>USER-DEFINED</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">name</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">project_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-custom-field">Get a custom field</h5>
  <div class="endpoint-path">
    GET /api/projects/:project_id/custom_fields/:custom_field_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="create-a-new-custom-field">Create a new custom field</h5>
  <div class="endpoint-path">
    POST /api/projects/:project_id/custom_fields
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">data_type</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span>Must be one of <code class="inline">date</code>, <code class="inline">number</code>, <code class="inline">text</code>, or <code class="inline">single_select</code></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">name</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="update-a-custom-field">Update a custom field</h5>
  <div class="endpoint-path">
    PUT /api/projects/:project_id/custom_fields/:custom_field_id
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">text</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="remove-a-custom-field">Remove a custom field</h5>
  <div class="endpoint-path">
    DELETE /api/projects/:project_id/custom_fields/:custom_field_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-custom-field-single-select-options">Get a list of custom field single select options</h5>
  <div class="endpoint-path">
    GET /api/custom_fields/:custom_field_id/single_select_options
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">custom_field_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">text</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-custom-field-single-select-option">Get a custom field single select option</h5>
  <div class="endpoint-path">
    GET /api/custom_fields/:custom_field_id/single_select_options/:single_select_option_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="create-a-new-custom-field-single-select-option">Create a new custom field single select option</h5>
  <div class="endpoint-path">
    POST /api/custom_fields/:custom_field_id/single_select_options
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">text</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="update-a-custom-field-single-select-option">Update a custom field single select option</h5>
  <div class="endpoint-path">
    PUT /api/custom_fields/:custom_field_id/single_select_options/:single_select_option_id
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">text</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="remove-a-custom-field-single-select-option">Remove a custom field single select option</h5>
  <div class="endpoint-path">
    DELETE /api/custom_fields/:custom_field_id/single_select_options/:single_select_option_id
  </div>
  

  
  
</div>

</div>
<div id="epics" class="section-block endpoint-section">
  <h3 class="block-title section">Epics</h3>
  
  
  <div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-epics">Get a list of epics</h5>
  <div class="endpoint-path">
    GET /api/projects/:project_id/epics
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
              <tr>
                <td class="name">
                  <code class="inline">assignee_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">cards_status</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">closed_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">closed_cards_count</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">closed_points</code>
                </td>
                <td class="type">
                  <span>number</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">closer_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">comments_count</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">creator_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">due_on</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">epic_list_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">number</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">open_cards_count</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">open_points</code>
                </td>
                <td class="type">
                  <span>number</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">priority</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">project_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">rank</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">search_key</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">start_date</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">state</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">status</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">title</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">track_cards</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">workspace_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
        <h4>Extended Parameters</h4>
        <div class="note">
          <strong>Note:</strong> This endpoint accepts the following extended query parameters
        </div>
        <table class="table table-bordered">
          <thead>
              <tr>
                  <th>name</th><th>type</th><th>required</th><th>notes</th>
              </tr>
          </thead>
          <tbody>
            
                <tr>
                  <td class="name">
                    <code class="inline">where[after_number]</code>
                  </td>
                  <td class="type">
                    <span>integer</span>
                  </td>
                  <td class="required">
                    <span></span>
                  </td>
                  <td class="note">
                    <span></span>
                  </td>
                </tr>
            
                <tr>
                  <td class="name">
                    <code class="inline">where[created_after]</code>
                  </td>
                  <td class="type">
                    <span>timestamp</span>
                  </td>
                  <td class="required">
                    <span></span>
                  </td>
                  <td class="note">
                    <span></span>
                  </td>
                </tr>
            
                <tr>
                  <td class="name">
                    <code class="inline">where[updated_after]</code>
                  </td>
                  <td class="type">
                    <span>timestamp</span>
                  </td>
                  <td class="required">
                    <span></span>
                  </td>
                  <td class="note">
                    <span></span>
                  </td>
                </tr>
            
          </tbody>
        </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="create-an-epic">Create an epic</h5>
  <div class="endpoint-path">
    POST /api/projects/:project_id/epics
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">after_target_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span><code class="inline">after_target_id</code> is the <code class="inline">id</code> of the epic after which this epic should be placed</span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">assignee_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">before_target_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span><code class="inline">before_target_id</code> is the <code class="inline">id</code> of the epic before which this epic should be placed</span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">color</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span>Hex color code string without preceding "#"</span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">description</code>
              </td>
              <td class="type">
                <span>Text</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">due_on</code>
              </td>
              <td class="type">
                <span>Timestamp</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">epic_list_id</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">label_ids</code>
              </td>
              <td class="type">
                <span>Array</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span>Array of <code class="inline">label.id</code>s</span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">target_position</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span>Refers to the target index position of the epic</span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">title</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">track_cards</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-an-epic">Get an epic</h5>
  <div class="endpoint-path">
    GET /api/projects/:project_id/epics/:epic_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="update-an-epic">Update an epic</h5>
  <div class="endpoint-path">
    PUT /api/projects/:project_id/epics/:epic_id
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">assignee_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">color</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span>Hex color code string without preceding "#"</span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">description</code>
              </td>
              <td class="type">
                <span>Text</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">due_on</code>
              </td>
              <td class="type">
                <span>Timestamp</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">epic_list_id</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">label_ids</code>
              </td>
              <td class="type">
                <span>Array</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span>Array of <code class="inline">label.id</code>s</span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">state</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span>Only accepts <code class="inline">open</code> or <code class="inline">closed</code></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">status</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span>Must be one of <code class="inline">new</code>, <code class="inline">queued</code>, <code class="inline">in_progress</code>, <code class="inline">completed</code>, <code class="inline">closed</code>, or <code class="inline">archived</code></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">title</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">track_cards</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="move-an-epic">Move an epic</h5>
  <div class="endpoint-path">
    PUT /api/projects/:project_id/epics/:epic_id/move
  </div>
  
    <div class="note">
      <strong>Note:</strong> Provide only one of <code class="inline">target_position</code>, <code class="inline">after_target_id</code> or <code class="inline">before_target_id</code>.
    </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">after_target_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span><code class="inline">after_target_id</code> is the <code class="inline">id</code> of the epic after which this epic should be placed</span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">assignee_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">before_target_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span><code class="inline">before_target_id</code> is the <code class="inline">id</code> of the epic before which this epic should be placed</span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">color</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span>Hex color code string without preceding "#"</span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">description</code>
              </td>
              <td class="type">
                <span>Text</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">due_on</code>
              </td>
              <td class="type">
                <span>Timestamp</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">epic_list_id</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">label_ids</code>
              </td>
              <td class="type">
                <span>Array</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span>Array of <code class="inline">label.id</code>s</span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">state</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span>Only accepts <code class="inline">open</code> or <code class="inline">closed</code></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">status</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span>Must be one of <code class="inline">new</code>, <code class="inline">queued</code>, <code class="inline">in_progress</code>, <code class="inline">completed</code>, <code class="inline">closed</code>, or <code class="inline">archived</code></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">target_position</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span>Refers to the target index position of the epic</span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">title</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">track_cards</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-epic-cards">Get a list of epic cards</h5>
  <div class="endpoint-path">
    GET /api/epics/:epic_id/cards
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
              <tr>
                <td class="name">
                  <code class="inline">body</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">category_name</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">closed_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">closer_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">comments_count</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">creator_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">epic_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">last_comment_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">number</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">points</code>
                </td>
                <td class="type">
                  <span>number</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">priority</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">project_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">search_key</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">sprint_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">state</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">status</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">upvotes_count</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">was_archived_from_404</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">workspace_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="add-a-card-to-an-epic">Add a card to an epic</h5>
  <div class="endpoint-path">
    POST /api/epics/:epic_id/cards
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">card_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="remove-a-card-from-an-epic">Remove a card from an epic</h5>
  <div class="endpoint-path">
    DELETE /api/epics/:epic_id/cards/:card_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-epic-comments">Get a list of epic comments</h5>
  <div class="endpoint-path">
    GET /api/epics/:epic_id/comments
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">card_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">creator_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="create-an-epic-comment">Create an epic comment</h5>
  <div class="endpoint-path">
    POST /api/epics/:epic_id/comments
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">body</code>
              </td>
              <td class="type">
                <span>Text</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="update-an-epic-comment">Update an epic comment</h5>
  <div class="endpoint-path">
    PUT /api/epics/:epic_id/comments/:comment_id
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">body</code>
              </td>
              <td class="type">
                <span>Text</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="remove-an-epic-comment">Remove an epic comment</h5>
  <div class="endpoint-path">
    DELETE /api/epics/:epic_id/comments/:comment_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-epic-events">Get a list of epic events</h5>
  <div class="endpoint-path">
    GET /api/epics/:epic_id/events
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
              <tr>
                <td class="name">
                  <code class="inline">actor_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">assignee_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">commit_id</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">event</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">github_issue_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>bigint</span>
                </td>
              </tr>
            
          
            
          
            
          
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">source_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-epic-subscriptions">Get a list of epic subscriptions</h5>
  <div class="endpoint-path">
    GET /api/epics/:epic_id/subscriptions
  </div>
  
    <div class="note">
      <strong>Note:</strong> Returns either zero or one subscription for the current user. This endpoint does not take any parameters.
    </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="create-an-epic-subscription">Create an epic subscription</h5>
  <div class="endpoint-path">
    POST /api/epics/:epic_id/subscriptions
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="remove-an-epic-subscription">Remove an epic subscription</h5>
  <div class="endpoint-path">
    DELETE /api/epics/:epic_id/subscriptions/:subscription_id
  </div>
  

  
  
</div>

</div>
<div id="epic-lists" class="section-block endpoint-section">
  <h3 class="block-title section">Epic Lists</h3>
  
  
  <div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-epic-lists">Get a list of epic lists</h5>
  <div class="endpoint-path">
    GET /api/projects/:project_id/epic_lists
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">name</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">project_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">rank</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="create-an-epic-list">Create an epic list</h5>
  <div class="endpoint-path">
    POST /api/projects/:project_id/epic_lists
  </div>
  
    <div class="note">
      <strong>Note:</strong> Provide only one of <code class="inline">target_position</code>, <code class="inline">after_target_id</code> or <code class="inline">before_target_id</code>.
    </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">after_target_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span><code class="inline">after_target_id</code> is the <code class="inline">id</code> of the epic list after which this epic list should be placed</span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">before_target_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span><code class="inline">before_target_id</code> is the <code class="inline">id</code> of the epic list before which this epic list should be placed</span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">name</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">target_position</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span>Refers to the target index position of the list.</span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-an-epic-list">Get an epic list</h5>
  <div class="endpoint-path">
    GET /api/projects/:project_id/epic_lists/:epic_list_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="update-an-epic-list">Update an epic list</h5>
  <div class="endpoint-path">
    PUT /api/projects/:project_id/epic_lists/:epic_list_id
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">name</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="move-an-epic-list">Move an epic list</h5>
  <div class="endpoint-path">
    PUT /api/projects/:project_id/epic_lists/:epic_list_id/move
  </div>
  
    <div class="note">
      <strong>Note:</strong> Provide only one of <code class="inline">target_position</code>, <code class="inline">after_target_id</code> or <code class="inline">before_target_id</code>.
    </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">after_target_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span><code class="inline">after_target_id</code> is the <code class="inline">id</code> of the epic list after which this epic list should be placed</span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">before_target_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span><code class="inline">before_target_id</code> is the <code class="inline">id</code> of the epic list before which this epic list should be placed</span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">target_position</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span>Refers to the target index position of the list.</span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="delete-an-epic-list">Delete an epic list</h5>
  <div class="endpoint-path">
    DELETE /api/projects/:project_id/epic_lists/:epic_list_id
  </div>
  

  
  
</div>

</div>
<div id="labels" class="section-block endpoint-section">
  <h3 class="block-title section">Labels</h3>
  
  
  <div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-labels">Get a list of labels</h5>
  <div class="endpoint-path">
    GET /api/projects/:project_id/labels
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">project_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">slug</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="create-a-label">Create a label</h5>
  <div class="endpoint-path">
    POST /api/projects/:project_id/labels
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">color</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span>Hex color code string without preceding "#"</span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">name</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-label">Get a label</h5>
  <div class="endpoint-path">
    GET /api/projects/:project_id/labels/:label_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="update-a-label">Update a label</h5>
  <div class="endpoint-path">
    PUT /api/projects/:project_id/labels/:label_id
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">color</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span>Hex color code string without preceding "#"</span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">name</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="delete-a-label">Delete a label</h5>
  <div class="endpoint-path">
    DELETE /api/projects/:project_id/labels/:label_id
  </div>
  

  
  
</div>

</div>
<div id="notifications" class="section-block endpoint-section">
  <h3 class="block-title section">Notifications</h3>
  
  
  <div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-notifications">Get a list of notifications</h5>
  <div class="endpoint-path">
    GET /api/notifications
  </div>
  
    <div class="note">
      <strong>Note:</strong> This endpoint does not take any parameters.
    </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="update-a-notification">Update a notification</h5>
  <div class="endpoint-path">
    PUT /api/notifications/:_notificationId
  </div>
  
    <div class="note">
      <strong>Note:</strong> <code class="inline">_notificationId</code> is an <code class="inline">ObjectId</code>, not an <code class="inline">integer</code>.
    </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">read</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="delete-a-notification">Delete a notification</h5>
  <div class="endpoint-path">
    DELETE /api/notifications/:_notificationId
  </div>
  
    <div class="note">
      <strong>Note:</strong> <code class="inline">_notificationId</code> is an <code class="inline">ObjectId</code>, not an <code class="inline">integer</code>.
    </div>
  

  
  
</div>

</div>
<div id="projects" class="section-block endpoint-section">
  <h3 class="block-title section">Projects</h3>
  
  
  <div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-projects">Get a list of projects</h5>
  <div class="endpoint-path">
    GET /api/projects
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
              <tr>
                <td class="name">
                  <code class="inline">account_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">auto_add_github_users</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">default_epic_list_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">name</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
          
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">private</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">should_use_fibonacci_scale</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">slug</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="create-a-project">Create a project</h5>
  <div class="endpoint-path">
    POST /api/projects
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">account_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">description</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">name</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-project">Get a project</h5>
  <div class="endpoint-path">
    GET /api/projects/:project_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="update-a-project">Update a project</h5>
  <div class="endpoint-path">
    PUT /api/projects/:project_id
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">auto_add_github_users</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">color</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span>Hex color code string without preceding "#"</span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">description</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">name</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">should_use_fibonacci_scale</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">triage</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span>Only valid for projects with one workspace</span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="delete-a-project">Delete a project</h5>
  <div class="endpoint-path">
    DELETE /api/projects/:project_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-project-admins">Get a list of project admins</h5>
  <div class="endpoint-path">
    GET /api/projects/:project_id/admin_members
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">avatar_path_is_locked</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">github_user_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">is_user</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">name</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">name_is_locked</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">username</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="add-a-project-admin">Add a project admin</h5>
  <div class="endpoint-path">
    POST /api/projects/:project_id/admin_members/:person_id
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">person_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="remove-a-project-admin">Remove a project admin</h5>
  <div class="endpoint-path">
    DELETE /api/projects/:project_id/admin_members/:person_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-project-members">Get a list of project members</h5>
  <div class="endpoint-path">
    GET /api/projects/:project_id/members
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">avatar_path_is_locked</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">github_user_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">is_user</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">name</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">name_is_locked</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">username</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="add-a-project-member">Add a project member</h5>
  <div class="endpoint-path">
    POST /api/projects/:project_id/members
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">person_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="remove-a-project-member">Remove a project member</h5>
  <div class="endpoint-path">
    DELETE /api/projects/:project_id/members/:person_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-project-collaborators">Get a list of project collaborators</h5>
  <div class="endpoint-path">
    GET /api/projects/:project_id/collaborators
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">avatar_path_is_locked</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">github_user_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">is_user</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">name</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">name_is_locked</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">username</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-project-cards">Get a list of project cards</h5>
  <div class="endpoint-path">
    GET /api/projects/:project_id/cards
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
              <tr>
                <td class="name">
                  <code class="inline">body</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">category_name</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">closed_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">closer_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">comments_count</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">creator_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">epic_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">last_comment_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">number</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">points</code>
                </td>
                <td class="type">
                  <span>number</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">priority</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">project_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">search_key</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">sprint_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">state</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">status</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">upvotes_count</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">was_archived_from_404</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">workspace_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
        <h4>Extended Parameters</h4>
        <div class="note">
          <strong>Note:</strong> This endpoint accepts the following extended query parameters
        </div>
        <table class="table table-bordered">
          <thead>
              <tr>
                  <th>name</th><th>type</th><th>required</th><th>notes</th>
              </tr>
          </thead>
          <tbody>
            
                <tr>
                  <td class="name">
                    <code class="inline">where[after_number]</code>
                  </td>
                  <td class="type">
                    <span>integer</span>
                  </td>
                  <td class="required">
                    <span></span>
                  </td>
                  <td class="note">
                    <span></span>
                  </td>
                </tr>
            
                <tr>
                  <td class="name">
                    <code class="inline">where[assignee_ids][]</code>
                  </td>
                  <td class="type">
                    <span>Array</span>
                  </td>
                  <td class="required">
                    <span></span>
                  </td>
                  <td class="note">
                    <span>Array of <code class="inline">assignee.id</code>s or <code class="inline">null</code></span>
                  </td>
                </tr>
            
                <tr>
                  <td class="name">
                    <code class="inline">where[created_after]</code>
                  </td>
                  <td class="type">
                    <span>timestamp</span>
                  </td>
                  <td class="required">
                    <span></span>
                  </td>
                  <td class="note">
                    <span></span>
                  </td>
                </tr>
            
                <tr>
                  <td class="name">
                    <code class="inline">where[labels][]</code>
                  </td>
                  <td class="type">
                    <span>Array</span>
                  </td>
                  <td class="required">
                    <span></span>
                  </td>
                  <td class="note">
                    <span>Array of <code class="inline">label.name</code>s or <code class="inline">null</code></span>
                  </td>
                </tr>
            
                <tr>
                  <td class="name">
                    <code class="inline">where[milestones][]</code>
                  </td>
                  <td class="type">
                    <span>Array</span>
                  </td>
                  <td class="required">
                    <span></span>
                  </td>
                  <td class="note">
                    <span>Array of <code class="inline">milestone.title</code>s or <code class="inline">null</code></span>
                  </td>
                </tr>
            
                <tr>
                  <td class="name">
                    <code class="inline">where[source_ids][]</code>
                  </td>
                  <td class="type">
                    <span>Array</span>
                  </td>
                  <td class="required">
                    <span></span>
                  </td>
                  <td class="note">
                    <span>Array of <code class="inline">source.id</code>s or <code class="inline">null</code></span>
                  </td>
                </tr>
            
                <tr>
                  <td class="name">
                    <code class="inline">where[types]</code>
                  </td>
                  <td class="type">
                    <span>String</span>
                  </td>
                  <td class="required">
                    <span></span>
                  </td>
                  <td class="note">
                    <span>Only accepts <code class="inline">issue</code>, <code class="inline">pull_request</code> or <code class="inline">null</code></span>
                  </td>
                </tr>
            
                <tr>
                  <td class="name">
                    <code class="inline">where[updated_after]</code>
                  </td>
                  <td class="type">
                    <span>timestamp</span>
                  </td>
                  <td class="required">
                    <span></span>
                  </td>
                  <td class="note">
                    <span></span>
                  </td>
                </tr>
            
                <tr>
                  <td class="name">
                    <code class="inline">order[by]</code>
                  </td>
                  <td class="type">
                    <span>String</span>
                  </td>
                  <td class="required">
                    <span>✅</span>
                  </td>
                  <td class="note">
                    <span>Accepts <code class="inline">assignee</code>, <code class="inline">creator</code>, <code class="inline">milestone</code> or <code class="inline">sprint</code></span>
                  </td>
                </tr>
            
                <tr>
                  <td class="name">
                    <code class="inline">order[direction]</code>
                  </td>
                  <td class="type">
                    <span>String</span>
                  </td>
                  <td class="required">
                    <span>✅</span>
                  </td>
                  <td class="note">
                    <span>Only accepts <code class="inline">asc</code> or <code class="inline">desc</code></span>
                  </td>
                </tr>
            
          </tbody>
        </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-cards-in-triage">Get a list of cards in triage</h5>
  <div class="endpoint-path">
    GET /api/projects/:project_id/triage_cards
  </div>
  
    <div class="note">
      <strong>Note:</strong> This endpoint does not take any parameters.
    </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-milestones">Get a list of milestones</h5>
  <div class="endpoint-path">
    GET /api/projects/:project_id/milestones
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
              <tr>
                <td class="name">
                  <code class="inline">closed_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">creator_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">due_on</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">number</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">source_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">state</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">title</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-customers">Get a list of customers</h5>
  <div class="endpoint-path">
    GET /api/projects/:project_id/customers
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
              <tr>
                <td class="name">
                  <code class="inline">contact</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">creator_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">name</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">project_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="add-a-customer">Add a customer</h5>
  <div class="endpoint-path">
    POST /api/projects/:project_id/customers
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">contact</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">name</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-customer">Get a customer</h5>
  <div class="endpoint-path">
    GET /api/projects/:project_id/customers/:customer_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="update-a-customer">Update a customer</h5>
  <div class="endpoint-path">
    PUT /api/projects/:project_id/customers/:customer_id
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">contact</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">name</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="remove-a-customer">Remove a customer</h5>
  <div class="endpoint-path">
    DELETE /api/projects/:project_id/customers/:customer_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-your-triage-subscription-level-settings">Get your triage subscription level settings</h5>
  <div class="endpoint-path">
    GET /api/projects/:project_id/triage_user_settings
  </div>
  
    <div class="note">
      <strong>Note:</strong> This endpoint does not take any parameters.
    </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-your-triage-subscription-level-settings">Get your triage subscription level settings</h5>
  <div class="endpoint-path">
    GET /api/projects/:project_id/triage_user_settings/:user_triage_setting_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="update-your-triage-subscription-level-settings">Update your triage subscription level settings</h5>
  <div class="endpoint-path">
    PUT /api/projects/:project_id/triage_user_settings/:user_triage_setting_id
  </div>
  
    <div class="note">
      <strong>Note:</strong> This endpoint allows you to edit how Zube automatically subscribes you to cards in Triage.
    </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">subscription_level</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span>Must be one of <code class="inline">following</code>, <code class="inline">not_following</code>, or <code class="inline">muted</code></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-your-project-subscription-level-settings">Get your project subscription level settings</h5>
  <div class="endpoint-path">
    GET /api/projects/:project_id/user_settings
  </div>
  
    <div class="note">
      <strong>Note:</strong> This endpoint does not take any parameters.
    </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-your-project-subscription-level-settings-by-id">Get your project subscription level settings by id</h5>
  <div class="endpoint-path">
    GET /api/projects/:project_id/user_settings/:user_project_setting_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="update-your-project-subscription-level-settings">Update your project subscription level settings</h5>
  <div class="endpoint-path">
    PUT /api/projects/:project_id/user_settings/:user_project_setting_id
  </div>
  
    <div class="note">
      <strong>Note:</strong> This endpoint allows you to edit how Zube automatically subscribes you to Epics and Tickets.
    </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">subscription_level</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span>Must be one of <code class="inline">following</code>, <code class="inline">not_following</code>, or <code class="inline">muted</code></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-your-project-email-preferences">Get your project email preferences</h5>
  <div class="endpoint-path">
    GET /api/projects/:project_id/user_email_preferences
  </div>
  
    <div class="note">
      <strong>Note:</strong> This endpoint does not take any parameters.
    </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-your-project-email-preferences-by-id">Get your project email preferences by id</h5>
  <div class="endpoint-path">
    GET /api/projects/:project_id/user_email_preferences/:user_project_email_preference_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="update-your-project-email-preferences">Update your project email preferences</h5>
  <div class="endpoint-path">
    PUT /api/projects/:project_id/user_email_preferences/:user_project_email_preference_id
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">card_added_to_triage</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_assigned_to_self</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_assignee_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_card_linked</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_comment_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_comment_mention</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_epic_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_label_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_mention</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_milestone_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_points_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_priority_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_ticket_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">email</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">epic_assigned_to_self</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">epic_assignee_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">epic_card_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">epic_comment_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">epic_comment_mention</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">epic_created</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">epic_due_date_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">epic_mention</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">epic_status_closed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">epic_status_completed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">epic_status_in_progress</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">epic_status_queued</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_added_to_triage</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_assigned_to_self</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_assignee_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_card_linked</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_comment_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_comment_mention</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_epic_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_label_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_mention</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_milestone_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_points_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_priority_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_ticket_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">ticket_assigned_to_self</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">ticket_assignee_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">ticket_card_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">ticket_comment_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">ticket_comment_mention</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">ticket_created</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">ticket_due_date_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">ticket_label_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">ticket_mention</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">ticket_priority_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">ticket_start_date_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">ticket_status_closed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">ticket_status_completed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">ticket_status_in_progress</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">ticket_status_queued</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-your-project-in-app-preferences">Get your project in app preferences</h5>
  <div class="endpoint-path">
    GET /api/projects/:project_id/user_in_app_preferences
  </div>
  
    <div class="note">
      <strong>Note:</strong> This endpoint does not take any parameters.
    </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-your-project-in-app-preferences-by-id">Get your project in app preferences by id</h5>
  <div class="endpoint-path">
    GET /api/projects/:project_id/user_in_app_preferences/:user_project_in_app_preference_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="update-your-project-in-app-preferences">Update your project in app preferences</h5>
  <div class="endpoint-path">
    PUT /api/projects/:project_id/user_in_app_preferences/:user_project_in_app_preference_id
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">card_added_to_triage</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_assigned_to_self</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_assignee_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_card_linked</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_comment_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_comment_mention</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_epic_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_label_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_mention</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_milestone_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_points_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_priority_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_ticket_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">epic_assigned_to_self</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">epic_assignee_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">epic_card_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">epic_comment_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">epic_comment_mention</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">epic_created</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">epic_due_date_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">epic_mention</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">epic_status_closed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">epic_status_completed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">epic_status_in_progress</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">epic_status_queued</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_added_to_triage</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_assigned_to_self</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_assignee_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_card_linked</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_comment_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_comment_mention</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_epic_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_label_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_mention</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_milestone_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_points_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_priority_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_ticket_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">ticket_assigned_to_self</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">ticket_assignee_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">ticket_card_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">ticket_comment_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">ticket_comment_mention</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">ticket_created</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">ticket_due_date_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">ticket_label_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">ticket_mention</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">ticket_priority_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">ticket_start_date_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">ticket_status_closed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">ticket_status_completed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">ticket_status_in_progress</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">ticket_status_queued</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>

</div>
<div id="sprints" class="section-block endpoint-section">
  <h3 class="block-title section">Sprints</h3>
  
  
  <div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-sprints">Get a list of sprints</h5>
  <div class="endpoint-path">
    GET /api/workspaces/:workspace_id/sprints
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
              <tr>
                <td class="name">
                  <code class="inline">closed_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">end_date</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">project_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">start_date</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">state</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">workspace_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="create-a-sprint">Create a sprint</h5>
  <div class="endpoint-path">
    POST /api/workspaces/:workspace_id/sprints
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">description</code>
              </td>
              <td class="type">
                <span>Text</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">end_date</code>
              </td>
              <td class="type">
                <span>Timestamp</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">start_date</code>
              </td>
              <td class="type">
                <span>Timestamp</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">title</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-sprint">Get a sprint</h5>
  <div class="endpoint-path">
    GET /api/workspaces/:workspace_id/sprints/:sprint_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="update-a-sprint">Update a sprint</h5>
  <div class="endpoint-path">
    PUT /api/workspaces/:workspace_id/sprints/:sprint_id
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">description</code>
              </td>
              <td class="type">
                <span>Text</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">end_date</code>
              </td>
              <td class="type">
                <span>Timestamp</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">start_date</code>
              </td>
              <td class="type">
                <span>Timestamp</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">state</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span>Only accepts <code class="inline">open</code> or <code class="inline">closed</code></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">title</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="delete-a-sprint">Delete a sprint</h5>
  <div class="endpoint-path">
    DELETE /api/workspaces/:workspace_id/sprints/:sprint_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-events">Get a list of events</h5>
  <div class="endpoint-path">
    GET /api/sprints/:sprint_id/events
  </div>
  
    <div class="note">
      <strong>Note:</strong> This endpoint does not take any parameters.
    </div>
  

  
  
</div>

</div>
<div id="sources" class="section-block endpoint-section">
  <h3 class="block-title section">Sources</h3>
  
  
  <div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-sources">Get a list of sources</h5>
  <div class="endpoint-path">
    GET /api/sources
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">full_name</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">github_owner_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">has_webhooks</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">name</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">webhook_verified_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="remove-a-source">Remove a source</h5>
  <div class="endpoint-path">
    DELETE /api/sources/:source_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-source-collaborators">Get a list of source collaborators</h5>
  <div class="endpoint-path">
    GET /api/sources/:source_id/collaborators
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">avatar_path_is_locked</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">github_user_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">is_user</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">name</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">name_is_locked</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">username</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-milestones">Get a list of milestones</h5>
  <div class="endpoint-path">
    GET /api/sources/:source_id/milestones
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
              <tr>
                <td class="name">
                  <code class="inline">closed_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">creator_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">due_on</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">number</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">source_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">state</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">title</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="create-a-milestone">Create a milestone</h5>
  <div class="endpoint-path">
    POST /api/sources/:source_id/milestones
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">description</code>
              </td>
              <td class="type">
                <span>Text</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">due_on</code>
              </td>
              <td class="type">
                <span>Timestamp</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">title</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-milestone">Get a milestone</h5>
  <div class="endpoint-path">
    GET /api/sources/:source_id/milestones/:milestone_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="update-a-milestone">Update a milestone</h5>
  <div class="endpoint-path">
    PUT /api/sources/:source_id/milestones/:milestone_id
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">description</code>
              </td>
              <td class="type">
                <span>Text</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">due_on</code>
              </td>
              <td class="type">
                <span>Timestamp</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">state</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span>Only accepts <code class="inline">open</code> or <code class="inline">closed</code></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">title</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="delete-a-milestone">Delete a milestone</h5>
  <div class="endpoint-path">
    DELETE /api/sources/:source_id/milestones/:milestone_id
  </div>
  

  
  
</div>

</div>
<div id="tickets" class="section-block endpoint-section">
  <h3 class="block-title section">Tickets</h3>
  
  
  <div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-tickets">Get a list of tickets</h5>
  <div class="endpoint-path">
    GET /api/projects/:project_id/tickets
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
              <tr>
                <td class="name">
                  <code class="inline">assignee_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">cards_count</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">cards_status</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">closed_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">closer_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">comments_count</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">creator_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">customer_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">due_on</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">number</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">priority</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">project_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">search_key</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">start_date</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">state</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">status</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">title</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">track_cards</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">type</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
        <h4>Extended Parameters</h4>
        <div class="note">
          <strong>Note:</strong> This endpoint accepts the following extended query parameters
        </div>
        <table class="table table-bordered">
          <thead>
              <tr>
                  <th>name</th><th>type</th><th>required</th><th>notes</th>
              </tr>
          </thead>
          <tbody>
            
                <tr>
                  <td class="name">
                    <code class="inline">where[after_number]</code>
                  </td>
                  <td class="type">
                    <span>integer</span>
                  </td>
                  <td class="required">
                    <span></span>
                  </td>
                  <td class="note">
                    <span></span>
                  </td>
                </tr>
            
                <tr>
                  <td class="name">
                    <code class="inline">where[created_after]</code>
                  </td>
                  <td class="type">
                    <span>timestamp</span>
                  </td>
                  <td class="required">
                    <span></span>
                  </td>
                  <td class="note">
                    <span></span>
                  </td>
                </tr>
            
                <tr>
                  <td class="name">
                    <code class="inline">where[updated_after]</code>
                  </td>
                  <td class="type">
                    <span>timestamp</span>
                  </td>
                  <td class="required">
                    <span></span>
                  </td>
                  <td class="note">
                    <span></span>
                  </td>
                </tr>
            
          </tbody>
        </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="create-a-ticket">Create a ticket</h5>
  <div class="endpoint-path">
    POST /api/projects/:project_id/tickets
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">assignee_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">customer_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">description</code>
              </td>
              <td class="type">
                <span>Text</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">due_on</code>
              </td>
              <td class="type">
                <span>Timestamp</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">priority</code>
              </td>
              <td class="type">
                <span>Number</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span>Must be one of <code class="inline">1</code>, <code class="inline">2</code>, <code class="inline">3</code>, <code class="inline">4</code></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">start_date</code>
              </td>
              <td class="type">
                <span>Timestamp</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">title</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">track_cards</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">type</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span>Must be one of <code class="inline">task</code>, <code class="inline">bug</code>, <code class="inline">feature</code>, <code class="inline">question</code></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-ticket">Get a ticket</h5>
  <div class="endpoint-path">
    GET /api/projects/:project_id/tickets/:ticket_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="update-a-ticket">Update a ticket</h5>
  <div class="endpoint-path">
    PUT /api/projects/:project_id/tickets/:ticket_id
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">assignee_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">customer_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">description</code>
              </td>
              <td class="type">
                <span>Text</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">due_on</code>
              </td>
              <td class="type">
                <span>Timestamp</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">priority</code>
              </td>
              <td class="type">
                <span>Number</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span>Must be one of <code class="inline">1</code>, <code class="inline">2</code>, <code class="inline">3</code>, <code class="inline">4</code></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">start_date</code>
              </td>
              <td class="type">
                <span>Timestamp</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">state</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span>Only accepts <code class="inline">open</code> or <code class="inline">closed</code></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">status</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span>Must be one of <code class="inline">new</code>, <code class="inline">queued</code>, <code class="inline">in_progress</code>, <code class="inline">completed</code>, <code class="inline">closed</code>, or <code class="inline">archived</code></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">title</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">track_cards</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">type</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span>Must be one of <code class="inline">task</code>, <code class="inline">bug</code>, <code class="inline">feature</code>, or <code class="inline">question</code></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-cards">Get a list of cards</h5>
  <div class="endpoint-path">
    GET /api/tickets/:ticket_id/cards
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
              <tr>
                <td class="name">
                  <code class="inline">body</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">category_name</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">closed_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">closer_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">comments_count</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">creator_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">epic_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">last_comment_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">number</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">points</code>
                </td>
                <td class="type">
                  <span>number</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">priority</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">project_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">search_key</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">sprint_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">state</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">status</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">upvotes_count</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">was_archived_from_404</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">workspace_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="add-a-card-to-a-ticket">Add a card to a ticket</h5>
  <div class="endpoint-path">
    POST /api/tickets/:ticket_id/cards
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">card_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="remove-a-card-from-a-ticket">Remove a card from a ticket</h5>
  <div class="endpoint-path">
    DELETE /api/tickets/:ticket_id/cards/:card_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-ticket-comments">Get a list of ticket comments</h5>
  <div class="endpoint-path">
    GET /api/tickets/:ticket_id/comments
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">card_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">creator_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="create-a-ticket-comment">Create a ticket comment</h5>
  <div class="endpoint-path">
    POST /api/tickets/:ticket_id/comments
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">body</code>
              </td>
              <td class="type">
                <span>Text</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="update-a-ticket-comment">Update a ticket comment</h5>
  <div class="endpoint-path">
    PUT /api/tickets/:ticket_id/comments/:comment_id
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">body</code>
              </td>
              <td class="type">
                <span>Text</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="delete-a-ticket-comment">Delete a ticket comment</h5>
  <div class="endpoint-path">
    DELETE /api/tickets/:ticket_id/comments/:comment_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-ticket-events">Get a list of ticket events</h5>
  <div class="endpoint-path">
    GET /api/tickets/:ticket_id/events
  </div>
  
    <div class="note">
      <strong>Note:</strong> This endpoint does not take any parameters.
    </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-ticket-subscriptions">Get a list of ticket subscriptions</h5>
  <div class="endpoint-path">
    GET /api/tickets/:ticket_id/subscriptions
  </div>
  
    <div class="note">
      <strong>Note:</strong> Returns either zero or one subscription for the current user. This endpoint does not take any parameters.
    </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="create-a-ticket-subscription">Create a ticket subscription</h5>
  <div class="endpoint-path">
    POST /api/tickets/:ticket_id/subscriptions
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="delete-a-ticket-subscription">Delete a ticket subscription</h5>
  <div class="endpoint-path">
    DELETE /api/tickets/:ticket_id/subscriptions/:subscription_id
  </div>
  

  
  
</div>

</div>
<div id="workspaces" class="section-block endpoint-section">
  <h3 class="block-title section">Workspaces</h3>
  
  
  <div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-workspaces">Get a list of workspaces</h5>
  <div class="endpoint-path">
    GET /api/workspaces
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
              <tr>
                <td class="name">
                  <code class="inline">add_category_labels_to_imported_cards</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">archive_merged_prs</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">auto_archive_closed_cards</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">default_card_template_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">is_archived</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">name</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
          
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">private</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">project_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">should_display_prs</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">should_use_fibonacci_scale</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">slug</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">timezone</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">use_category_labels</code>
                </td>
                <td class="type">
                  <span>boolean</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="create-a-workspace">Create a workspace</h5>
  <div class="endpoint-path">
    POST /api/workspaces
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">description</code>
              </td>
              <td class="type">
                <span>Text</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">name</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">project_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-workspace">Get a workspace</h5>
  <div class="endpoint-path">
    GET /api/workspaces/:workspace_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="update-a-workspace">Update a workspace</h5>
  <div class="endpoint-path">
    PUT /api/workspaces/:workspace_id
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">add_category_labels_to_imported_cards</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">add_category_labels_to_imported_cards</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">archive_merged_prs</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">auto_archive_closed_cards</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">description</code>
              </td>
              <td class="type">
                <span>Text</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">name</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">points</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">priority</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">priority_format</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span>Must be one of <code class="inline">number</code>, <code class="inline">name</code>, or <code class="inline">color</code></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">should_use_fibonacci_scale</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">upvotes</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">use_category_labels</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="delete-a-workspace">Delete a workspace</h5>
  <div class="endpoint-path">
    DELETE /api/workspaces/:workspace_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-your-workspace-subscription-level-settings">Get your workspace subscription level settings</h5>
  <div class="endpoint-path">
    GET /api/workspaces/:workspace_id/user_settings
  </div>
  
    <div class="note">
      <strong>Note:</strong> This endpoint does not take any parameters.
    </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-your-workspace-subscription-level-settings-by-id">Get your workspace subscription level settings by id</h5>
  <div class="endpoint-path">
    GET /api/workspaces/:workspace_id/user_settings/:user_workspace_setting_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="update-your-workspace-subscription-level-settings">Update your workspace subscription level settings</h5>
  <div class="endpoint-path">
    PUT /api/workspaces/:workspace_id/user_settings/:user_workspace_setting_id
  </div>
  
    <div class="note">
      <strong>Note:</strong> This endpoint allows you to edit how Zube automatically subscribes you to Cards in your Workspace.
    </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">subscription_level</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span>Must be one of <code class="inline">following</code>, <code class="inline">not_following</code>, or <code class="inline">muted</code></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-your-workspace-in-app-preferences">Get your workspace in app preferences</h5>
  <div class="endpoint-path">
    GET /api/workspaces/:workspace_id/user_in_app_preferences
  </div>
  
    <div class="note">
      <strong>Note:</strong> This endpoint does not take any parameters.
    </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-your-workspace-in-app-preferences-by-id">Get your workspace in app preferences by id</h5>
  <div class="endpoint-path">
    GET /api/workspaces/:workspace_id/user_in_app_preferences/user_workspace_in_app_preference_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="update-your-workspace-in-app-preferences">Update your workspace in app preferences</h5>
  <div class="endpoint-path">
    PUT /api/workspaces/:workspace_id/user_in_app_preferences/user_workspace_in_app_preference_id
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">card_added_to_workspace</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_assigned_to_self</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_assignee_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_card_linked</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_column_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_comment_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_comment_mention</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_epic_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_label_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_mention</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_milestone_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_points_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_priority_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_sprint_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_state_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_status_done</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_status_in_progress</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_status_in_review</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_status_queued</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_ticket_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_added_to_workspace</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_assigned_to_self</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_assignee_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_card_linked</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_column_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_comment_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_comment_mention</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_epic_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_label_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_mention</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_merged</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_milestone_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_points_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_priority_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_sprint_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_state_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_status_done</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_status_in_progress</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_status_in_review</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_status_queued</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_ticket_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">sprint_card_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">sprint_card_removed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">sprint_created</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">sprint_end_date_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">sprint_start_date_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">sprint_state_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-your-workspace-email-preferences">Get your workspace email preferences</h5>
  <div class="endpoint-path">
    GET /api/workspaces/:workspace_id/user_email_preferences
  </div>
  
    <div class="note">
      <strong>Note:</strong> This endpoint does not take any parameters.
    </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-your-workspace-email-preferences-by-id">Get your workspace email preferences by id</h5>
  <div class="endpoint-path">
    GET /api/workspaces/:workspace_id/user_email_preferences/user_workspace_email_preference_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="update-your-workspace-email-preferences">Update your workspace email preferences</h5>
  <div class="endpoint-path">
    PUT /api/workspaces/:workspace_id/user_email_preferences/user_workspace_email_preference_id
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">card_added_to_workspace</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_assigned_to_self</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_assignee_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_card_linked</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_column_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_comment_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_comment_mention</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_epic_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_label_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_mention</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_milestone_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_points_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_priority_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_sprint_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_state_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_status_done</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_status_in_progress</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_status_in_review</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_status_queued</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">card_ticket_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">email</code>
              </td>
              <td class="type">
                <span>String</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_added_to_workspace</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_assigned_to_self</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_assignee_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_card_linked</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_column_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_comment_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_comment_mention</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_epic_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_label_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_mention</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_merged</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_milestone_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_points_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_priority_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_sprint_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_state_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_status_done</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_status_in_progress</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_status_in_review</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_status_queued</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">pr_ticket_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">sprint_card_added</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">sprint_card_removed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">sprint_created</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">sprint_end_date_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">sprint_start_date_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">sprint_state_changed</code>
              </td>
              <td class="type">
                <span>Boolean</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-list-of-workspace-card-templates">Get a list of workspace card templates</h5>
  <div class="endpoint-path">
    GET /api/workspaces/:workspace_id/workspace_card_templates
  </div>
  

  
    <div class="params-table table-section">
      <h4>Parameters</h4>
      <small>These parameters can be used in the <code class="inline">where</code> clause and <code class="inline">order</code> clause.</small>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th>
          </tr>
        </thead>
        <tbody>
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">created_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">project_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">title</code>
                </td>
                <td class="type">
                  <span>text</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">updated_at</code>
                </td>
                <td class="type">
                  <span>timestamp</span>
                </td>
              </tr>
            
          
            
              <tr>
                <td class="name">
                  <code class="inline">workspace_id</code>
                </td>
                <td class="type">
                  <span>integer</span>
                </td>
              </tr>
            
          
        </tbody>
      </table>
      
    </div>
  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="create-a-workspace-card-template">Create a workspace card template</h5>
  <div class="endpoint-path">
    POST /api/workspaces/:workspace_id/workspace_card_templates
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">content</code>
              </td>
              <td class="type">
                <span>Text</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">description</code>
              </td>
              <td class="type">
                <span>Text</span>
              </td>
              <td class="required">
                <span></span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">title</code>
              </td>
              <td class="type">
                <span>Text</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">workspace_id</code>
              </td>
              <td class="type">
                <span>Integer</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="get-a-workspace-card-template">Get a workspace card template</h5>
  <div class="endpoint-path">
    GET /api/workspaces/:workspace_id/workspace_card_templates/workspace_card_template_id
  </div>
  

  
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="update-a-workspace">Update a workspace</h5>
  <div class="endpoint-path">
    PUT /api/workspaces/:workspace_id/workspace_card_templates/workspace_card_template_id
  </div>
  

  
  
    <div class="form-data-table table-section">
      <h4>Body Data</h4>
      <table class="table table-bordered">
        <thead>
          <tr>
            <th>name</th><th>type</th><th>required</th><th>notes</th>
          </tr>
        </thead>
        <tbody>
          
            <tr>
              <td class="name">
                <code class="inline">content</code>
              </td>
              <td class="type">
                <span>Text</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">description</code>
              </td>
              <td class="type">
                <span>Text</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
            <tr>
              <td class="name">
                <code class="inline">title</code>
              </td>
              <td class="type">
                <span>Text</span>
              </td>
              <td class="required">
                <span>✅</span>
              </td>
              <td class="note">
                <span></span>
              </td>
            </tr>
          
        </tbody>
      </table>
    </div>
  
</div>
<div class="endpoint">
  <h5 class="endpoint-name" id="delete-a-workspace">Delete a workspace</h5>
  <div class="endpoint-path">
    DELETE /api/workspaces/:workspace_id/workspace_card_templates/workspace_card_template_id
  </div>
  

  
  
</div>

</div>

</section>

                            <div class="section-block">
                                <div class="callout-block contact-callout">
                                    <div class="content">
                                        <p>
                                            Have more questions? Need help setting up your workflow? Get in touch!
                                        </p>
                                        <p>
                                            <a href="mailto:team@zube.io" target="_top"><i class="zubeicon-envelope"></i> team@zube.io</a>
                                            <a href="http://slack.zube.io" target="_blank"><i class="zubeicon-slack"></i> Zube on Slack</a>
                                        </p>
                                    </div><!--//content-->
                                </div><!--//callout-block-->
                            </div>
                        </div><!--//content-inner-->
                    </div><!--//doc-content-->
                    <div class="doc-sidebar hidden-xs">
    <nav id="doc-nav">
        <ul id="doc-menu" class="nav doc-menu" data-spy="affix">
            <li>
                <a class="scrollto" href="#getting-started-section">Getting Started</a>
                <ul class="nav doc-sub-menu">
                    
                        <li><a class="scrollto" href="#authentication-section">Authentication</a></li>
                    
                        <li><a class="scrollto" href="#example-request-response-section">Example Request Response</a></li>
                    
                        <li><a class="scrollto" href="#request-parameters-section">Request Parameters</a></li>
                    
                        <li><a class="scrollto" href="#etag-caching-section">ETag Caching</a></li>
                    
                        <li><a class="scrollto" href="#data-mutations">Data Mutations</a></li>
                    
                        <li><a class="scrollto" href="#responsible-usage-section">Responsible Usage</a></li>
                    
                </ul>
            </li>
            <li>
                <a class="scrollto" href="#api-endpoints-section">API Endpoints</a>
                <ul class="nav doc-sub-menu">
                    
                        <li>
                            <a class="scrollto" href="#person">
                                <strong>
                                    Person
                                </strong>
                            </a>
                        </li>
                        
                            <li><a class="scrollto" href="#get-the-current-persons-information">Get the current person&#39;s information</a></li>
                        
                    
                        <li>
                            <a class="scrollto" href="#accounts">
                                <strong>
                                    Accounts
                                </strong>
                            </a>
                        </li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-accounts">Get a list of accounts</a></li>
                        
                            <li><a class="scrollto" href="#get-an-account">Get an account</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-account-admins">Get a list of account admins</a></li>
                        
                            <li><a class="scrollto" href="#create-an-account-admin">Create an account admin</a></li>
                        
                            <li><a class="scrollto" href="#remove-an-account-admin">Remove an account admin</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-account-members">Get a list of account members</a></li>
                        
                            <li><a class="scrollto" href="#create-an-account-member">Create an account member</a></li>
                        
                            <li><a class="scrollto" href="#remove-an-account-member">Remove an account member</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-projects-for-an-account">Get a list of projects for an account</a></li>
                        
                    
                        <li>
                            <a class="scrollto" href="#cards">
                                <strong>
                                    Cards
                                </strong>
                            </a>
                        </li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-cards">Get a list of cards</a></li>
                        
                            <li><a class="scrollto" href="#create-a-card">Create a card</a></li>
                        
                            <li><a class="scrollto" href="#get-a-card">Get a card</a></li>
                        
                            <li><a class="scrollto" href="#update-a-card">Update a card</a></li>
                        
                            <li><a class="scrollto" href="#archive-a-card">Archive a card</a></li>
                        
                            <li><a class="scrollto" href="#move-a-card">Move a card</a></li>
                        
                            <li><a class="scrollto" href="#add-a-card-to-a-source-repo">Add a card to a source repo</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-card-relations">Get a list of card relations</a></li>
                        
                            <li><a class="scrollto" href="#create-a-card-relationship">Create a card relationship</a></li>
                        
                            <li><a class="scrollto" href="#remove-a-card-relationship">Remove a card relationship</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-card-comments">Get a list of card comments</a></li>
                        
                            <li><a class="scrollto" href="#create-a-new-card-comment">Create a new card comment</a></li>
                        
                            <li><a class="scrollto" href="#update-a-card-comment">Update a card comment</a></li>
                        
                            <li><a class="scrollto" href="#remove-a-card-comment">Remove a card comment</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-card-card-custom-field-dates">Get a list of card card custom field dates</a></li>
                        
                            <li><a class="scrollto" href="#get-a-card-custom-field-date">Get a card custom field date</a></li>
                        
                            <li><a class="scrollto" href="#create-a-new-card-custom-field-date">Create a new card custom field date</a></li>
                        
                            <li><a class="scrollto" href="#update-a-card-custom-field-date">Update a card custom field date</a></li>
                        
                            <li><a class="scrollto" href="#remove-a-card-custom-field-date">Remove a card custom field date</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-card-card-custom-field-numbers">Get a list of card card custom field numbers</a></li>
                        
                            <li><a class="scrollto" href="#get-a-card-custom-field-number">Get a card custom field number</a></li>
                        
                            <li><a class="scrollto" href="#create-a-new-card-custom-field-number">Create a new card custom field number</a></li>
                        
                            <li><a class="scrollto" href="#update-a-card-custom-field-number">Update a card custom field number</a></li>
                        
                            <li><a class="scrollto" href="#remove-a-card-custom-field-number">Remove a card custom field number</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-card-card-custom-field-texts">Get a list of card card custom field texts</a></li>
                        
                            <li><a class="scrollto" href="#get-a-card-custom-field-text">Get a card custom field text</a></li>
                        
                            <li><a class="scrollto" href="#create-a-new-card-custom-field-text">Create a new card custom field text</a></li>
                        
                            <li><a class="scrollto" href="#update-a-card-custom-field-text">Update a card custom field text</a></li>
                        
                            <li><a class="scrollto" href="#remove-a-card-custom-field-text">Remove a card custom field text</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-card-card-custom-field-single-selections">Get a list of card card custom field single selections</a></li>
                        
                            <li><a class="scrollto" href="#get-a-card-custom-field-single-selection">Get a card custom field single selection</a></li>
                        
                            <li><a class="scrollto" href="#create-a-new-card-custom-field-single-selection">Create a new card custom field single selection</a></li>
                        
                            <li><a class="scrollto" href="#update-a-card-custom-field-single-selection">Update a card custom field single selection</a></li>
                        
                            <li><a class="scrollto" href="#remove-a-card-custom-field-single-selection">Remove a card custom field single selection</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-card-events">Get a list of card events</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-commit-references">Get a list of commit references</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-card-subscriptions">Get a list of card subscriptions</a></li>
                        
                            <li><a class="scrollto" href="#create-a-card-subscription">Create a card subscription</a></li>
                        
                            <li><a class="scrollto" href="#remove-a-card-subscription">Remove a card subscription</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-related-tickets">Get a list of related tickets</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-upvoters">Get a list of upvoters</a></li>
                        
                            <li><a class="scrollto" href="#create-a-card-upvote">Create a card upvote</a></li>
                        
                    
                        <li>
                            <a class="scrollto" href="#categories">
                                <strong>
                                    Categories
                                </strong>
                            </a>
                        </li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-categories">Get a list of categories</a></li>
                        
                            <li><a class="scrollto" href="#get-a-category">Get a category</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-categories-metadata">Get a list of categories metadata</a></li>
                        
                            <li><a class="scrollto" href="#get-a-categorys-metadata">Get a category&#39;s metadata</a></li>
                        
                    
                        <li>
                            <a class="scrollto" href="#custom-fields">
                                <strong>
                                    Custom Fields
                                </strong>
                            </a>
                        </li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-custom-fields">Get a list of custom fields</a></li>
                        
                            <li><a class="scrollto" href="#get-a-custom-field">Get a custom field</a></li>
                        
                            <li><a class="scrollto" href="#create-a-new-custom-field">Create a new custom field</a></li>
                        
                            <li><a class="scrollto" href="#update-a-custom-field">Update a custom field</a></li>
                        
                            <li><a class="scrollto" href="#remove-a-custom-field">Remove a custom field</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-custom-field-single-select-options">Get a list of custom field single select options</a></li>
                        
                            <li><a class="scrollto" href="#get-a-custom-field-single-select-option">Get a custom field single select option</a></li>
                        
                            <li><a class="scrollto" href="#create-a-new-custom-field-single-select-option">Create a new custom field single select option</a></li>
                        
                            <li><a class="scrollto" href="#update-a-custom-field-single-select-option">Update a custom field single select option</a></li>
                        
                            <li><a class="scrollto" href="#remove-a-custom-field-single-select-option">Remove a custom field single select option</a></li>
                        
                    
                        <li>
                            <a class="scrollto" href="#epics">
                                <strong>
                                    Epics
                                </strong>
                            </a>
                        </li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-epics">Get a list of epics</a></li>
                        
                            <li><a class="scrollto" href="#create-an-epic">Create an epic</a></li>
                        
                            <li><a class="scrollto" href="#get-an-epic">Get an epic</a></li>
                        
                            <li><a class="scrollto" href="#update-an-epic">Update an epic</a></li>
                        
                            <li><a class="scrollto" href="#move-an-epic">Move an epic</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-epic-cards">Get a list of epic cards</a></li>
                        
                            <li><a class="scrollto" href="#add-a-card-to-an-epic">Add a card to an epic</a></li>
                        
                            <li><a class="scrollto" href="#remove-a-card-from-an-epic">Remove a card from an epic</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-epic-comments">Get a list of epic comments</a></li>
                        
                            <li><a class="scrollto" href="#create-an-epic-comment">Create an epic comment</a></li>
                        
                            <li><a class="scrollto" href="#update-an-epic-comment">Update an epic comment</a></li>
                        
                            <li><a class="scrollto" href="#remove-an-epic-comment">Remove an epic comment</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-epic-events">Get a list of epic events</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-epic-subscriptions">Get a list of epic subscriptions</a></li>
                        
                            <li><a class="scrollto" href="#create-an-epic-subscription">Create an epic subscription</a></li>
                        
                            <li><a class="scrollto" href="#remove-an-epic-subscription">Remove an epic subscription</a></li>
                        
                    
                        <li>
                            <a class="scrollto" href="#epic-lists">
                                <strong>
                                    Epic Lists
                                </strong>
                            </a>
                        </li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-epic-lists">Get a list of epic lists</a></li>
                        
                            <li><a class="scrollto" href="#create-an-epic-list">Create an epic list</a></li>
                        
                            <li><a class="scrollto" href="#get-an-epic-list">Get an epic list</a></li>
                        
                            <li><a class="scrollto" href="#update-an-epic-list">Update an epic list</a></li>
                        
                            <li><a class="scrollto" href="#move-an-epic-list">Move an epic list</a></li>
                        
                            <li><a class="scrollto" href="#delete-an-epic-list">Delete an epic list</a></li>
                        
                    
                        <li>
                            <a class="scrollto" href="#labels">
                                <strong>
                                    Labels
                                </strong>
                            </a>
                        </li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-labels">Get a list of labels</a></li>
                        
                            <li><a class="scrollto" href="#create-a-label">Create a label</a></li>
                        
                            <li><a class="scrollto" href="#get-a-label">Get a label</a></li>
                        
                            <li><a class="scrollto" href="#update-a-label">Update a label</a></li>
                        
                            <li><a class="scrollto" href="#delete-a-label">Delete a label</a></li>
                        
                    
                        <li>
                            <a class="scrollto" href="#notifications">
                                <strong>
                                    Notifications
                                </strong>
                            </a>
                        </li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-notifications">Get a list of notifications</a></li>
                        
                            <li><a class="scrollto" href="#update-a-notification">Update a notification</a></li>
                        
                            <li><a class="scrollto" href="#delete-a-notification">Delete a notification</a></li>
                        
                    
                        <li>
                            <a class="scrollto" href="#projects">
                                <strong>
                                    Projects
                                </strong>
                            </a>
                        </li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-projects">Get a list of projects</a></li>
                        
                            <li><a class="scrollto" href="#create-a-project">Create a project</a></li>
                        
                            <li><a class="scrollto" href="#get-a-project">Get a project</a></li>
                        
                            <li><a class="scrollto" href="#update-a-project">Update a project</a></li>
                        
                            <li><a class="scrollto" href="#delete-a-project">Delete a project</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-project-admins">Get a list of project admins</a></li>
                        
                            <li><a class="scrollto" href="#add-a-project-admin">Add a project admin</a></li>
                        
                            <li><a class="scrollto" href="#remove-a-project-admin">Remove a project admin</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-project-members">Get a list of project members</a></li>
                        
                            <li><a class="scrollto" href="#add-a-project-member">Add a project member</a></li>
                        
                            <li><a class="scrollto" href="#remove-a-project-member">Remove a project member</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-project-collaborators">Get a list of project collaborators</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-project-cards">Get a list of project cards</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-cards-in-triage">Get a list of cards in triage</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-milestones">Get a list of milestones</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-customers">Get a list of customers</a></li>
                        
                            <li><a class="scrollto" href="#add-a-customer">Add a customer</a></li>
                        
                            <li><a class="scrollto" href="#get-a-customer">Get a customer</a></li>
                        
                            <li><a class="scrollto" href="#update-a-customer">Update a customer</a></li>
                        
                            <li><a class="scrollto" href="#remove-a-customer">Remove a customer</a></li>
                        
                            <li><a class="scrollto" href="#get-your-triage-subscription-level-settings">Get your triage subscription level settings</a></li>
                        
                            <li><a class="scrollto" href="#get-your-triage-subscription-level-settings">Get your triage subscription level settings</a></li>
                        
                            <li><a class="scrollto" href="#update-your-triage-subscription-level-settings">Update your triage subscription level settings</a></li>
                        
                            <li><a class="scrollto" href="#get-your-project-subscription-level-settings">Get your project subscription level settings</a></li>
                        
                            <li><a class="scrollto" href="#get-your-project-subscription-level-settings-by-id">Get your project subscription level settings by id</a></li>
                        
                            <li><a class="scrollto" href="#update-your-project-subscription-level-settings">Update your project subscription level settings</a></li>
                        
                            <li><a class="scrollto" href="#get-your-project-email-preferences">Get your project email preferences</a></li>
                        
                            <li><a class="scrollto" href="#get-your-project-email-preferences-by-id">Get your project email preferences by id</a></li>
                        
                            <li><a class="scrollto" href="#update-your-project-email-preferences">Update your project email preferences</a></li>
                        
                            <li><a class="scrollto" href="#get-your-project-in-app-preferences">Get your project in app preferences</a></li>
                        
                            <li><a class="scrollto" href="#get-your-project-in-app-preferences-by-id">Get your project in app preferences by id</a></li>
                        
                            <li><a class="scrollto" href="#update-your-project-in-app-preferences">Update your project in app preferences</a></li>
                        
                    
                        <li>
                            <a class="scrollto" href="#sprints">
                                <strong>
                                    Sprints
                                </strong>
                            </a>
                        </li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-sprints">Get a list of sprints</a></li>
                        
                            <li><a class="scrollto" href="#create-a-sprint">Create a sprint</a></li>
                        
                            <li><a class="scrollto" href="#get-a-sprint">Get a sprint</a></li>
                        
                            <li><a class="scrollto" href="#update-a-sprint">Update a sprint</a></li>
                        
                            <li><a class="scrollto" href="#delete-a-sprint">Delete a sprint</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-events">Get a list of events</a></li>
                        
                    
                        <li>
                            <a class="scrollto" href="#sources">
                                <strong>
                                    Sources
                                </strong>
                            </a>
                        </li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-sources">Get a list of sources</a></li>
                        
                            <li><a class="scrollto" href="#remove-a-source">Remove a source</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-source-collaborators">Get a list of source collaborators</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-milestones">Get a list of milestones</a></li>
                        
                            <li><a class="scrollto" href="#create-a-milestone">Create a milestone</a></li>
                        
                            <li><a class="scrollto" href="#get-a-milestone">Get a milestone</a></li>
                        
                            <li><a class="scrollto" href="#update-a-milestone">Update a milestone</a></li>
                        
                            <li><a class="scrollto" href="#delete-a-milestone">Delete a milestone</a></li>
                        
                    
                        <li>
                            <a class="scrollto" href="#tickets">
                                <strong>
                                    Tickets
                                </strong>
                            </a>
                        </li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-tickets">Get a list of tickets</a></li>
                        
                            <li><a class="scrollto" href="#create-a-ticket">Create a ticket</a></li>
                        
                            <li><a class="scrollto" href="#get-a-ticket">Get a ticket</a></li>
                        
                            <li><a class="scrollto" href="#update-a-ticket">Update a ticket</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-cards">Get a list of cards</a></li>
                        
                            <li><a class="scrollto" href="#add-a-card-to-a-ticket">Add a card to a ticket</a></li>
                        
                            <li><a class="scrollto" href="#remove-a-card-from-a-ticket">Remove a card from a ticket</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-ticket-comments">Get a list of ticket comments</a></li>
                        
                            <li><a class="scrollto" href="#create-a-ticket-comment">Create a ticket comment</a></li>
                        
                            <li><a class="scrollto" href="#update-a-ticket-comment">Update a ticket comment</a></li>
                        
                            <li><a class="scrollto" href="#delete-a-ticket-comment">Delete a ticket comment</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-ticket-events">Get a list of ticket events</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-ticket-subscriptions">Get a list of ticket subscriptions</a></li>
                        
                            <li><a class="scrollto" href="#create-a-ticket-subscription">Create a ticket subscription</a></li>
                        
                            <li><a class="scrollto" href="#delete-a-ticket-subscription">Delete a ticket subscription</a></li>
                        
                    
                        <li>
                            <a class="scrollto" href="#workspaces">
                                <strong>
                                    Workspaces
                                </strong>
                            </a>
                        </li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-workspaces">Get a list of workspaces</a></li>
                        
                            <li><a class="scrollto" href="#create-a-workspace">Create a workspace</a></li>
                        
                            <li><a class="scrollto" href="#get-a-workspace">Get a workspace</a></li>
                        
                            <li><a class="scrollto" href="#update-a-workspace">Update a workspace</a></li>
                        
                            <li><a class="scrollto" href="#delete-a-workspace">Delete a workspace</a></li>
                        
                            <li><a class="scrollto" href="#get-your-workspace-subscription-level-settings">Get your workspace subscription level settings</a></li>
                        
                            <li><a class="scrollto" href="#get-your-workspace-subscription-level-settings-by-id">Get your workspace subscription level settings by id</a></li>
                        
                            <li><a class="scrollto" href="#update-your-workspace-subscription-level-settings">Update your workspace subscription level settings</a></li>
                        
                            <li><a class="scrollto" href="#get-your-workspace-in-app-preferences">Get your workspace in app preferences</a></li>
                        
                            <li><a class="scrollto" href="#get-your-workspace-in-app-preferences-by-id">Get your workspace in app preferences by id</a></li>
                        
                            <li><a class="scrollto" href="#update-your-workspace-in-app-preferences">Update your workspace in app preferences</a></li>
                        
                            <li><a class="scrollto" href="#get-your-workspace-email-preferences">Get your workspace email preferences</a></li>
                        
                            <li><a class="scrollto" href="#get-your-workspace-email-preferences-by-id">Get your workspace email preferences by id</a></li>
                        
                            <li><a class="scrollto" href="#update-your-workspace-email-preferences">Update your workspace email preferences</a></li>
                        
                            <li><a class="scrollto" href="#get-a-list-of-workspace-card-templates">Get a list of workspace card templates</a></li>
                        
                            <li><a class="scrollto" href="#create-a-workspace-card-template">Create a workspace card template</a></li>
                        
                            <li><a class="scrollto" href="#get-a-workspace-card-template">Get a workspace card template</a></li>
                        
                            <li><a class="scrollto" href="#update-a-workspace">Update a workspace</a></li>
                        
                            <li><a class="scrollto" href="#delete-a-workspace">Delete a workspace</a></li>
                        
                    
                </ul>
            </li>
        </ul>
    </nav>
</div>

                </div><!--//doc-body-->
            </div><!--//container-->
        </div><!--//doc-wrapper-->

    </div><!--//page-wrapper-->

    <footer id="footer" class="footer text-center">
      <div>
        <ul class="list-inline">
          <li><a href="/">Home</a></li>
          <li>&sdot;</li>
          <li><a href="/contact">Contact</a></li>
          <li>&sdot;</li>
          <li><a href="/blog">Blog</a></li>
          <li>&sdot;</li>
          <li><a href="/tos">Terms and Privacy</a></li>
        </ul>
        <p class="copyright text-center medium">Copyright &copy; Pivit Inc. <span id="copyright-date"></span>. All Rights Reserved</p>
      </div>
    </footer><!--//footer-->

    <!-- Tracking -->
    <script>
        if (location.hostname === 'zube.io') {
            // google
            (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
            (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
            m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
            })(window,document,'script','//www.google-analytics.com/analytics.js','ga');

            ga('create', 'UA-59920113-2', 'auto');
            ga('send', 'pageview');

        } else {
            window.ga = function () {}; // noop
        }
    </script>
    <script>
      $('#copyright-date').html(new Date().getFullYear());
    </script>
</body>
</html>