{"openapi":"3.0.3","info":{"title":"honestcrm API","version":"1.0.0","description":"Read and write contacts, companies, deals and tasks from your own code. Authenticate with a workspace API key as a bearer token. The same limits apply on every plan: 60 requests a minute for each key and 10,000 a day for the workspace. Webhook events: contact.created, contact.updated, contact.deleted, company.created, company.updated, company.deleted, deal.created, deal.updated, deal.deleted, deal.stage_changed, deal.won, deal.lost, task.created, task.updated, task.completed, task.deleted, form.submitted, email.opened, email.clicked, website.visited."},"servers":[{"url":"https://app.honestcrm.ai/api/v1"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"A key that starts with thk_live_"}}},"paths":{"/me":{"get":{"summary":"Show the workspace and the key","tags":["Workspace"],"description":"Needs the `read` scope.","security":[{"bearerAuth":[]}],"responses":{"200":{"description":"The workspace and the key's scopes"},"400":{"description":"The request did not pass validation"},"401":{"description":"The API key is missing, invalid or revoked"},"403":{"description":"The key lacks the scope, or a plan limit applies"},"404":{"description":"The record does not exist in this workspace"},"429":{"description":"Over the rate limit. The Retry-After header says how many seconds to wait."}}}},"/contacts":{"get":{"summary":"List contacts, newest created first","tags":["Contacts"],"description":"Needs the `read` scope.","security":[{"bearerAuth":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"default":1,"type":"integer","minimum":0,"exclusiveMinimum":true,"maximum":9007199254740991}},{"name":"limit","in":"query","required":false,"schema":{"default":20,"type":"integer","minimum":0,"exclusiveMinimum":true,"maximum":100}},{"name":"search","in":"query","required":false,"schema":{"type":"string","maxLength":200}},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string","maxLength":64}},{"name":"sortOrder","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"selectedIds","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}]}},{"name":"ownerId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","enum":["unassigned"]}]}},{"name":"leadSourceId","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"tagId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}]}},{"name":"tagMatch","in":"query","required":false,"schema":{"default":"any","type":"string","enum":["any","all"]}},{"name":"cf","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":400,"pattern":"^[0-9a-fA-F-]{36}:(eq|neq|contains|gte|lte|empty|notempty):"},{"type":"array","items":{"type":"string","maxLength":400,"pattern":"^[0-9a-fA-F-]{36}:(eq|neq|contains|gte|lte|empty|notempty):"}}]}},{"name":"companyId","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"{ data, total, page, limit }"},"400":{"description":"The request did not pass validation"},"401":{"description":"The API key is missing, invalid or revoked"},"403":{"description":"The key lacks the scope, or a plan limit applies"},"404":{"description":"The record does not exist in this workspace"},"429":{"description":"Over the rate limit. The Retry-After header says how many seconds to wait."}}},"post":{"summary":"Create a contact","tags":["Contacts"],"description":"Needs the `write` scope.","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"firstName":{"type":"string","maxLength":100},"lastName":{"type":"string","maxLength":100},"emails":{"maxItems":10,"type":"array","items":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"phones":{"maxItems":10,"type":"array","items":{"type":"string","minLength":3,"maxLength":40,"pattern":"^[+()\\d\\s.\\-x#*]+$"}},"title":{"nullable":true,"type":"string","maxLength":150},"companyId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"leadSourceId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ownerUserId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"custom":{"type":"object","additionalProperties":{}},"tagIds":{"maxItems":20,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}}}}}},"responses":{"201":{"description":"The new contact (201)"},"400":{"description":"The request did not pass validation"},"401":{"description":"The API key is missing, invalid or revoked"},"403":{"description":"The key lacks the scope, or a plan limit applies"},"404":{"description":"The record does not exist in this workspace"},"429":{"description":"Over the rate limit. The Retry-After header says how many seconds to wait."}}}},"/contacts/{id}":{"get":{"summary":"Get a contact","tags":["Contacts"],"description":"Needs the `read` scope.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"A contact"},"400":{"description":"The request did not pass validation"},"401":{"description":"The API key is missing, invalid or revoked"},"403":{"description":"The key lacks the scope, or a plan limit applies"},"404":{"description":"The record does not exist in this workspace"},"429":{"description":"Over the rate limit. The Retry-After header says how many seconds to wait."}}},"patch":{"summary":"Update a contact","tags":["Contacts"],"description":"Needs the `write` scope.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"firstName":{"type":"string","maxLength":100},"lastName":{"type":"string","maxLength":100},"emails":{"maxItems":10,"type":"array","items":{"type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"phones":{"maxItems":10,"type":"array","items":{"type":"string","minLength":3,"maxLength":40,"pattern":"^[+()\\d\\s.\\-x#*]+$"}},"title":{"nullable":true,"type":"string","maxLength":150},"companyId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"leadSourceId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ownerUserId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"custom":{"type":"object","additionalProperties":{}}}}}}},"responses":{"200":{"description":"The contact"},"400":{"description":"The request did not pass validation"},"401":{"description":"The API key is missing, invalid or revoked"},"403":{"description":"The key lacks the scope, or a plan limit applies"},"404":{"description":"The record does not exist in this workspace"},"429":{"description":"Over the rate limit. The Retry-After header says how many seconds to wait."}}}},"/companies":{"get":{"summary":"List companies, newest created first","tags":["Companies"],"description":"Needs the `read` scope.","security":[{"bearerAuth":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"default":1,"type":"integer","minimum":0,"exclusiveMinimum":true,"maximum":9007199254740991}},{"name":"limit","in":"query","required":false,"schema":{"default":20,"type":"integer","minimum":0,"exclusiveMinimum":true,"maximum":100}},{"name":"search","in":"query","required":false,"schema":{"type":"string","maxLength":200}},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string","maxLength":64}},{"name":"sortOrder","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"selectedIds","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}]}},{"name":"ownerId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","enum":["unassigned"]}]}},{"name":"leadSourceId","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"tagId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}]}},{"name":"tagMatch","in":"query","required":false,"schema":{"default":"any","type":"string","enum":["any","all"]}},{"name":"cf","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":400,"pattern":"^[0-9a-fA-F-]{36}:(eq|neq|contains|gte|lte|empty|notempty):"},{"type":"array","items":{"type":"string","maxLength":400,"pattern":"^[0-9a-fA-F-]{36}:(eq|neq|contains|gte|lte|empty|notempty):"}}]}},{"name":"hasOpenDeals","in":"query","required":false,"schema":{"type":"string","enum":["true","false"]}}],"responses":{"200":{"description":"{ data, total, page, limit }"},"400":{"description":"The request did not pass validation"},"401":{"description":"The API key is missing, invalid or revoked"},"403":{"description":"The key lacks the scope, or a plan limit applies"},"404":{"description":"The record does not exist in this workspace"},"429":{"description":"Over the rate limit. The Retry-After header says how many seconds to wait."}}},"post":{"summary":"Create a company","tags":["Companies"],"description":"Needs the `write` scope.","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"domain":{"nullable":true,"type":"string","maxLength":300},"phones":{"maxItems":10,"type":"array","items":{"type":"string","minLength":3,"maxLength":40,"pattern":"^[+()\\d\\s.\\-x#*]+$"}},"address":{"nullable":true,"type":"string","maxLength":500},"description":{"nullable":true,"type":"string","maxLength":5000},"leadSourceId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ownerUserId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"custom":{"type":"object","additionalProperties":{}},"tagIds":{"maxItems":20,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["name"]}}}},"responses":{"201":{"description":"The new company (201)"},"400":{"description":"The request did not pass validation"},"401":{"description":"The API key is missing, invalid or revoked"},"403":{"description":"The key lacks the scope, or a plan limit applies"},"404":{"description":"The record does not exist in this workspace"},"429":{"description":"Over the rate limit. The Retry-After header says how many seconds to wait."}}}},"/companies/{id}":{"get":{"summary":"Get a company","tags":["Companies"],"description":"Needs the `read` scope.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"A company"},"400":{"description":"The request did not pass validation"},"401":{"description":"The API key is missing, invalid or revoked"},"403":{"description":"The key lacks the scope, or a plan limit applies"},"404":{"description":"The record does not exist in this workspace"},"429":{"description":"Over the rate limit. The Retry-After header says how many seconds to wait."}}},"patch":{"summary":"Update a company","tags":["Companies"],"description":"Needs the `write` scope.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"domain":{"nullable":true,"type":"string","maxLength":300},"phones":{"maxItems":10,"type":"array","items":{"type":"string","minLength":3,"maxLength":40,"pattern":"^[+()\\d\\s.\\-x#*]+$"}},"address":{"nullable":true,"type":"string","maxLength":500},"description":{"nullable":true,"type":"string","maxLength":5000},"leadSourceId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ownerUserId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"custom":{"type":"object","additionalProperties":{}}}}}}},"responses":{"200":{"description":"The company"},"400":{"description":"The request did not pass validation"},"401":{"description":"The API key is missing, invalid or revoked"},"403":{"description":"The key lacks the scope, or a plan limit applies"},"404":{"description":"The record does not exist in this workspace"},"429":{"description":"Over the rate limit. The Retry-After header says how many seconds to wait."}}}},"/deals":{"get":{"summary":"List deals, newest created first","tags":["Deals"],"description":"Needs the `read` scope.","security":[{"bearerAuth":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"default":1,"type":"integer","minimum":0,"exclusiveMinimum":true,"maximum":9007199254740991}},{"name":"limit","in":"query","required":false,"schema":{"default":20,"type":"integer","minimum":0,"exclusiveMinimum":true,"maximum":100}},{"name":"search","in":"query","required":false,"schema":{"type":"string","maxLength":200}},{"name":"sortBy","in":"query","required":false,"schema":{"type":"string","maxLength":64}},{"name":"sortOrder","in":"query","required":false,"schema":{"default":"desc","type":"string","enum":["asc","desc"]}},{"name":"selectedIds","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}]}},{"name":"ownerId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","enum":["unassigned"]}]}},{"name":"leadSourceId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","enum":["none"]}]}},{"name":"tagId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}]}},{"name":"tagMatch","in":"query","required":false,"schema":{"default":"any","type":"string","enum":["any","all"]}},{"name":"cf","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":400,"pattern":"^[0-9a-fA-F-]{36}:(eq|neq|contains|gte|lte|empty|notempty):"},{"type":"array","items":{"type":"string","maxLength":400,"pattern":"^[0-9a-fA-F-]{36}:(eq|neq|contains|gte|lte|empty|notempty):"}}]}},{"name":"status","in":"query","required":false,"schema":{"default":"open","type":"string","enum":["open","won","lost","all"]}},{"name":"pipelineId","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"stageId","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"companyId","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"contactId","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"productId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","enum":["none"]}]}},{"name":"reasonId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","enum":["none"]}]}},{"name":"needsAttention","in":"query","required":false,"schema":{"type":"string","enum":["true","false"]}},{"name":"expectedCloseFrom","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},{"name":"expectedCloseTo","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},{"name":"closedFrom","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},{"name":"closedTo","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}}],"responses":{"200":{"description":"{ data, total, page, limit, totals }"},"400":{"description":"The request did not pass validation"},"401":{"description":"The API key is missing, invalid or revoked"},"403":{"description":"The key lacks the scope, or a plan limit applies"},"404":{"description":"The record does not exist in this workspace"},"429":{"description":"Over the rate limit. The Retry-After header says how many seconds to wait."}}},"post":{"summary":"Create a deal","tags":["Deals"],"description":"Needs the `write` scope.","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":200},"value":{"type":"number","minimum":0,"maximum":1000000000000},"valueType":{"type":"string","enum":["one_time","monthly"]},"expectedCloseDate":{"nullable":true,"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"primaryContactId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"leadSourceId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"productId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"productPlanId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ownerUserId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"custom":{"type":"object","additionalProperties":{}},"pipelineId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"stageId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"tagIds":{"maxItems":20,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["title"]}}}},"responses":{"201":{"description":"The new deal (201)"},"400":{"description":"The request did not pass validation"},"401":{"description":"The API key is missing, invalid or revoked"},"403":{"description":"The key lacks the scope, or a plan limit applies"},"404":{"description":"The record does not exist in this workspace"},"429":{"description":"Over the rate limit. The Retry-After header says how many seconds to wait."}}}},"/deals/{id}":{"get":{"summary":"Get a deal","tags":["Deals"],"description":"Needs the `read` scope.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"A deal"},"400":{"description":"The request did not pass validation"},"401":{"description":"The API key is missing, invalid or revoked"},"403":{"description":"The key lacks the scope, or a plan limit applies"},"404":{"description":"The record does not exist in this workspace"},"429":{"description":"Over the rate limit. The Retry-After header says how many seconds to wait."}}},"patch":{"summary":"Update a deal","tags":["Deals"],"description":"Needs the `write` scope.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":200},"value":{"type":"number","minimum":0,"maximum":1000000000000},"valueType":{"type":"string","enum":["one_time","monthly"]},"expectedCloseDate":{"nullable":true,"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"primaryContactId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"leadSourceId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"productId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"productPlanId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"ownerUserId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"custom":{"type":"object","additionalProperties":{}}}}}}},"responses":{"200":{"description":"The deal"},"400":{"description":"The request did not pass validation"},"401":{"description":"The API key is missing, invalid or revoked"},"403":{"description":"The key lacks the scope, or a plan limit applies"},"404":{"description":"The record does not exist in this workspace"},"429":{"description":"Over the rate limit. The Retry-After header says how many seconds to wait."}}}},"/tasks":{"get":{"summary":"List open tasks (sort=created lists the newest first)","tags":["Tasks"],"description":"Needs the `read` scope.","security":[{"bearerAuth":[]}],"parameters":[{"name":"filter","in":"query","required":false,"schema":{"default":"all","type":"string","enum":["all","mine","overdue","today","upcoming","nodate","completed"]}},{"name":"assigneeId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"string","enum":["me"]},{"type":"string","enum":["unassigned"]}]}},{"name":"contactId","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"companyId","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"dealId","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"linkedTo","in":"query","required":false,"schema":{"type":"string","enum":["contact","company","deal","none"]}},{"name":"dueBefore","in":"query","required":false,"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},{"name":"search","in":"query","required":false,"schema":{"type":"string","maxLength":200}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["due","created"]}},{"name":"page","in":"query","required":false,"schema":{"default":1,"type":"integer","minimum":0,"exclusiveMinimum":true,"maximum":9007199254740991}},{"name":"limit","in":"query","required":false,"schema":{"default":30,"type":"integer","minimum":0,"exclusiveMinimum":true,"maximum":100}}],"responses":{"200":{"description":"{ data, total, page, limit, hasMore }"},"400":{"description":"The request did not pass validation"},"401":{"description":"The API key is missing, invalid or revoked"},"403":{"description":"The key lacks the scope, or a plan limit applies"},"404":{"description":"The record does not exist in this workspace"},"429":{"description":"Over the rate limit. The Retry-After header says how many seconds to wait."}}},"post":{"summary":"Create a task","tags":["Tasks"],"description":"Needs the `write` scope.","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":300},"notes":{"nullable":true,"type":"string","maxLength":10000},"dueDate":{"nullable":true,"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"dueTime":{"nullable":true,"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"reminderMinutesBefore":{"nullable":true,"type":"integer","minimum":0,"maximum":10080},"assigneeUserId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contactId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"dealId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["title"]}}}},"responses":{"201":{"description":"The new task (201)"},"400":{"description":"The request did not pass validation"},"401":{"description":"The API key is missing, invalid or revoked"},"403":{"description":"The key lacks the scope, or a plan limit applies"},"404":{"description":"The record does not exist in this workspace"},"429":{"description":"Over the rate limit. The Retry-After header says how many seconds to wait."}}}},"/tasks/{id}":{"get":{"summary":"Get a task","tags":["Tasks"],"description":"Needs the `read` scope.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"A task"},"400":{"description":"The request did not pass validation"},"401":{"description":"The API key is missing, invalid or revoked"},"403":{"description":"The key lacks the scope, or a plan limit applies"},"404":{"description":"The record does not exist in this workspace"},"429":{"description":"Over the rate limit. The Retry-After header says how many seconds to wait."}}},"patch":{"summary":"Update a task","tags":["Tasks"],"description":"Needs the `write` scope.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":300},"notes":{"nullable":true,"type":"string","maxLength":10000},"dueDate":{"nullable":true,"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"dueTime":{"nullable":true,"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"},"reminderMinutesBefore":{"nullable":true,"type":"integer","minimum":0,"maximum":10080},"assigneeUserId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"contactId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"companyId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"dealId":{"nullable":true,"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}}}}},"responses":{"200":{"description":"The task"},"400":{"description":"The request did not pass validation"},"401":{"description":"The API key is missing, invalid or revoked"},"403":{"description":"The key lacks the scope, or a plan limit applies"},"404":{"description":"The record does not exist in this workspace"},"429":{"description":"Over the rate limit. The Retry-After header says how many seconds to wait."}}}},"/pipelines":{"get":{"summary":"List pipelines with their stages","tags":["Pipelines"],"description":"Needs the `read` scope.","security":[{"bearerAuth":[]}],"responses":{"200":{"description":"{ pipelines }"},"400":{"description":"The request did not pass validation"},"401":{"description":"The API key is missing, invalid or revoked"},"403":{"description":"The key lacks the scope, or a plan limit applies"},"404":{"description":"The record does not exist in this workspace"},"429":{"description":"Over the rate limit. The Retry-After header says how many seconds to wait."}}}},"/pipelines/{id}":{"get":{"summary":"Get a pipeline with its stages","tags":["Pipelines"],"description":"Needs the `read` scope.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"A pipeline"},"400":{"description":"The request did not pass validation"},"401":{"description":"The API key is missing, invalid or revoked"},"403":{"description":"The key lacks the scope, or a plan limit applies"},"404":{"description":"The record does not exist in this workspace"},"429":{"description":"Over the rate limit. The Retry-After header says how many seconds to wait."}}}},"/stages":{"get":{"summary":"List every stage with its pipeline id","tags":["Pipelines"],"description":"Needs the `read` scope.","security":[{"bearerAuth":[]}],"responses":{"200":{"description":"{ stages }"},"400":{"description":"The request did not pass validation"},"401":{"description":"The API key is missing, invalid or revoked"},"403":{"description":"The key lacks the scope, or a plan limit applies"},"404":{"description":"The record does not exist in this workspace"},"429":{"description":"Over the rate limit. The Retry-After header says how many seconds to wait."}}}},"/hooks":{"post":{"summary":"Subscribe a REST hook (Zapier, Make)","tags":["Hooks"],"description":"Needs the `write` scope.","security":[{"bearerAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"target_url":{"type":"string","maxLength":2000,"format":"uri"},"targetUrl":{"type":"string","maxLength":2000,"format":"uri"},"event":{"type":"string","enum":["contact.created","contact.updated","contact.deleted","company.created","company.updated","company.deleted","deal.created","deal.updated","deal.deleted","deal.stage_changed","deal.won","deal.lost","task.created","task.updated","task.completed","task.deleted","form.submitted","email.opened","email.clicked","website.visited"]}},"required":["event"]}}}},"responses":{"201":{"description":"{ id, event, targetUrl, secret } (201)"},"400":{"description":"The request did not pass validation"},"401":{"description":"The API key is missing, invalid or revoked"},"403":{"description":"The key lacks the scope, or a plan limit applies"},"404":{"description":"The record does not exist in this workspace"},"429":{"description":"Over the rate limit. The Retry-After header says how many seconds to wait."}}},"get":{"summary":"List REST hooks","tags":["Hooks"],"description":"Needs the `read` scope.","security":[{"bearerAuth":[]}],"responses":{"200":{"description":"{ hooks }"},"400":{"description":"The request did not pass validation"},"401":{"description":"The API key is missing, invalid or revoked"},"403":{"description":"The key lacks the scope, or a plan limit applies"},"404":{"description":"The record does not exist in this workspace"},"429":{"description":"Over the rate limit. The Retry-After header says how many seconds to wait."}}}},"/hooks/{id}":{"delete":{"summary":"Unsubscribe a REST hook","tags":["Hooks"],"description":"Needs the `write` scope.","security":[{"bearerAuth":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"{ success: true }"},"400":{"description":"The request did not pass validation"},"401":{"description":"The API key is missing, invalid or revoked"},"403":{"description":"The key lacks the scope, or a plan limit applies"},"404":{"description":"The record does not exist in this workspace"},"429":{"description":"Over the rate limit. The Retry-After header says how many seconds to wait."}}}}}}