CINXE.COM

<!DOCTYPE html><html><head><meta charset="utf-8"><title>Productive API</title><link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css"><style>@import url('https://fonts.googleapis.com/css?family=Roboto:400,700|Inconsolata|Raleway:200');.hljs-comment,.hljs-title{color:#8e908c}.hljs-variable,.hljs-attribute,.hljs-tag,.hljs-regexp,.ruby .hljs-constant,.xml .hljs-tag .hljs-title,.xml .hljs-pi,.xml .hljs-doctype,.html .hljs-doctype,.css .hljs-id,.css .hljs-class,.css .hljs-pseudo{color:#c82829}.hljs-number,.hljs-preprocessor,.hljs-pragma,.hljs-built_in,.hljs-literal,.hljs-params,.hljs-constant{color:#f5871f}.ruby .hljs-class .hljs-title,.css .hljs-rules .hljs-attribute{color:#eab700}.hljs-string,.hljs-value,.hljs-inheritance,.hljs-header,.ruby .hljs-symbol,.xml .hljs-cdata{color:#718c00}.css .hljs-hexcolor{color:#3e999f}.hljs-function,.python .hljs-decorator,.python .hljs-title,.ruby .hljs-function .hljs-title,.ruby .hljs-title .hljs-keyword,.perl .hljs-sub,.javascript .hljs-title,.coffeescript .hljs-title{color:#4271ae}.hljs-keyword,.javascript .hljs-function{color:#8959a8}.hljs{display:block;background:white;color:#4d4d4c;padding:.5em}.coffeescript .javascript,.javascript .xml,.tex .hljs-formula,.xml .javascript,.xml .vbscript,.xml .css,.xml .hljs-cdata{opacity:.5}.right .hljs-comment{color:#969896}.right .css .hljs-class,.right .css .hljs-id,.right .css .hljs-pseudo,.right .hljs-attribute,.right .hljs-regexp,.right .hljs-tag,.right .hljs-variable,.right .html .hljs-doctype,.right .ruby .hljs-constant,.right .xml .hljs-doctype,.right .xml .hljs-pi,.right .xml .hljs-tag .hljs-title{color:#c66}.right .hljs-built_in,.right .hljs-constant,.right .hljs-literal,.right .hljs-number,.right .hljs-params,.right .hljs-pragma,.right .hljs-preprocessor{color:#de935f}.right .css .hljs-rule .hljs-attribute,.right .ruby .hljs-class .hljs-title{color:#f0c674}.right .hljs-header,.right .hljs-inheritance,.right .hljs-name,.right .hljs-string,.right .hljs-value,.right .ruby .hljs-symbol,.right .xml .hljs-cdata{color:#b5bd68}.right .css .hljs-hexcolor,.right .hljs-title{color:#8abeb7}.right .coffeescript .hljs-title,.right .hljs-function,.right .javascript .hljs-title,.right .perl .hljs-sub,.right .python .hljs-decorator,.right .python .hljs-title,.right .ruby .hljs-function .hljs-title,.right .ruby .hljs-title .hljs-keyword{color:#81a2be}.right .hljs-keyword,.right .javascript .hljs-function{color:#b294bb}.right .hljs{display:block;overflow-x:auto;background:#1d1f21;color:#c5c8c6;padding:.5em;-webkit-text-size-adjust:none}.right .coffeescript .javascript,.right .javascript .xml,.right .tex .hljs-formula,.right .xml .css,.right .xml .hljs-cdata,.right .xml .javascript,.right .xml .vbscript{opacity:.5}@font-face{font-family:'Inter';font-weight:100 900;font-style:normal;font-named-instance:'Regular';font-display:'swap';src:url("fonts/Inter-roman.var.woff2") format("woff2 supports variations(gvar)"),url("fonts/Inter-roman.var.woff2") format("woff2-variations"),url("fonts/Inter-roman.var.woff2") format("woff2")}.hljs{color:#F2F5FF;background:#22242F}.hljs-comment,.hljs-quote{color:#5c6370;font-style:italic}.hljs-section,.hljs-name,.hljs-selector-tag,.hljs-deletion,.hljs-subst{color:#e06c75}.hljs-literal{color:#A98FFF}.hljs-attribute{color:#FF6666}.hljs-string,.hljs-regexp,.hljs-addition,.hljs-meta .hljs-string{color:#8CCF3E}.hljs-attr,.hljs-variable,.hljs-template-variable,.hljs-type,.hljs-selector-class,.hljs-selector-attr,.hljs-selector-pseudo,.hljs-number{color:#FFC837}.hljs-symbol,.hljs-bullet,.hljs-link,.hljs-meta,.hljs-selector-id,.hljs-title{color:#61aeee}.hljs-built_in,.hljs-title.class_,.hljs-class .hljs-title{color:#FFC837}.hljs-emphasis{font-style:italic}.hljs-strong{font-weight:bold}.hljs-link{text-decoration:underline}*{margin:0;padding:0}body{box-sizing:border-box;width:100vw;color:#111111;background:#ffffff;font:400 14px/20px 'Inter',sans-serif;overflow:hidden}header{margin-bottom:16px}h1,h2,h3,h4,h5{color:#111111;margin:16px 0}h1 .permalink,h2 .permalink,h3 .permalink,h4 .permalink,h5 .permalink{margin-left:0;opacity:0;transition:opacity .25s ease}h1:hover .permalink,h2:hover .permalink,h3:hover .permalink,h4:hover .permalink,h5:hover .permalink{opacity:1}h1{font:700 30px/40px 'Inter',sans-serif}h2{font:700 24px/32px 'Inter',sans-serif}h3{font:700 20px/28px 'Inter',sans-serif;text-transform:uppercase}h5{font-weight:normal}p{margin:0 0 10px}p.choices{line-height:1.6}a{color:#5D2BFF;text-decoration:none}li p{margin:0}hr.split{border:0;height:1px;width:calc(36%);margin:16px auto;background-color:#F7F9FC}dl dt{float:left;width:130px;clear:left;text-align:right;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;font-weight:700}dl dd{margin-left:150px;padding:4px}blockquote{color:rgba(17,17,17,0.5);font-size:15.5px;padding:10px 20px;margin:16px 0;border-left:5px solid #2d2f3e}blockquote p:last-child{margin-bottom:0}pre{background-color:#22242F;padding:16px;border:1px solid #BABDD8;border-radius:4px;overflow:auto}pre code{color:#F2F5FF;background-color:transparent;padding:0;border:none}code{color:#111111;background-color:#F2F5FF;font:'Inconsolata',monospace;padding:1px 4px;border:1px solid #BABDD8;border-radius:4px}ul,ol{padding-left:2em}table{border-collapse:collapse;border-spacing:0;margin-bottom:16px}table tr:nth-child(2n){background-color:#fafafa}table th,table td{padding:8px 16px;border:1px solid #e6e6e6}.text-muted{opacity:.5}.note,.warning{padding:.3em 1em;margin:1em 0;border-radius:4px;font-size:90%}.note h1,.warning h1,.note h2,.warning h2,.note h3,.warning h3,.note h4,.warning h4,.note h5,.warning h5,.note h6,.warning h6{font-family:700 .75px 'Inter',sans-serif;font-size:135%;font-weight:500}.note p,.warning p{margin:.5em 0}.note{color:#111111;background-color:#f2eeff;border-left:4px solid #5D2BFF}.note h1,.note h2,.note h3,.note h4,.note h5,.note h6{color:#5D2BFF}.warning{color:#111111;background-color:#fbf1f0;border-left:4px solid #c9302c}.warning h1,.warning h2,.warning h3,.warning h4,.warning h5,.warning h6{color:#c9302c}header{margin-top:32px}nav::before{content:'';margin:0 16px 16px 0;display:block;height:50px;background-image:url('logo.svg');background-repeat:no-repeat;background-position:center}nav .section-heading{font-size:12px;padding:20px 8px 6px 16px;color:#7F82A4;letter-spacing:1px}nav .resource-group{padding:0}nav .resource-group .heading{position:relative;background-color:#F7F9FC}nav .resource-group .heading .chevron{position:absolute;top:16px;right:16px;opacity:.5}nav .resource-group .heading a{display:block;color:#20007A;padding:10px 16px;margin:0}nav .resource-group .heading a:hover{text-decoration:none;background-color:#ECE5FF}nav .selected .heading{border-left:2px solid #3A00F5}nav .selected .heading a{color:#3A00F5 !important}nav .selected .collapse-content{padding:16px 0 !important}nav ul{list-style-type:none;padding-left:0}nav ul a{display:block;color:#7F82A4;padding:8px 16px;overflow:hidden;text-overflow:ellipsis;white-space:nowrap}nav ul a:hover{text-decoration:none;background-color:#ECE5FF}nav ul>li{margin:0}nav ul>li:first-child{margin-top:-16px}nav ul>li:last-child{margin-bottom:-16px}nav ul ul a{padding-left:32px}nav ul ul li{margin:0}nav ul ul li:first-child{margin-top:0}nav ul ul li:last-child{margin-bottom:0}.preload *{transition:none !important}.pull-left{float:left}.pull-right{float:right}.collapse-button{float:right}.collapse-button .close{display:none;color:#5D2BFF;cursor:pointer}.collapse-button .open{color:#5D2BFF;cursor:pointer}.collapse-button.show .close{display:inline}.collapse-button.show .open{display:none}.collapse-content{max-height:0;overflow:hidden;transition:max-height .3s ease-in-out}nav{width:220px;background-color:#F7F9FC}.container-fluid.triple{width:100vw}.container-fluid.triple nav{width:16%;float:left;padding:16px;height:calc(68vh);overflow:scroll}.container-fluid.triple .row .content{float:left;width:calc(52vw);height:100vh;overflow:scroll}.middle:before,.middle:after{content:'';display:table}.middle{width:calc(-6%);float:left;padding:0 32px}.middle .group-heading{font:700 30px/40px 'Inter',sans-serif}.right{width:calc(-22%);float:right;padding:32px}.right a{color:#5D2BFF}.right h1,.right h2,.right h3,.right h4,.right h5,.right p,.right div{color:#ffffff}.right pre{background-color:#22242F;border:1px solid #4A4B54}.right pre code{color:#ffffff}.right .description{margin-top:16px}.right>.tabs{display:block;overflow:hidden;max-height:0;transition:max-height .3s ease-in-out}.tabs.expanded{max-height:10000px}.definition::after{pointer-events:all;content:'Show details';display:block;width:fit-content;margin-top:20px;margin-bottom:20px;border:1px solid #ffffff;border-radius:4px;padding:8px;cursor:pointer;color:#ffffff}.definition.clicked::after{content:'Hide details'}.definition{pointer-events:none;margin-top:16px;margin-bottom:16px}.definition .method{color:#FF6666}.definition .uri{word-break:break-all;word-wrap:break-word}.definition .hostname{opacity:.5}.example-names{background-color:#383A44;padding:16px;border-radius:4px}.example-names .tab-button{cursor:pointer;display:inline-block;color:#111111;padding:8px;margin-left:16px}.example-names .tab-button.active{background-color:#4A4B54}.right .example-names{background-color:#383A44}.right .example-names .tab-button{color:#ffffff;padding:8px}.right .example-names .tab-button.active{background-color:#4A4B54}#nav-background{display:none}#right-panel-background{height:100vh;width:calc(45vw);position:absolute;right:0;background-color:#292B35;z-index:-1}@media (max-width:1200px){nav{width:198px}.container{max-width:840px}.container .row .content{margin-left:232px;width:598px}}@media (max-width:992px){nav{width:169.4px}.container{max-width:720px}.container .row .content{margin-left:202px;width:518px}}@media (max-width:768px){nav{display:none}.container{width:95%;max-width:none}.container .row .content,.container-fluid .row .content,.container-fluid.triple .row .content{margin-left:auto;margin-right:auto;width:95%}#nav-background{display:none}#right-panel-background{width:42%}}.back-to-top{position:fixed;z-index:1;bottom:0;right:24px;padding:4px 8px;color:rgba(17,17,17,0.5);background-color:#f2f2f2;text-decoration:none !important;border-top:1px solid #d9d9d9;border-left:1px solid #d9d9d9;border-right:1px solid #d9d9d9;border-top-left-radius:4px;border-radius:4px;border-top-right-radius:4px}.resource-group{padding:16px;background-color:#ffffff;border-radius:4px}.triple .content .resource-group{padding:0;border:none}nav .resource-group .heading a{padding-left:16px}nav .resource-group .collapse-content{padding:0}.action{margin-bottom:16px;padding:8px 16px 8px 8px;overflow:hidden;border:1px solid #BABDD8;border-radius:4px;background-color:#F7F9FC}.action h4.action-heading{margin:0;overflow:hidden;display:flex}.action h4.action-heading .name{font-weight:normal;align-self:center;order:5;justify-content:flex-end;flex-grow:2;display:flex}.action h4.action-heading .method{padding:10px 16px;border-radius:4px;margin-right:8px;display:inline-block}.action h4.action-heading .method.get{color:#20007A;background-color:#A98FFF}.action h4.action-heading .method.head{color:#20007A;background-color:#A98FFF}.action h4.action-heading .method.options{color:#20007A;background-color:#A98FFF}.action h4.action-heading .method.put{color:#7A4200;background-color:#FFE194}.action h4.action-heading .method.patch{color:#7A4200;background-color:#FFE194}.action h4.action-heading .method.post{color:#004F32;background-color:#8CEAB7}.action h4.action-heading .method.delete{color:#832020;background-color:#FFCCCB}.action h4.action-heading code{color:#111111;background-color:#F2F5FF;border-color:#BABDD8;font-weight:normal;word-break:break-all;display:inline-block;height:fit-content;align-self:center}.action dl.inner{padding-bottom:2px}.action .title{padding:16px}</style> <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-5K7KZHS') </script>  <link rel="stylesheet" href="styles.css" /> </head><body class="preload"><div id="nav-background"></div><div class="container-fluid triple"><div class="row"><nav><div class="resource-group selected"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="index.html#top">Overview</a></div><div class="collapse-content"><ul><li><a href="index.html#header-authorization">Authorization</a></li><li><a href="index.html#header-content-negotiation">Content Negotiation</a></li><li><a href="index.html#header-filtering">Filtering</a></li><li><a href="index.html#header-sorting">Sorting</a></li><li><a href="index.html#header-pagination">Pagination</a></li><li><a href="index.html#header-api-changes">API changes</a></li><li><a href="index.html#header-rate-limits">Rate Limits</a></li></ul></div></div><div class="section-heading">GUIDES</div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="document_format.html#document-format">Document Format</a></div><div class="collapse-content"><ul><li><a href="document_format.html#header-json-structure">JSON structure</a></li><li><a href="document_format.html#header-node-types">Node types</a></li><li><a href="document_format.html#header-mark-types">Mark types</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="error_handling.html#error-handling">Error handling</a></div><div class="collapse-content"><ul><li><a href="error_handling.html#header-possible-errors">Possible errors</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="faq.html#faq">FAQ</a></div><div class="collapse-content"><ul><li><a href="faq.html#header-general">General</a></li><li><a href="faq.html#header-deals-(budgets)">Deals (Budgets)</a></li><li><a href="faq.html#header-projects">Projects</a></li><li><a href="faq.html#header-reports">Reports</a></li><li><a href="faq.html#header-invoices">Invoices</a></li><li><a href="faq.html#header-docs">Docs</a></li><li><a href="faq.html#header-copy-to-accounting">Copy to accounting</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="importing_docs_via_api.html#importing-docs-via-api">Importing Docs via API</a></div><div class="collapse-content"><ul><li><a href="importing_docs_via_api.html#header-creating-new-docs">Creating New Docs</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="migrations.html#migration-guides">Migration Guides</a></div><div class="collapse-content"><ul><li><a href="migrations.html#header-includes-migration-guide">Includes migration guide</a></li><li><a href="migrations.html#header-how-to-prepare">How to Prepare</a></li><li><a href="migrations.html#header-migration-using-the-api-directly">Migration Using the API Directly</a></li><li><a href="migrations.html#header-migration-using-the-api_client-gem">Migration Using the api_client Gem</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="resource_representation.html#resource-representation">Resource Representation</a></div><div class="collapse-content"><ul><li><a href="resource_representation.html#header-response-format">Response format</a></li><li><a href="resource_representation.html#header-resource">Resource</a></li><li><a href="resource_representation.html#header-attributes">Attributes</a></li><li><a href="resource_representation.html#header-relationships">Relationships</a></li><li><a href="resource_representation.html#header-example-">Example:</a></li><li><a href="resource_representation.html#header-including-relationships">Including relationships</a></li><li><a href="resource_representation.html#header-sparse-fields">Sparse fields</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="working_with_attachments.html#working-with-attachments">Working with attachments</a></div><div class="collapse-content"><ul><li><a href="working_with_attachments.html#header-uploading-attachments">Uploading attachments</a></li><li><a href="working_with_attachments.html#header-accessing-attachments">Accessing attachments</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="working_with_custom_fields.html#working-with-custom-fields">Working with custom fields</a></div><div class="collapse-content"><ul><li><a href="working_with_custom_fields.html#header-creating-custom-fields">Creating custom fields</a></li><li><a href="working_with_custom_fields.html#header-filtering-custom-fields">Filtering custom fields</a></li><li><a href="working_with_custom_fields.html#header-adding-custom-fields-to-the-object">Adding custom fields to the object</a></li><li><a href="working_with_custom_fields.html#header-filtering-objects-by-custom-fields">Filtering objects by custom fields</a></li></ul></div></div><div class="section-heading">API REFERENCE</div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="activities.html#activities">Activities</a></div><div class="collapse-content"><ul><li><a href="activities.html#activities-activities">Activities</a><ul><li><a href="activities.html#activities-activities-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get activities</a></li><li><a href="activities.html#activities-activities-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a activity</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="approval_policies.html#approval-policies">Approval Policies</a></div><div class="collapse-content"><ul><li><a href="approval_policies.html#approval-policies-approval-policy">Approval Policy</a><ul><li><a href="approval_policies.html#approval-policies-approval-policy-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get approval policies</a></li><li><a href="approval_policies.html#approval-policies-approval-policy-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets the approval policy</a></li><li><a href="approval_policies.html#approval-policies-approval-policy-post"><span class="badge post"><i class="fa fa-plus"></i></span>Creates the approval policy</a></li><li><a href="approval_policies.html#approval-policies-approval-policy-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Updates the approval policy</a></li><li><a href="approval_policies.html#approval-policies-approval-policy-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Archives the approval policy</a></li><li><a href="approval_policies.html#approval-policies-approval-policy-patch-2"><span class="badge patch"><i class="fa fa-pencil"></i></span>Restores the approval policy</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="approval_policy_assignments.html#approval-policy-assignments">Approval Policy Assignments</a></div><div class="collapse-content"><ul><li><a href="approval_policy_assignments.html#approval-policy-assignments-approval-policy-assignment">Approval Policy Assignment</a><ul><li><a href="approval_policy_assignments.html#approval-policy-assignments-approval-policy-assignment-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get approval policy assignments</a></li><li><a href="approval_policy_assignments.html#approval-policy-assignments-approval-policy-assignment-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets the approval policy assignment</a></li><li><a href="approval_policy_assignments.html#approval-policy-assignments-approval-policy-assignment-post"><span class="badge post"><i class="fa fa-plus"></i></span>Creates the approval policy assignment</a></li><li><a href="approval_policy_assignments.html#approval-policy-assignments-approval-policy-assignment-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Updates the approval policy assignment</a></li><li><a href="approval_policy_assignments.html#approval-policy-assignments-approval-policy-assignment-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes the approval policy assignment</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="approval_workflows.html#approval-workflows">Approval Workflows</a></div><div class="collapse-content"><ul><li><a href="approval_workflows.html#approval-workflows-approval-workflow">Approval Workflow</a><ul><li><a href="approval_workflows.html#approval-workflows-approval-workflow-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get approval workflows</a></li><li><a href="approval_workflows.html#approval-workflows-approval-workflow-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets the approval workflow</a></li><li><a href="approval_workflows.html#approval-workflows-approval-workflow-post"><span class="badge post"><i class="fa fa-plus"></i></span>Creates the approval workflow</a></li><li><a href="approval_workflows.html#approval-workflows-approval-workflow-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Updates the approval workflow</a></li><li><a href="approval_workflows.html#approval-workflows-approval-workflow-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes the approval workflow</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="attachments.html#attachments">Attachments</a></div><div class="collapse-content"><ul><li><a href="attachments.html#attachments-attachments">Attachments</a><ul><li><a href="attachments.html#attachments-attachments-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get attachments</a></li><li><a href="attachments.html#attachments-attachments-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a attachment</a></li><li><a href="attachments.html#attachments-attachments-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a attachment</a></li><li><a href="attachments.html#attachments-attachments-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a attachment</a></li><li><a href="attachments.html#attachments-attachments-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a attachment</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="bills.html#bills">Bills</a></div><div class="collapse-content"><ul><li><a href="bills.html#bills-bills">Bills</a><ul><li><a href="bills.html#bills-bills-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a bill</a></li><li><a href="bills.html#bills-bills-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a bill</a></li><li><a href="bills.html#bills-bills-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a bill</a></li><li><a href="bills.html#bills-bills-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a bill</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="boards.html#boards">Boards</a></div><div class="collapse-content"><ul><li><a href="boards.html#boards-boards">Boards</a><ul><li><a href="boards.html#boards-boards-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get boards</a></li><li><a href="boards.html#boards-boards-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a board</a></li><li><a href="boards.html#boards-boards-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a board</a></li><li><a href="boards.html#boards-boards-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a board</a></li><li><a href="boards.html#boards-boards-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Archives a board</a></li><li><a href="boards.html#boards-boards-patch-2"><span class="badge patch"><i class="fa fa-pencil"></i></span>Restores a board</a></li><li><a href="boards.html#boards-boards-post-1"><span class="badge post"><i class="fa fa-plus"></i></span>Copy a board</a></li><li><a href="boards.html#boards-boards-patch-3"><span class="badge patch"><i class="fa fa-pencil"></i></span>Move a board</a></li><li><a href="boards.html#boards-boards-patch-4"><span class="badge patch"><i class="fa fa-pencil"></i></span>Repoisition a board</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="bookings.html#bookings">Bookings</a></div><div class="collapse-content"><ul><li><a href="bookings.html#bookings-bookings">Bookings</a><ul><li><a href="bookings.html#bookings-bookings-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get bookings</a></li><li><a href="bookings.html#bookings-bookings-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a booking</a></li><li><a href="bookings.html#bookings-bookings-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a booking</a></li><li><a href="bookings.html#bookings-bookings-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a booking</a></li><li><a href="bookings.html#bookings-bookings-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a booking</a></li><li><a href="bookings.html#bookings-bookings-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Unapproves a booking</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="comments.html#comments">Comments</a></div><div class="collapse-content"><ul><li><a href="comments.html#comments-comments">Comments</a><ul><li><a href="comments.html#comments-comments-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get comments</a></li><li><a href="comments.html#comments-comments-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a comment</a></li><li><a href="comments.html#comments-comments-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a comment</a></li><li><a href="comments.html#comments-comments-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a comment</a></li><li><a href="comments.html#comments-comments-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Pins a comment</a></li><li><a href="comments.html#comments-comments-patch-2"><span class="badge patch"><i class="fa fa-pencil"></i></span>Unpins a comment</a></li><li><a href="comments.html#comments-comments-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a comment</a></li><li><a href="comments.html#comments-comments-patch-3"><span class="badge patch"><i class="fa fa-pencil"></i></span>Adds reaction to a comment</a></li><li><a href="comments.html#comments-comments-patch-4"><span class="badge patch"><i class="fa fa-pencil"></i></span>Removes reaction from comment</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="companies.html#companies">Companies</a></div><div class="collapse-content"><ul><li><a href="companies.html#companies-companies">Companies</a><ul><li><a href="companies.html#companies-companies-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get companies</a></li><li><a href="companies.html#companies-companies-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a company</a></li><li><a href="companies.html#companies-companies-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a company</a></li><li><a href="companies.html#companies-companies-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a company</a></li><li><a href="companies.html#companies-companies-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Archives a company</a></li><li><a href="companies.html#companies-companies-patch-2"><span class="badge patch"><i class="fa fa-pencil"></i></span>Restores a company</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="contact_entries.html#contact-entries">Contact Entries</a></div><div class="collapse-content"><ul><li><a href="contact_entries.html#contact-entries-contact-entries">Contact Entries</a><ul><li><a href="contact_entries.html#contact-entries-contact-entries-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get contact entries</a></li><li><a href="contact_entries.html#contact-entries-contact-entries-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a contact entry</a></li><li><a href="contact_entries.html#contact-entries-contact-entries-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a contact entry</a></li><li><a href="contact_entries.html#contact-entries-contact-entries-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a contact entry</a></li><li><a href="contact_entries.html#contact-entries-contact-entries-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a contact entry</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="contracts.html#contracts">Contracts</a></div><div class="collapse-content"><ul><li><a href="contracts.html#contracts-contracts">Contracts</a><ul><li><a href="contracts.html#contracts-contracts-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get contracts</a></li><li><a href="contracts.html#contracts-contracts-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a contract</a></li><li><a href="contracts.html#contracts-contracts-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a contract</a></li><li><a href="contracts.html#contracts-contracts-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a contract</a></li><li><a href="contracts.html#contracts-contracts-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a contract</a></li><li><a href="contracts.html#contracts-contracts-post-1"><span class="badge post"><i class="fa fa-plus"></i></span>Generates new budget</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="custom_domain.html#custom-domain">Custom domain</a></div><div class="collapse-content"><ul><li><a href="custom_domain.html#custom-domain-custom-domains">Custom domains</a><ul><li><a href="custom_domain.html#custom-domain-custom-domains-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get custom domains</a></li><li><a href="custom_domain.html#custom-domain-custom-domains-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a custom domain</a></li><li><a href="custom_domain.html#custom-domain-custom-domains-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a custom domain</a></li><li><a href="custom_domain.html#custom-domain-custom-domains-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a custom domain</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="custom_field_options.html#custom-field-options">Custom Field Options</a></div><div class="collapse-content"><ul><li><a href="custom_field_options.html#custom-field-options-custom-field-options">Custom Field Options</a><ul><li><a href="custom_field_options.html#custom-field-options-custom-field-options-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get custom field options</a></li><li><a href="custom_field_options.html#custom-field-options-custom-field-options-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a custom field option</a></li><li><a href="custom_field_options.html#custom-field-options-custom-field-options-post"><span class="badge post"><i class="fa fa-plus"></i></span>Creates a custom field option</a></li><li><a href="custom_field_options.html#custom-field-options-custom-field-options-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Updates a custom field option</a></li><li><a href="custom_field_options.html#custom-field-options-custom-field-options-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Archives a custom field option</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="custom_field_sections.html#custom-field-sections">Custom Field Sections</a></div><div class="collapse-content"><ul><li><a href="custom_field_sections.html#custom-field-sections-custom-field-section">Custom Field Section</a><ul><li><a href="custom_field_sections.html#custom-field-sections-custom-field-section-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get custom field sections</a></li><li><a href="custom_field_sections.html#custom-field-sections-custom-field-section-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets the custom field section</a></li><li><a href="custom_field_sections.html#custom-field-sections-custom-field-section-post"><span class="badge post"><i class="fa fa-plus"></i></span>Creates the custom field section</a></li><li><a href="custom_field_sections.html#custom-field-sections-custom-field-section-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Updates the custom field section</a></li><li><a href="custom_field_sections.html#custom-field-sections-custom-field-section-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Archives the custom field section</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="custom_fields.html#custom-fields">Custom Fields</a></div><div class="collapse-content"><ul><li><a href="custom_fields.html#custom-fields-custom-fields">Custom Fields</a><ul><li><a href="custom_fields.html#custom-fields-custom-fields-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get custom fields</a></li><li><a href="custom_fields.html#custom-fields-custom-fields-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a custom field</a></li><li><a href="custom_fields.html#custom-fields-custom-fields-post"><span class="badge post"><i class="fa fa-plus"></i></span>Creates a custom field</a></li><li><a href="custom_fields.html#custom-fields-custom-fields-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Updates a custom field</a></li><li><a href="custom_fields.html#custom-fields-custom-fields-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Archives a custom field</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="dashboards.html#dashboards">Dashboards</a></div><div class="collapse-content"><ul><li><a href="dashboards.html#dashboards-dashboards">Dashboards</a><ul><li><a href="dashboards.html#dashboards-dashboards-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get all dashboards</a></li><li><a href="dashboards.html#dashboards-dashboards-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get a dashboard</a></li><li><a href="dashboards.html#dashboards-dashboards-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a dashboard</a></li><li><a href="dashboards.html#dashboards-dashboards-post-1"><span class="badge post"><i class="fa fa-plus"></i></span>Copy a dashboard</a></li><li><a href="dashboards.html#dashboards-dashboards-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a dashboard</a></li><li><a href="dashboards.html#dashboards-dashboards-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Delete a dashboard</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="deal_cost_rates.html#deal-cost-rates">Deal Cost Rates</a></div><div class="collapse-content"><ul><li><a href="deal_cost_rates.html#deal-cost-rates-deal-cost-rates">Deal Cost Rates</a><ul><li><a href="deal_cost_rates.html#deal-cost-rates-deal-cost-rates-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get deal cost rates</a></li><li><a href="deal_cost_rates.html#deal-cost-rates-deal-cost-rates-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a deal cost rate</a></li><li><a href="deal_cost_rates.html#deal-cost-rates-deal-cost-rates-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a deal cost rate</a></li><li><a href="deal_cost_rates.html#deal-cost-rates-deal-cost-rates-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a deal cost rate</a></li><li><a href="deal_cost_rates.html#deal-cost-rates-deal-cost-rates-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a deal cost rate</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="deal_statuses.html#deal-statuses">Deal Statuses</a></div><div class="collapse-content"><ul><li><a href="deal_statuses.html#deal-statuses-deal-statuses">Deal Statuses</a><ul><li><a href="deal_statuses.html#deal-statuses-deal-statuses-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get deal statuses</a></li><li><a href="deal_statuses.html#deal-statuses-deal-statuses-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a deal status</a></li><li><a href="deal_statuses.html#deal-statuses-deal-statuses-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a deal status</a></li><li><a href="deal_statuses.html#deal-statuses-deal-statuses-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a deal status</a></li><li><a href="deal_statuses.html#deal-statuses-deal-statuses-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Archives a deal status</a></li><li><a href="deal_statuses.html#deal-statuses-deal-statuses-patch-2"><span class="badge patch"><i class="fa fa-pencil"></i></span>Merges a deal status</a></li><li><a href="deal_statuses.html#deal-statuses-deal-statuses-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Destroy a deal status</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="deals.html#deals">Deals</a></div><div class="collapse-content"><ul><li><a href="deals.html#deals-deals">Deals</a><ul><li><a href="deals.html#deals-deals-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get deals</a></li><li><a href="deals.html#deals-deals-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a deal</a></li><li><a href="deals.html#deals-deals-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a deal</a></li><li><a href="deals.html#deals-deals-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a deal</a></li><li><a href="deals.html#deals-deals-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a deal</a></li><li><a href="deals.html#deals-deals-post-1"><span class="badge post"><i class="fa fa-plus"></i></span>Creates a budget from origin deal</a></li><li><a href="deals.html#deals-deals-post-2"><span class="badge post"><i class="fa fa-plus"></i></span>Copies a deal</a></li><li><a href="deals.html#deals-deals-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Opens a deal</a></li><li><a href="deals.html#deals-deals-patch-2"><span class="badge patch"><i class="fa fa-pencil"></i></span>Closes a deal</a></li><li><a href="deals.html#deals-deals-patch-3"><span class="badge patch"><i class="fa fa-pencil"></i></span>Converts a deal to budget</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="deleted_items.html#deleted-items">Deleted Items</a></div><div class="collapse-content"><ul><li><a href="deleted_items.html#deleted-items-deleted-items">Deleted Items</a><ul><li><a href="deleted_items.html#deleted-items-deleted-items-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get deleted items</a></li><li><a href="deleted_items.html#deleted-items-deleted-items-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a deleted item</a></li><li><a href="deleted_items.html#deleted-items-deleted-items-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Restores deleted object</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="discussions.html#discussions">Discussions</a></div><div class="collapse-content"><ul><li><a href="discussions.html#discussions-discussions">Discussions</a><ul><li><a href="discussions.html#discussions-discussions-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get discussions</a></li><li><a href="discussions.html#discussions-discussions-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a discussion</a></li><li><a href="discussions.html#discussions-discussions-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create an discussion</a></li><li><a href="discussions.html#discussions-discussions-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update an discussion</a></li><li><a href="discussions.html#discussions-discussions-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a discussion</a></li><li><a href="discussions.html#discussions-discussions-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Reopens a discussion</a></li><li><a href="discussions.html#discussions-discussions-patch-2"><span class="badge patch"><i class="fa fa-pencil"></i></span>Resolves a discussion</a></li><li><a href="discussions.html#discussions-discussions-patch-3"><span class="badge patch"><i class="fa fa-pencil"></i></span>Subscribes to discussion</a></li><li><a href="discussions.html#discussions-discussions-patch-4"><span class="badge patch"><i class="fa fa-pencil"></i></span>Unsubscribes from discussion</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="document_styles.html#document-styles">Document Styles</a></div><div class="collapse-content"><ul><li><a href="document_styles.html#document-styles-document-styles">Document Styles</a><ul><li><a href="document_styles.html#document-styles-document-styles-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get document_styles</a></li><li><a href="document_styles.html#document-styles-document-styles-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a document_style</a></li><li><a href="document_styles.html#document-styles-document-styles-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a document_style</a></li><li><a href="document_styles.html#document-styles-document-styles-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a document_style</a></li><li><a href="document_styles.html#document-styles-document-styles-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Destroys a document style</a></li><li><a href="document_styles.html#document-styles-document-styles-post-1"><span class="badge post"><i class="fa fa-plus"></i></span>Duplicates a document style</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="document_types.html#document-types">Document Types</a></div><div class="collapse-content"><ul><li><a href="document_types.html#document-types-document-types">Document Types</a><ul><li><a href="document_types.html#document-types-document-types-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get document_types</a></li><li><a href="document_types.html#document-types-document-types-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a document_type</a></li><li><a href="document_types.html#document-types-document-types-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a document_type</a></li><li><a href="document_types.html#document-types-document-types-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a document_type</a></li><li><a href="document_types.html#document-types-document-types-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Archives a document type</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="emails.html#emails">Emails</a></div><div class="collapse-content"><ul><li><a href="emails.html#emails-emails">Emails</a><ul><li><a href="emails.html#emails-emails-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get emails</a></li><li><a href="emails.html#emails-emails-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a email</a></li><li><a href="emails.html#emails-emails-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Attachs a email</a></li><li><a href="emails.html#emails-emails-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Dismisses a email</a></li><li><a href="emails.html#emails-emails-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a email</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="entitlements.html#entitlements">Entitlements</a></div><div class="collapse-content"><ul><li><a href="entitlements.html#entitlements-entitlements">Entitlements</a><ul><li><a href="entitlements.html#entitlements-entitlements-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get entitlements</a></li><li><a href="entitlements.html#entitlements-entitlements-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a entitlement</a></li><li><a href="entitlements.html#entitlements-entitlements-post"><span class="badge post"><i class="fa fa-plus"></i></span>Creates an entitlement</a></li><li><a href="entitlements.html#entitlements-entitlements-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Updates an entitlement</a></li><li><a href="entitlements.html#entitlements-entitlements-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes an entitlement</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="events.html#events">Events</a></div><div class="collapse-content"><ul><li><a href="events.html#events-events">Events</a><ul><li><a href="events.html#events-events-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get events</a></li><li><a href="events.html#events-events-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a event</a></li><li><a href="events.html#events-events-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create an event</a></li><li><a href="events.html#events-events-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update an event</a></li><li><a href="events.html#events-events-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Archives an event</a></li><li><a href="events.html#events-events-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes an event</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="exchange_rates.html#exchange-rates">Exchange Rates</a></div><div class="collapse-content"><ul><li><a href="exchange_rates.html#exchange-rates-exchange-rates-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get exchange rates</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="expenses.html#expenses">Expenses</a></div><div class="collapse-content"><ul><li><a href="expenses.html#expenses-expenses">Expenses</a><ul><li><a href="expenses.html#expenses-expenses-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get expenses</a></li><li><a href="expenses.html#expenses-expenses-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a expense</a></li><li><a href="expenses.html#expenses-expenses-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a expense</a></li><li><a href="expenses.html#expenses-expenses-post-1"><span class="badge post"><i class="fa fa-plus"></i></span>Copy an expense</a></li><li><a href="expenses.html#expenses-expenses-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a expense</a></li><li><a href="expenses.html#expenses-expenses-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a expense</a></li><li><a href="expenses.html#expenses-expenses-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Approves an expense</a></li><li><a href="expenses.html#expenses-expenses-patch-2"><span class="badge patch"><i class="fa fa-pencil"></i></span>Unapproves an expense</a></li><li><a href="expenses.html#expenses-expenses-patch-3"><span class="badge patch"><i class="fa fa-pencil"></i></span>Exports an expense</a></li><li><a href="expenses.html#expenses-expenses-patch-4"><span class="badge patch"><i class="fa fa-pencil"></i></span>Updates exported expense</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="filters.html#filters">Filters</a></div><div class="collapse-content"><ul><li><a href="filters.html#filters-filters">Filters</a><ul><li><a href="filters.html#filters-filters-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get filters</a></li><li><a href="filters.html#filters-filters-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a filter</a></li><li><a href="filters.html#filters-filters-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a filter</a></li><li><a href="filters.html#filters-filters-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a filter</a></li><li><a href="filters.html#filters-filters-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a filter</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="holiday_calendars.html#holiday-calendars">Holiday calendars</a></div><div class="collapse-content"><ul><li><a href="holiday_calendars.html#holiday-calendars-holiday-calendars">Holiday calendars</a><ul><li><a href="holiday_calendars.html#holiday-calendars-holiday-calendars-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get all holiday calendars</a></li><li><a href="holiday_calendars.html#holiday-calendars-holiday-calendars-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get a holiday calendar</a></li><li><a href="holiday_calendars.html#holiday-calendars-holiday-calendars-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a holiday calendar</a></li><li><a href="holiday_calendars.html#holiday-calendars-holiday-calendars-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a holiday calendar</a></li><li><a href="holiday_calendars.html#holiday-calendars-holiday-calendars-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a holiday calendar</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="holidays.html#holidays">Holidays</a></div><div class="collapse-content"><ul><li><a href="holidays.html#holidays-holidays">Holidays</a><ul><li><a href="holidays.html#holidays-holidays-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get all holidays</a></li><li><a href="holidays.html#holidays-holidays-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get a holiday</a></li><li><a href="holidays.html#holidays-holidays-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a holiday</a></li><li><a href="holidays.html#holidays-holidays-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a holiday</a></li><li><a href="holidays.html#holidays-holidays-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a holiday</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="integrations.html#integrations">Integrations</a></div><div class="collapse-content"><ul><li><a href="integrations.html#integrations-integrations">Integrations</a><ul><li><a href="integrations.html#integrations-integrations-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get integration</a></li><li><a href="integrations.html#integrations-integrations-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets an integration</a></li><li><a href="integrations.html#integrations-integrations-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create an integration</a></li><li><a href="integrations.html#integrations-integrations-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes an integration</a></li><li><a href="integrations.html#integrations-integrations-get-2"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Checks if integration is valid</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="invitations.html#invitations">Invitations</a></div><div class="collapse-content"><ul><li><a href="invitations.html#invitations-invitations">Invitations</a><ul><li><a href="invitations.html#invitations-invitations-post"><span class="badge post"><i class="fa fa-plus"></i></span>Creates a invitation</a></li><li><a href="invitations.html#invitations-invitations-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a invitation</a></li><li><a href="invitations.html#invitations-invitations-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a invitation</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="invoice_attributions.html#invoice-attributions">Invoice Attributions</a></div><div class="collapse-content"><ul><li><a href="invoice_attributions.html#invoice-attributions-invoice-attributions">Invoice Attributions</a><ul><li><a href="invoice_attributions.html#invoice-attributions-invoice-attributions-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get invoice attributions</a></li><li><a href="invoice_attributions.html#invoice-attributions-invoice-attributions-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets an invoice attribution</a></li><li><a href="invoice_attributions.html#invoice-attributions-invoice-attributions-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create an invoice attribution</a></li><li><a href="invoice_attributions.html#invoice-attributions-invoice-attributions-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update an invoice attribution</a></li><li><a href="invoice_attributions.html#invoice-attributions-invoice-attributions-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes an invoice attribution</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="invoices.html#invoices">Invoices</a></div><div class="collapse-content"><ul><li><a href="invoices.html#invoices-invoices">Invoices</a><ul><li><a href="invoices.html#invoices-invoices-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get invoices</a></li><li><a href="invoices.html#invoices-invoices-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets an invoice</a></li><li><a href="invoices.html#invoices-invoices-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create an invoice</a></li><li><a href="invoices.html#invoices-invoices-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update an invoice</a></li><li><a href="invoices.html#invoices-invoices-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes an invoice</a></li><li><a href="invoices.html#invoices-invoices-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Exports an invoice</a></li><li><a href="invoices.html#invoices-invoices-patch-2"><span class="badge patch"><i class="fa fa-pencil"></i></span>Updates an exported invoice</a></li><li><a href="invoices.html#invoices-invoices-patch-3"><span class="badge patch"><i class="fa fa-pencil"></i></span>Sends an invoice</a></li><li><a href="invoices.html#invoices-invoices-patch-4"><span class="badge patch"><i class="fa fa-pencil"></i></span>Finalizes an invoice</a></li><li><a href="invoices.html#invoices-invoices-get-2"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Preview invoice</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="line_items.html#line-items">Line Items</a></div><div class="collapse-content"><ul><li><a href="line_items.html#line-items-line-items">Line Items</a><ul><li><a href="line_items.html#line-items-line-items-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get line items</a></li><li><a href="line_items.html#line-items-line-items-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a line item</a></li><li><a href="line_items.html#line-items-line-items-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a line item</a></li><li><a href="line_items.html#line-items-line-items-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a line item</a></li><li><a href="line_items.html#line-items-line-items-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a line item</a></li><li><a href="line_items.html#line-items-line-items-post-1"><span class="badge post"><i class="fa fa-plus"></i></span>Create line items</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="lost_reasons.html#lost-reasons">Lost Reasons</a></div><div class="collapse-content"><ul><li><a href="lost_reasons.html#lost-reasons-lost-reasons">Lost Reasons</a><ul><li><a href="lost_reasons.html#lost-reasons-lost-reasons-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get lost reasons</a></li><li><a href="lost_reasons.html#lost-reasons-lost-reasons-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a lost reason</a></li><li><a href="lost_reasons.html#lost-reasons-lost-reasons-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a lost reason</a></li><li><a href="lost_reasons.html#lost-reasons-lost-reasons-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a lost reason</a></li><li><a href="lost_reasons.html#lost-reasons-lost-reasons-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Archives a lost reason</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="memberships.html#memberships">Memberships</a></div><div class="collapse-content"><ul><li><a href="memberships.html#memberships-memberships">Memberships</a><ul><li><a href="memberships.html#memberships-memberships-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get memberships</a></li><li><a href="memberships.html#memberships-memberships-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a membership</a></li><li><a href="memberships.html#memberships-memberships-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create an membership</a></li><li><a href="memberships.html#memberships-memberships-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update an membership</a></li><li><a href="memberships.html#memberships-memberships-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a membership</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="notifications.html#notifications">Notifications</a></div><div class="collapse-content"><ul><li><a href="notifications.html#notifications-notifications">Notifications</a><ul><li><a href="notifications.html#notifications-notifications-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get notifications</a></li><li><a href="notifications.html#notifications-notifications-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Shows a notification</a></li><li><a href="notifications.html#notifications-notifications-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Dismisses a notification</a></li><li><a href="notifications.html#notifications-notifications-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Reads a notification</a></li><li><a href="notifications.html#notifications-notifications-patch-2"><span class="badge patch"><i class="fa fa-pencil"></i></span>Undismisses a notification</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="organization_memberships.html#organization-memberships">Organization Memberships</a></div><div class="collapse-content"><ul><li><a href="organization_memberships.html#organization-memberships-organization-memberships">Organization Memberships</a><ul><li><a href="organization_memberships.html#organization-memberships-organization-memberships-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get organization memberships</a></li><li><a href="organization_memberships.html#organization-memberships-organization-memberships-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a organization membership</a></li><li><a href="organization_memberships.html#organization-memberships-organization-memberships-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a organization membership</a></li><li><a href="organization_memberships.html#organization-memberships-organization-memberships-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Dismiss notifications for organization membership</a></li><li><a href="organization_memberships.html#organization-memberships-organization-memberships-patch-2"><span class="badge patch"><i class="fa fa-pencil"></i></span>Clear notifications for organization membership</a></li><li><a href="organization_memberships.html#organization-memberships-organization-memberships-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Destroy organization membership</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="organization_subscriptions.html#organization-subscriptions">Organization Subscriptions</a></div><div class="collapse-content"><ul><li><a href="organization_subscriptions.html#organization-subscriptions-organization-subscriptions">Organization Subscriptions</a><ul><li><a href="organization_subscriptions.html#organization-subscriptions-organization-subscriptions-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a organization subscription</a></li><li><a href="organization_subscriptions.html#organization-subscriptions-organization-subscriptions-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a organization subscription</a></li><li><a href="organization_subscriptions.html#organization-subscriptions-organization-subscriptions-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Cancels a organization subscription</a></li><li><a href="organization_subscriptions.html#organization-subscriptions-organization-subscriptions-patch-2"><span class="badge patch"><i class="fa fa-pencil"></i></span>Reactivates a organization subscription</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="organizations.html#organizations">Organizations</a></div><div class="collapse-content"><ul><li><a href="organizations.html#organizations-organizations">Organizations</a><ul><li><a href="organizations.html#organizations-organizations-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get organizations</a></li><li><a href="organizations.html#organizations-organizations-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a organization</a></li><li><a href="organizations.html#organizations-organizations-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a organization</a></li><li><a href="organizations.html#organizations-organizations-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a organization</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="overheads.html#overheads">Overheads</a></div><div class="collapse-content"><ul><li><a href="overheads.html#overheads-overheads">Overheads</a><ul><li><a href="overheads.html#overheads-overheads-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get overheads</a></li><li><a href="overheads.html#overheads-overheads-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets an overhead</a></li><li><a href="overheads.html#overheads-overheads-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update an overhead</a></li><li><a href="overheads.html#overheads-overheads-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Recalculate an overhead</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="pages.html#pages">Pages</a></div><div class="collapse-content"><ul><li><a href="pages.html#pages-pages">Pages</a><ul><li><a href="pages.html#pages-pages-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get pages</a></li><li><a href="pages.html#pages-pages-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a page</a></li><li><a href="pages.html#pages-pages-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a page</a></li><li><a href="pages.html#pages-pages-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a page</a></li><li><a href="pages.html#pages-pages-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a page</a></li><li><a href="pages.html#pages-pages-post-1"><span class="badge post"><i class="fa fa-plus"></i></span>Copies a page</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="pageversions.html#pageversions">PageVersions</a></div><div class="collapse-content"><ul><li><a href="pageversions.html#pageversions-pageversions">PageVersions</a><ul><li><a href="pageversions.html#pageversions-pageversions-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get page_versions</a></li><li><a href="pageversions.html#pageversions-pageversions-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a page_version</a></li><li><a href="pageversions.html#pageversions-pageversions-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a page_version</a></li><li><a href="pageversions.html#pageversions-pageversions-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a page_version</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="passwords.html#passwords">Passwords</a></div><div class="collapse-content"><ul><li><a href="passwords.html#passwords-passwords">Passwords</a><ul><li><a href="passwords.html#passwords-passwords-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a password</a></li><li><a href="passwords.html#passwords-passwords-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a password</a></li><li><a href="passwords.html#passwords-passwords-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a password</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="payment_reminder_sequences.html#payment-reminder-sequences">Payment reminder sequences</a></div><div class="collapse-content"><ul><li><a href="payment_reminder_sequences.html#payment-reminder-sequences-payment-reminder-sequences">Payment reminder sequences</a><ul><li><a href="payment_reminder_sequences.html#payment-reminder-sequences-payment-reminder-sequences-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get payment reminder sequences</a></li><li><a href="payment_reminder_sequences.html#payment-reminder-sequences-payment-reminder-sequences-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a payment reminder sequence</a></li><li><a href="payment_reminder_sequences.html#payment-reminder-sequences-payment-reminder-sequences-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a payment reminder sequence</a></li><li><a href="payment_reminder_sequences.html#payment-reminder-sequences-payment-reminder-sequences-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a payment reminder sequence</a></li><li><a href="payment_reminder_sequences.html#payment-reminder-sequences-payment-reminder-sequences-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a payment reminder sequence</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="payment_reminders.html#payment-reminders">Payment reminders</a></div><div class="collapse-content"><ul><li><a href="payment_reminders.html#payment-reminders-payment-reminders">Payment reminders</a><ul><li><a href="payment_reminders.html#payment-reminders-payment-reminders-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get payment reminders</a></li><li><a href="payment_reminders.html#payment-reminders-payment-reminders-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a payment reminder</a></li><li><a href="payment_reminders.html#payment-reminders-payment-reminders-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a payment reminder</a></li><li><a href="payment_reminders.html#payment-reminders-payment-reminders-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a payment reminder</a></li><li><a href="payment_reminders.html#payment-reminders-payment-reminders-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a payment reminder</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="payments.html#payments">Payments</a></div><div class="collapse-content"><ul><li><a href="payments.html#payments-payments">Payments</a><ul><li><a href="payments.html#payments-payments-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get payments</a></li><li><a href="payments.html#payments-payments-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a payment</a></li><li><a href="payments.html#payments-payments-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a payment</a></li><li><a href="payments.html#payments-payments-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a payment</a></li><li><a href="payments.html#payments-payments-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a payment</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="people.html#people">People</a></div><div class="collapse-content"><ul><li><a href="people.html#people-people">People</a><ul><li><a href="people.html#people-people-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Invite a person</a></li><li><a href="people.html#people-people-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get people</a></li><li><a href="people.html#people-people-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get a person</a></li><li><a href="people.html#people-people-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a person</a></li><li><a href="people.html#people-people-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a person</a></li><li><a href="people.html#people-people-patch-2"><span class="badge patch"><i class="fa fa-pencil"></i></span>Resend email to a person</a></li><li><a href="people.html#people-people-patch-3"><span class="badge patch"><i class="fa fa-pencil"></i></span>Deactivate a person</a></li><li><a href="people.html#people-people-patch-4"><span class="badge patch"><i class="fa fa-pencil"></i></span>Activate a person</a></li><li><a href="people.html#people-people-patch-5"><span class="badge patch"><i class="fa fa-pencil"></i></span>Archive a person</a></li><li><a href="people.html#people-people-patch-6"><span class="badge patch"><i class="fa fa-pencil"></i></span>Restore a person</a></li><li><a href="people.html#people-people-patch-7"><span class="badge patch"><i class="fa fa-pencil"></i></span>Merge a person</a></li><li><a href="people.html#people-people-patch-8"><span class="badge patch"><i class="fa fa-pencil"></i></span>Virtualize a person</a></li><li><a href="people.html#people-people-patch-9"><span class="badge patch"><i class="fa fa-pencil"></i></span>Regenerate 2FA recovery codes</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="pipelines.html#pipelines">Pipelines</a></div><div class="collapse-content"><ul><li><a href="pipelines.html#pipelines-pipelines">Pipelines</a><ul><li><a href="pipelines.html#pipelines-pipelines-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get pipelines</a></li><li><a href="pipelines.html#pipelines-pipelines-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a pipeline</a></li><li><a href="pipelines.html#pipelines-pipelines-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a pipeline</a></li><li><a href="pipelines.html#pipelines-pipelines-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a pipeline</a></li><li><a href="pipelines.html#pipelines-pipelines-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a pipeline</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="prices.html#prices">Prices</a></div><div class="collapse-content"><ul><li><a href="prices.html#prices-prices">Prices</a><ul><li><a href="prices.html#prices-prices-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get prices</a></li><li><a href="prices.html#prices-prices-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a price</a></li><li><a href="prices.html#prices-prices-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a price</a></li><li><a href="prices.html#prices-prices-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a price</a></li><li><a href="prices.html#prices-prices-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a price</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="project_assignments.html#project-assignments">Project Assignments</a></div><div class="collapse-content"><ul><li><a href="project_assignments.html#project-assignments-project-assignments">Project Assignments</a><ul><li><a href="project_assignments.html#project-assignments-project-assignments-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get project assignments</a></li><li><a href="project_assignments.html#project-assignments-project-assignments-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a project assignment</a></li><li><a href="project_assignments.html#project-assignments-project-assignments-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a project assignment</a></li><li><a href="project_assignments.html#project-assignments-project-assignments-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a project assignment</a></li><li><a href="project_assignments.html#project-assignments-project-assignments-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a project assignment</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="projects.html#projects">Projects</a></div><div class="collapse-content"><ul><li><a href="projects.html#projects-projects">Projects</a><ul><li><a href="projects.html#projects-projects-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get projects</a></li><li><a href="projects.html#projects-projects-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a project</a></li><li><a href="projects.html#projects-projects-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a project</a></li><li><a href="projects.html#projects-projects-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a project</a></li><li><a href="projects.html#projects-projects-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Archives a project</a></li><li><a href="projects.html#projects-projects-patch-2"><span class="badge patch"><i class="fa fa-pencil"></i></span>Restores a project</a></li><li><a href="projects.html#projects-projects-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a project</a></li><li><a href="projects.html#projects-projects-post-1"><span class="badge post"><i class="fa fa-plus"></i></span>Copies a project</a></li><li><a href="projects.html#projects-projects-patch-3"><span class="badge patch"><i class="fa fa-pencil"></i></span>Changes workflow on project</a></li><li><a href="projects.html#projects-projects-patch-4"><span class="badge patch"><i class="fa fa-pencil"></i></span>Change workflow on project and map task lists to workflow statuses on project tasks</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="pulses.html#pulses">Pulses</a></div><div class="collapse-content"><ul><li><a href="pulses.html#pulses-pulses">Pulses</a><ul><li><a href="pulses.html#pulses-pulses-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get pulses</a></li><li><a href="pulses.html#pulses-pulses-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a pulse</a></li><li><a href="pulses.html#pulses-pulses-post"><span class="badge post"><i class="fa fa-plus"></i></span>Creates a pulse</a></li><li><a href="pulses.html#pulses-pulses-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Updates a pulse</a></li><li><a href="pulses.html#pulses-pulses-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a pulse</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="purchase_orders.html#purchase-orders">Purchase Orders</a></div><div class="collapse-content"><ul><li><a href="purchase_orders.html#purchase-orders-purchase-orders">Purchase Orders</a><ul><li><a href="purchase_orders.html#purchase-orders-purchase-orders-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a purchase order</a></li><li><a href="purchase_orders.html#purchase-orders-purchase-orders-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a purchase order</a></li><li><a href="purchase_orders.html#purchase-orders-purchase-orders-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a purchase order</a></li><li><a href="purchase_orders.html#purchase-orders-purchase-orders-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a purchase order</a></li><li><a href="purchase_orders.html#purchase-orders-purchase-orders-post-1"><span class="badge post"><i class="fa fa-plus"></i></span>Copies a purchase order</a></li><li><a href="purchase_orders.html#purchase-orders-purchase-orders-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Sends a purchase order</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="rate_cards.html#rate-cards">Rate cards</a></div><div class="collapse-content"><ul><li><a href="rate_cards.html#rate-cards-rate-cards">Rate cards</a><ul><li><a href="rate_cards.html#rate-cards-rate-cards-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get rate cards</a></li><li><a href="rate_cards.html#rate-cards-rate-cards-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a rate card</a></li><li><a href="rate_cards.html#rate-cards-rate-cards-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a price</a></li><li><a href="rate_cards.html#rate-cards-rate-cards-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a price</a></li><li><a href="rate_cards.html#rate-cards-rate-cards-post-1"><span class="badge post"><i class="fa fa-plus"></i></span>Copy a rate card</a></li><li><a href="rate_cards.html#rate-cards-rate-cards-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a price</a></li><li><a href="rate_cards.html#rate-cards-rate-cards-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Archives a rate card</a></li><li><a href="rate_cards.html#rate-cards-rate-cards-patch-2"><span class="badge patch"><i class="fa fa-pencil"></i></span>Restores a rate card</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="report_categories.html#report-categories">Report Categories</a></div><div class="collapse-content"><ul><li><a href="report_categories.html#report-categories-report-category">Report Category</a><ul><li><a href="report_categories.html#report-categories-report-category-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get report categories</a></li><li><a href="report_categories.html#report-categories-report-category-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a report category</a></li><li><a href="report_categories.html#report-categories-report-category-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a report category</a></li><li><a href="report_categories.html#report-categories-report-category-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a report category</a></li><li><a href="report_categories.html#report-categories-report-category-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a report category</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="reports.html#reports">Reports</a></div><div class="collapse-content"><ul><li><a href="reports.html#reports-booking-reports-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get booking reports</a></li><li><a href="reports.html#reports-budget-reports-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get budget reports</a></li><li><a href="reports.html#reports-company-reports-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get company reports</a></li><li><a href="reports.html#reports-funnel-reports-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get funnel reports</a></li><li><a href="reports.html#reports-deal-reports-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get deal reports</a></li><li><a href="reports.html#reports-entitlement-reports-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get entitlement reports</a></li><li><a href="reports.html#reports-expense-reports-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get expense reports</a></li><li><a href="reports.html#reports-finanacial-item-reports-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get financial item reports</a></li><li><a href="reports.html#reports-invoice-reports-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get invoice reports</a></li><li><a href="reports.html#reports-line-item-reports-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get line item reports</a></li><li><a href="reports.html#reports-new-deal-reports-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get new deal reports</a></li><li><a href="reports.html#reports-page-reports-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get page reports</a></li><li><a href="reports.html#reports-payment-reports-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get payment reports</a></li><li><a href="reports.html#reports-payroll-item-reports-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get payroll item reports</a></li><li><a href="reports.html#reports-person-reports-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get person reports</a></li><li><a href="reports.html#reports-price-reports-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get price reports</a></li><li><a href="reports.html#reports-project-reports-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get project reports</a></li><li><a href="reports.html#reports-salary-reports-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get salary reports</a></li><li><a href="reports.html#reports-service-reports-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get service reports</a></li><li><a href="reports.html#reports-task-reports-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get task reports</a></li><li><a href="reports.html#reports-time-entry-reports-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get time entry reports</a></li><li><a href="reports.html#reports-time-reports-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get time reports</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="salaries.html#salaries">Salaries</a></div><div class="collapse-content"><ul><li><a href="salaries.html#salaries-salaries">Salaries</a><ul><li><a href="salaries.html#salaries-salaries-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get salaries</a></li><li><a href="salaries.html#salaries-salaries-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a salary</a></li><li><a href="salaries.html#salaries-salaries-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a salary</a></li><li><a href="salaries.html#salaries-salaries-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a salary</a></li><li><a href="salaries.html#salaries-salaries-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a salary</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="sections.html#sections">Sections</a></div><div class="collapse-content"><ul><li><a href="sections.html#sections-sections">Sections</a><ul><li><a href="sections.html#sections-sections-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get sections</a></li><li><a href="sections.html#sections-sections-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a section</a></li><li><a href="sections.html#sections-sections-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a section</a></li><li><a href="sections.html#sections-sections-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a section</a></li><li><a href="sections.html#sections-sections-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a section</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="service_assignments.html#service-assignments">Service Assignments</a></div><div class="collapse-content"><ul><li><a href="service_assignments.html#service-assignments-service-assignments">Service Assignments</a><ul><li><a href="service_assignments.html#service-assignments-service-assignments-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get service assignments</a></li><li><a href="service_assignments.html#service-assignments-service-assignments-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a service assignment</a></li><li><a href="service_assignments.html#service-assignments-service-assignments-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a service assignment</a></li><li><a href="service_assignments.html#service-assignments-service-assignments-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a service assignment</a></li><li><a href="service_assignments.html#service-assignments-service-assignments-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a service assignment</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="service_type_assignments.html#service-type-assignments">Service Type Assignments</a></div><div class="collapse-content"><ul><li><a href="service_type_assignments.html#service-type-assignments-service-type-assignments">Service Type Assignments</a><ul><li><a href="service_type_assignments.html#service-type-assignments-service-type-assignments-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get service type assignments</a></li><li><a href="service_type_assignments.html#service-type-assignments-service-type-assignments-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a service type assignment</a></li><li><a href="service_type_assignments.html#service-type-assignments-service-type-assignments-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a service type assignment</a></li><li><a href="service_type_assignments.html#service-type-assignments-service-type-assignments-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a service type assignment</a></li><li><a href="service_type_assignments.html#service-type-assignments-service-type-assignments-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a service type assignment</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="service_types.html#service-types">Service Types</a></div><div class="collapse-content"><ul><li><a href="service_types.html#service-types-service-types">Service Types</a><ul><li><a href="service_types.html#service-types-service-types-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get service types</a></li><li><a href="service_types.html#service-types-service-types-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a service type</a></li><li><a href="service_types.html#service-types-service-types-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a service type</a></li><li><a href="service_types.html#service-types-service-types-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a service type</a></li><li><a href="service_types.html#service-types-service-types-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Archives a service type</a></li><li><a href="service_types.html#service-types-service-types-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a service type</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="services.html#services">Services</a></div><div class="collapse-content"><ul><li><a href="services.html#services-services">Services</a><ul><li><a href="services.html#services-services-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get services</a></li><li><a href="services.html#services-services-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a service</a></li><li><a href="services.html#services-services-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a service</a></li><li><a href="services.html#services-services-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a service</a></li><li><a href="services.html#services-services-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a service</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="sessions.html#sessions">Sessions</a></div><div class="collapse-content"><ul><li><a href="sessions.html#sessions-sessions">Sessions</a><ul><li><a href="sessions.html#sessions-sessions-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get all sessions</a></li><li><a href="sessions.html#sessions-sessions-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a session</a></li><li><a href="sessions.html#sessions-sessions-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a session</a></li><li><a href="sessions.html#sessions-sessions-put"><span class="badge put"><i class="fa fa-pencil"></i></span>Validates s session</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="subsidiaries.html#subsidiaries">Subsidiaries</a></div><div class="collapse-content"><ul><li><a href="subsidiaries.html#subsidiaries-subsidiaries">Subsidiaries</a><ul><li><a href="subsidiaries.html#subsidiaries-subsidiaries-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets all subsidiaries</a></li><li><a href="subsidiaries.html#subsidiaries-subsidiaries-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a subsidiary</a></li><li><a href="subsidiaries.html#subsidiaries-subsidiaries-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a subsidiary</a></li><li><a href="subsidiaries.html#subsidiaries-subsidiaries-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a subsidiary</a></li><li><a href="subsidiaries.html#subsidiaries-subsidiaries-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Archives a subsidiary</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="tags.html#tags">Tags</a></div><div class="collapse-content"><ul><li><a href="tags.html#tags-tags">Tags</a><ul><li><a href="tags.html#tags-tags-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get tags</a></li><li><a href="tags.html#tags-tags-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a tag</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="task_lists.html#task-lists">Task Lists</a></div><div class="collapse-content"><ul><li><a href="task_lists.html#task-lists-task-lists">Task Lists</a><ul><li><a href="task_lists.html#task-lists-task-lists-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get task lists</a></li><li><a href="task_lists.html#task-lists-task-lists-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a task list</a></li><li><a href="task_lists.html#task-lists-task-lists-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a task list</a></li><li><a href="task_lists.html#task-lists-task-lists-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a task list</a></li><li><a href="task_lists.html#task-lists-task-lists-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Archives a task list</a></li><li><a href="task_lists.html#task-lists-task-lists-patch-2"><span class="badge patch"><i class="fa fa-pencil"></i></span>Restores a task list</a></li><li><a href="task_lists.html#task-lists-task-lists-post-1"><span class="badge post"><i class="fa fa-plus"></i></span>Copies a task list</a></li><li><a href="task_lists.html#task-lists-task-lists-patch-3"><span class="badge patch"><i class="fa fa-pencil"></i></span>Moves a task list</a></li><li><a href="task_lists.html#task-lists-task-lists-patch-4"><span class="badge patch"><i class="fa fa-pencil"></i></span>Repoisition a task list</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="taskdependency.html#taskdependency">TaskDependency</a></div><div class="collapse-content"><ul><li><a href="taskdependency.html#taskdependency-taskdependency">TaskDependency</a><ul><li><a href="taskdependency.html#taskdependency-taskdependency-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get task dependncies</a></li><li><a href="taskdependency.html#taskdependency-taskdependency-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a task dependency</a></li><li><a href="taskdependency.html#taskdependency-taskdependency-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a task dependency</a></li><li><a href="taskdependency.html#taskdependency-taskdependency-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a task dependency</a></li><li><a href="taskdependency.html#taskdependency-taskdependency-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a task dependency</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="tasks.html#tasks">Tasks</a></div><div class="collapse-content"><ul><li><a href="tasks.html#tasks-tasks">Tasks</a><ul><li><a href="tasks.html#tasks-tasks-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get tasks</a></li><li><a href="tasks.html#tasks-tasks-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a task</a></li><li><a href="tasks.html#tasks-tasks-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a task</a></li><li><a href="tasks.html#tasks-tasks-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a task</a></li><li><a href="tasks.html#tasks-tasks-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a task</a></li><li><a href="tasks.html#tasks-tasks-post-1"><span class="badge post"><i class="fa fa-plus"></i></span>Copies a task</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="taxrates.html#taxrates">TaxRates</a></div><div class="collapse-content"><ul><li><a href="taxrates.html#taxrates-taxrates">TaxRates</a><ul><li><a href="taxrates.html#taxrates-taxrates-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get tax rates</a></li><li><a href="taxrates.html#taxrates-taxrates-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a tax rate</a></li><li><a href="taxrates.html#taxrates-taxrates-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a tax rate</a></li><li><a href="taxrates.html#taxrates-taxrates-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a tax rate</a></li><li><a href="taxrates.html#taxrates-taxrates-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Archives a tax rate</a></li><li><a href="taxrates.html#taxrates-taxrates-patch-2"><span class="badge patch"><i class="fa fa-pencil"></i></span>Restores an archived tax rate</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="team_memberships.html#team-memberships">Team Memberships</a></div><div class="collapse-content"><ul><li><a href="team_memberships.html#team-memberships-team-memberships">Team Memberships</a><ul><li><a href="team_memberships.html#team-memberships-team-memberships-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get team memberships</a></li><li><a href="team_memberships.html#team-memberships-team-memberships-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a team membership</a></li><li><a href="team_memberships.html#team-memberships-team-memberships-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a team membership</a></li><li><a href="team_memberships.html#team-memberships-team-memberships-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a team membership</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="teams.html#teams">Teams</a></div><div class="collapse-content"><ul><li><a href="teams.html#teams-teams">Teams</a><ul><li><a href="teams.html#teams-teams-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get teams</a></li><li><a href="teams.html#teams-teams-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a team</a></li><li><a href="teams.html#teams-teams-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a team</a></li><li><a href="teams.html#teams-teams-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a team</a></li><li><a href="teams.html#teams-teams-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a team</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="time_entries.html#time-entries">Time Entries</a></div><div class="collapse-content"><ul><li><a href="time_entries.html#time-entries-time-entries">Time Entries</a><ul><li><a href="time_entries.html#time-entries-time-entries-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get time entries</a></li><li><a href="time_entries.html#time-entries-time-entries-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a time entry</a></li><li><a href="time_entries.html#time-entries-time-entries-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a time entry</a></li><li><a href="time_entries.html#time-entries-time-entries-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a time entry</a></li><li><a href="time_entries.html#time-entries-time-entries-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Approves a time entry</a></li><li><a href="time_entries.html#time-entries-time-entries-patch-2"><span class="badge patch"><i class="fa fa-pencil"></i></span>Unapproves a time entry</a></li><li><a href="time_entries.html#time-entries-time-entries-patch-3"><span class="badge patch"><i class="fa fa-pencil"></i></span>Bulk approves time entries</a></li><li><a href="time_entries.html#time-entries-time-entries-patch-4"><span class="badge patch"><i class="fa fa-pencil"></i></span>Bulk unapproves time entries</a></li><li><a href="time_entries.html#time-entries-time-entries-patch-5"><span class="badge patch"><i class="fa fa-pencil"></i></span>Reject a time entry</a></li><li><a href="time_entries.html#time-entries-time-entries-patch-6"><span class="badge patch"><i class="fa fa-pencil"></i></span>Unreject a time entry</a></li><li><a href="time_entries.html#time-entries-time-entries-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a time entry</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="time_entry_versions.html#time-entry-versions">Time Entry Versions</a></div><div class="collapse-content"><ul><li><a href="time_entry_versions.html#time-entry-versions-time-entry-versions">Time Entry Versions</a><ul><li><a href="time_entry_versions.html#time-entry-versions-time-entry-versions-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get time entry versions</a></li><li><a href="time_entry_versions.html#time-entry-versions-time-entry-versions-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a time entry version</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="timers.html#timers">Timers</a></div><div class="collapse-content"><ul><li><a href="timers.html#timers-timers">Timers</a><ul><li><a href="timers.html#timers-timers-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get timers</a></li><li><a href="timers.html#timers-timers-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a timer</a></li><li><a href="timers.html#timers-timers-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create an timer</a></li><li><a href="timers.html#timers-timers-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Stops a timer</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="timesheet_reports.html#timesheet-reports">Timesheet Reports</a></div><div class="collapse-content"><ul><li><a href="timesheet_reports.html#timesheet-reports-timesheet-reports-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get timesheet reports</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="todos.html#todos">Todos</a></div><div class="collapse-content"><ul><li><a href="todos.html#todos-todos">Todos</a><ul><li><a href="todos.html#todos-todos-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get todos</a></li><li><a href="todos.html#todos-todos-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a todo</a></li><li><a href="todos.html#todos-todos-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a todo</a></li><li><a href="todos.html#todos-todos-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a todo</a></li><li><a href="todos.html#todos-todos-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a todo</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="users.html#users">Users</a></div><div class="collapse-content"><ul><li><a href="users.html#users-users">Users</a><ul><li><a href="users.html#users-users-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets users</a></li><li><a href="users.html#users-users-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a user</a></li><li><a href="users.html#users-users-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a user</a></li><li><a href="users.html#users-users-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update password for a user</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="webhook_logs.html#webhook-logs">Webhook Logs</a></div><div class="collapse-content"><ul><li><a href="webhook_logs.html#webhook-logs-webhook-logs-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get webhook logs</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="webhooks.html#webhooks">Webhooks</a></div><div class="collapse-content"><ul><li><a href="webhooks.html#webhooks-webhooks">Webhooks</a><ul><li><a href="webhooks.html#webhooks-webhooks-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get webhooks</a></li><li><a href="webhooks.html#webhooks-webhooks-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a webhook</a></li><li><a href="webhooks.html#webhooks-webhooks-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a webhook</a></li><li><a href="webhooks.html#webhooks-webhooks-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a webhook</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="widgets.html#widgets">Widgets</a></div><div class="collapse-content"><ul><li><a href="widgets.html#widgets-widgets">Widgets</a><ul><li><a href="widgets.html#widgets-widgets-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get all widgets</a></li><li><a href="widgets.html#widgets-widgets-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get a widget</a></li><li><a href="widgets.html#widgets-widgets-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create a widget</a></li><li><a href="widgets.html#widgets-widgets-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update a widget</a></li><li><a href="widgets.html#widgets-widgets-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a widget</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="workflow_statuses.html#workflow-statuses">Workflow Statuses</a></div><div class="collapse-content"><ul><li><a href="workflow_statuses.html#workflow-statuses-workflow-statuses">Workflow Statuses</a><ul><li><a href="workflow_statuses.html#workflow-statuses-workflow-statuses-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get workflow statuses</a></li><li><a href="workflow_statuses.html#workflow-statuses-workflow-statuses-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a workflow status</a></li><li><a href="workflow_statuses.html#workflow-statuses-workflow-statuses-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create an workflow status</a></li><li><a href="workflow_statuses.html#workflow-statuses-workflow-statuses-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update an workflow status</a></li><li><a href="workflow_statuses.html#workflow-statuses-workflow-statuses-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a workflow status and moves tasks to other workflow status</a></li></ul></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="workflows.html#workflows">Workflows</a></div><div class="collapse-content"><ul><li><a href="workflows.html#workflows-workflows">Workflows</a><ul><li><a href="workflows.html#workflows-workflows-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Get workflows</a></li><li><a href="workflows.html#workflows-workflows-get-1"><span class="badge get"><i class="fa fa-arrow-down"></i></span>Gets a workflow</a></li><li><a href="workflows.html#workflows-workflows-post"><span class="badge post"><i class="fa fa-plus"></i></span>Create an workflow</a></li><li><a href="workflows.html#workflows-workflows-patch"><span class="badge patch"><i class="fa fa-pencil"></i></span>Update an workflow</a></li><li><a href="workflows.html#workflows-workflows-delete"><span class="badge delete"><i class="fa fa-times"></i></span>Deletes a workflow</a></li><li><a href="workflows.html#workflows-workflows-patch-1"><span class="badge patch"><i class="fa fa-pencil"></i></span>Archives a workflow</a></li><li><a href="workflows.html#workflows-workflows-patch-2"><span class="badge patch"><i class="fa fa-pencil"></i></span>Restores a workflow</a></li></ul></li></ul></div></div></nav><div class="content"><div id="right-panel-background"></div><div class="middle"><header><h1 id="top">Productive API</h1></header></div><div class="right"><h5>API Endpoint</h5><a></a></div><div class="middle"><p><script> document.querySelector('#right-panel-background')?.remove(); document.querySelector('.right')?.remove(); Array.from(document.querySelectorAll('.middle')).forEach((el) => { el.classList.add('no-right'); }) </script> </p> <p>API endpoint is <a href="https://api.productive.io/api/v2/">https://api.productive.io/api/v2/</a></p> <p>This API is implemented according to <a href="https://jsonapi.org/">JSON API spec</a>.</p> <br/> <h2 id="header-authorization">Authorization <a class="permalink" href="#header-authorization" aria-hidden="true">露</a></h2> <p>To authorize yourself, add your API token to the <strong>X-Auth-Token</strong> header for every request.</p> <p>API token can be generated using Productive application, navigating to <strong>Settings</strong> -> <strong>API integrations</strong> -> <strong>Generate new token</strong></p> <p>To access your organization data, add your organization ID to the <strong>X-Organization-Id</strong> header for every request.</p> <p>Most resources have authorization on them. If successfully authorized, you will get a response containing the resource. However, if you aren鈥檛 authorized then you will be given HTTP status of 403, and an error message.</p> <br/> <h2 id="header-content-negotiation">Content Negotiation <a class="permalink" href="#header-content-negotiation" aria-hidden="true">露</a></h2> <p><code>Content-Type</code> header must be set to <code>application/vnd.api+json</code>.</p> <p>While sending bulk requests, make sure to set <code>Content-Type</code> to <code>application/vnd.api+json; ext=bulk</code>.</p> <p>When <code>Content-Type</code> is not set as described, API will return <strong>415</strong> response status error.</p> <br/> <h2 id="header-filtering">Filtering <a class="permalink" href="#header-filtering" aria-hidden="true">露</a></h2> <p>If you would like to add filtration to your query, you can do that by setting the supported filter parameters in the following way: <code>?filter[person_id]=24</code>. In case you set filter parameter that is not supported for the query, you will get 400 status error:</p> <pre><code class="language-json">{ "<span class="hljs-attribute">errors</span>": <span class="hljs-value">[ { "<span class="hljs-attribute">status</span>": <span class="hljs-value"><span class="hljs-number">400</span></span>, "<span class="hljs-attribute">title</span>": <span class="hljs-value"><span class="hljs-string">"Unsupported Filter"</span></span>, "<span class="hljs-attribute">detail</span>": <span class="hljs-value"><span class="hljs-string">"Filter 'undefined' is not supported on this endpoint"</span> </span>} ] </span>}</code></pre> <p><strong>Filter Operations</strong></p> <p>There is also support for different filter operations. Allowed operations are:</p> <ul> <li> <p><code>eq</code></p> </li> <li> <p><code>not_eq</code></p> </li> <li> <p><code>contains</code></p> </li> <li> <p><code>not_contain</code></p> </li> <li> <p><code>gt</code></p> </li> <li> <p><code>gt_eq</code></p> </li> <li> <p><code>lt</code></p> </li> <li> <p><code>lt_eq</code></p> </li> </ul> <p>To use operations for filtering, define it after the param name: <code>?filter[person_id][not_eq]=24</code>.</p> <p>NOTE: Not all endpoints support filter operations. If an endpoint supports filter operations, it will be listed in the documentation for that endpoint.</p> <p><strong>Logical operation groups</strong></p> <p>Endpoints support logical operations as well. The structure for the logical operations are as follows:</p> <pre><code><span class="hljs-header"># logical *operation*</span> filter[$op]=or|and <span class="hljs-header"># each *operation* can have one or more *operands* denoted by index numbers</span> filter[<span class="hljs-link_label">{index}</span>][<span class="hljs-link_reference">{operand}</span>] <span class="hljs-header"># *operand* can be a direct value</span> <span class="hljs-header"># Example:</span> filter[$op]=or filter[<span class="hljs-link_label">0</span>][<span class="hljs-link_reference">name</span>][<span class="hljs-link_label">eq</span>]=Productive filter[<span class="hljs-link_label">1</span>][<span class="hljs-link_reference">date</span>][<span class="hljs-link_label">gt</span>]=2024-01-01 filter[<span class="hljs-link_label">2</span>][<span class="hljs-link_reference">date</span>][<span class="hljs-link_label">eq</span>]=2023-01-01 <span class="hljs-header"># or be another logical operation</span> <span class="hljs-header"># Example:</span> filter[$op]=or filter[<span class="hljs-link_label">0</span>][<span class="hljs-link_reference">name</span>][<span class="hljs-link_label">eq</span>]=Productive filter[<span class="hljs-link_label">1</span>][<span class="hljs-link_reference">$op</span>]=and filter[<span class="hljs-link_label">1</span>][<span class="hljs-link_reference">0</span>][<span class="hljs-link_label">date</span>][<span class="hljs-link_reference">gt</span>]=2024-01-01 filter[<span class="hljs-link_label">1</span>][<span class="hljs-link_reference">1</span>][<span class="hljs-link_label">date</span>][<span class="hljs-link_reference">eq</span>]=2023-01-01</code></pre> <p><strong>DateTime filtering</strong></p> <p>By default all values sent to date or datetime filters are parsed as <code>dates</code> (only their date component is used to do the filtering)</p> <p>You can get your filter value parsed as datetime by using the <code>filteringSkipDatetimeCastToDate</code> flag.</p> <p>To enable this feature, append the <code>filteringSkipDatetimeCastToDate</code> flag to your request header (<code>X-Feature-Flags</code>).</p> <p>This functionality applies <strong>only</strong> to <code>DateTime</code> fields (e.g., <code>created_at</code>, <code>updated_at</code>). In case it is used on a <code>Date</code> field (eg., <code>end_date</code> or <code>start_date</code>) flag will be ignored and values evaluate as <code>Dates</code>.</p> <p>The table below illustrates how the filter value is interpreted based on whether the <code>filteringSkipDatetimeCastToDate</code> flag is enabled or disabled</p> <table> <thead> <tr> <th>filteringSkipDatetimeCastToDate Flag</th> <th>Value</th> <th>Parsed as</th> </tr> </thead> <tbody> <tr> <td>Disabled</td> <td>2024-09-12</td> <td>Date</td> </tr> <tr> <td>Disabled</td> <td>2024-09-12T10:15:30.000+02.00</td> <td>Date</td> </tr> <tr> <td>Enabled</td> <td>2024-09-12</td> <td>Date</td> </tr> <tr> <td>Enabled</td> <td>2024-09-12T10:15:30.000+02.00</td> <td>DateTime</td> </tr> </tbody> </table> <p>Granulation of a filter with datetime value is one second.</p> <p>NOTE: Filter values are included in the URL and must be properly URL-encoded. For instance, the character <code>+</code> should be encoded as <code>%2B</code> and <code>-</code> as <code>%2D</code></p> <br/> <h2 id="header-sorting">Sorting <a class="permalink" href="#header-sorting" aria-hidden="true">露</a></h2> <p>To sort query results, you can use sort parameter, passing available sort params for the resource: <code>?sort=name</code>. All available sort params are defined separately for each resource. You can provide desired sort order using <code>-</code> sign (<code>?sort=-name</code>), where no <code>-</code> defines ascending and <code>-</code> defines descending order by the given sort parameter. If a given parameter is not supported, <code>Unsupported Sort</code> error (with status 400) will be raised:</p> <pre><code class="language-json">{ "<span class="hljs-attribute">errors</span>": <span class="hljs-value">[ { "<span class="hljs-attribute">status</span>": <span class="hljs-value"><span class="hljs-number">400</span></span>, "<span class="hljs-attribute">title</span>": <span class="hljs-value"><span class="hljs-string">"Unsupported Sort"</span></span>, "<span class="hljs-attribute">detail</span>": <span class="hljs-value"><span class="hljs-string">"Sort by 'unsupported' is not supported on this endpoint"</span> </span>} ] </span>}</code></pre> <br/> <h2 id="header-pagination">Pagination <a class="permalink" href="#header-pagination" aria-hidden="true">露</a></h2> <p>Pagination has to be set in the following style:</p> <p><code>?page[number]=2&page[size]=20</code></p> <p>Where <code>page[number]=</code> is the page you want to view, and <code>page[size]=</code> is the number of resources you want to return.</p> <p>To check pagination settings or how many resources there are in total, check the <code>meta</code> section in the response of your request.</p> <p>There you can see the following: <br/> <code>current_page</code> - 1 by default or the value you put in <code>page[number]</code> <br/> <code>total_pages</code> - <code>total_count</code>/<code>page_size</code> rounded up <br/> <code>total_count</code> - total number of resources you have <br/> <code>page_size</code> - 30 by default or the value you put in <code>page[size]</code> <br/> <code>max_page_size</code> - 200</p> <p>An example of how to use pagination: <br/> Sending <code>page[number]=2</code> and <code>page[size]=15</code> will result in seeing resources from 16 to 30 on page 2, and the total_pages number will be <code>total_count</code>/15 rounded up.</p> <br/> <h2 id="header-api-changes">API changes <a class="permalink" href="#header-api-changes" aria-hidden="true">露</a></h2> <p>Changelog is located at <a href="https://developer.productive.io/CHANGELOG.md">https://developer.productive.io/CHANGELOG.md</a></p> <p>You can also subscribe to our email list for API change announcements. If you use API integrations, it is recommended to subscribe and stay on track with updates.</p> <p><script charset="utf-8" type="text/javascript" src="//js-eu1.hsforms.net/forms/embed/v2.js"></script> <script> hbspt.forms.create({ region: "eu1", portalId: "25060921", formId: "47ff1d8a-9554-48b1-a4fe-cfc76a0e6f9f" }); </script> </p> <p>You can later unsubscribe from this email list. We will occasionally send emails related to changes in our APIs to subscribers.</p> <br/> <h2 id="header-rate-limits">Rate Limits <a class="permalink" href="#header-rate-limits" aria-hidden="true">露</a></h2> <p>The API utilizes rate limiting to control the number of requests that can be made within a specified time period. This ensures fair usage of resources and prevents abuse or overloading of the server.</p> <p>The rate limits are structured around <code>a 100 requests per 10 seconds</code>, allowing for occasional bursts of higher request rates in short intervals. If the rate limit is exceeded, the server will respond with an appropriate HTTP status code (e.g., <code>429 Too Many Requests</code>), indicating that the client should slow down and comply with the rate limits.</p> <p>Special consideration is given to the reports endpoint due to its resource-intensive nature. To manage its usage effectively, additional throttling measures are implemented, allowing a maximum of <code>10 requests within a 30-second</code> timeframe.</p> <br/> <br/></div><div class="middle"><p style="text-align: center;" class="text-muted">Generated by <a href="https://github.com/danielgtaylor/aglio" class="aglio">aglio</a> on 26 Nov 2024</p></div></div></div></div><script src="./script.js"></script></body></html>