{ "openapi": "3.1.0", "info": { "title": "Aventra CRM API", "version": "1.0.0", "description": "Bring companies, contacts, notes, tasks and offers into Aventra. Server-to-server API; keep API keys out of browser code." }, "servers": [ { "url": "https://api.aventra.no/api/v1", "description": "Aventra CRM API" } ], "security": [ { "bearerAuth": [] } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "Create a key in Aventra → Innstillinger → API-nøkler." } } }, "paths": { "/users": { "get": { "operationId": "list-users", "tags": [ "account" ], "summary": "Find workspace users", "description": "Find assignee and owner UUIDs by email, or browse your workspace directory.\n\nRequired permissions: Read access to at least one CRM resource.\n\nUse `email` to match an address (case-insensitive, except addresses containing a literal asterisk). No match returns an empty data array. Query values must be URL encoded. Without email, results are ordered by UUID. Use `limit` (1–100, default 25) and `offset` (0–10000) and follow `page.has_more`. Only IDs, names and email addresses from your own workspace are returned.", "parameters": [ { "name": "email", "in": "query", "schema": { "type": "string", "format": "email" }, "example": "ola@example.com" }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 10000, "default": 0 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "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)$" }, "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" } }, "required": [ "id", "email", "first_name", "last_name" ] } }, "page": { "type": "object", "properties": { "size": { "type": "number" }, "offset": { "type": "number" }, "has_more": { "type": "boolean" } }, "required": [ "size", "offset", "has_more" ] } }, "required": [ "data", "page" ] }, "example": { "data": [ { "id": "f52b3fd3-5ff4-4d93-91c5-6ac79e21cdd5", "email": "ola@example.com", "first_name": "Ola", "last_name": "Nordmann" } ], "page": { "size": 25, "offset": 0, "has_more": false } } } } }, "400": { "description": "Invalid input or malformed JSON", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "401": { "description": "Missing, invalid or revoked API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "403": { "description": "Insufficient resource permissions", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "429": { "description": "Rate limit reached; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "500": { "description": "Request failed; check the outcome before retrying a write", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "503": { "description": "Temporarily busy; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } } } } }, "/me": { "get": { "operationId": "get-account", "tags": [ "account" ], "summary": "Check your connection", "description": "Verify your API key and find its workspace, creator and permission mask.\n\nRequired permissions: Any valid API key.", "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "tenant_id": { "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)$" }, "user_id": { "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)$" }, "permissions": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "tenant_id", "user_id", "permissions" ] } }, "required": [ "data" ] }, "example": { "data": { "tenant_id": "c9bb281a-6b23-48eb-8a0c-fd523748c54f", "user_id": "f52b3fd3-5ff4-4d93-91c5-6ac79e21cdd5", "permissions": 207 } } } } }, "400": { "description": "Invalid input or malformed JSON", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "401": { "description": "Missing, invalid or revoked API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "403": { "description": "Insufficient resource permissions", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "429": { "description": "Rate limit reached; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "500": { "description": "Request failed; check the outcome before retrying a write", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "503": { "description": "Temporarily busy; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } } } } }, "/companies": { "post": { "operationId": "create-company", "tags": [ "companies" ], "summary": "Create or find a company", "description": "Add a Norwegian company by organisation number. Aventra supplies the register details. An existing company is returned without changing it.\n\nRequired permissions: Companies: read and write.\n\nA new company returns **201** with `created: true`. An existing company returns **200** with `created: false`; submitted fields are ignored for that existing company. Use PATCH to update it. Repeated or concurrent requests for the same organisation number converge on the same company in your workspace. Deleted companies return **409**; restore them in Aventra. A company missing from Aventra's register returns **422**. New companies include basic register and contact details; this operation does not perform a credit assessment or import financial statements.", "parameters": [], "responses": { "200": { "description": "Company already exists; no fields changed", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "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)$" }, "orgnr": { "type": "string", "pattern": "^\\d{9}$" }, "name": { "type": "string" }, "status": { "type": "string" }, "assigned_to": { "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": "null" } ] }, "source": { "type": "string" }, "org_form": { "type": "string" }, "registered_at": { "type": "string" }, "employees": { "type": [ "number", "null" ] }, "nace_primary": { "type": [ "string", "null" ] }, "email_address": { "type": [ "string", "null" ] }, "phone_number": { "type": [ "string", "null" ] }, "mobile_number": { "type": [ "string", "null" ] }, "website_url": { "type": [ "string", "null" ] }, "is_archived": { "type": "boolean" }, "is_deleted": { "type": "boolean" } }, "required": [ "id", "orgnr", "name", "status", "assigned_to", "source", "org_form", "registered_at", "employees", "nace_primary", "email_address", "phone_number", "mobile_number", "website_url", "is_archived", "is_deleted" ] }, "created": { "type": "boolean" } }, "required": [ "data", "created" ] }, "example": { "data": { "id": "4d73dca4-7537-4f9c-924e-8bccd354663f", "orgnr": "923609016", "name": "Eksempel AS", "status": "prospect", "assigned_to": null, "source": "api", "org_form": "AS", "registered_at": "2019-10-16", "employees": 8, "nace_primary": "62.010", "email_address": null, "phone_number": null, "mobile_number": null, "website_url": null, "is_archived": false, "is_deleted": false }, "created": false } } } }, "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "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)$" }, "orgnr": { "type": "string", "pattern": "^\\d{9}$" }, "name": { "type": "string" }, "status": { "type": "string" }, "assigned_to": { "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": "null" } ] }, "source": { "type": "string" }, "org_form": { "type": "string" }, "registered_at": { "type": "string" }, "employees": { "type": [ "number", "null" ] }, "nace_primary": { "type": [ "string", "null" ] }, "email_address": { "type": [ "string", "null" ] }, "phone_number": { "type": [ "string", "null" ] }, "mobile_number": { "type": [ "string", "null" ] }, "website_url": { "type": [ "string", "null" ] }, "is_archived": { "type": "boolean" }, "is_deleted": { "type": "boolean" } }, "required": [ "id", "orgnr", "name", "status", "assigned_to", "source", "org_form", "registered_at", "employees", "nace_primary", "email_address", "phone_number", "mobile_number", "website_url", "is_archived", "is_deleted" ] }, "created": { "type": "boolean" } }, "required": [ "data", "created" ] }, "example": { "data": { "id": "4d73dca4-7537-4f9c-924e-8bccd354663f", "orgnr": "923609016", "name": "Eksempel AS", "status": "prospect", "assigned_to": null, "source": "api", "org_form": "AS", "registered_at": "2019-10-16", "employees": 8, "nace_primary": "62.010", "email_address": null, "phone_number": null, "mobile_number": null, "website_url": null, "is_archived": false, "is_deleted": false }, "created": true } } } }, "400": { "description": "Invalid input or malformed JSON", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "401": { "description": "Missing, invalid or revoked API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "403": { "description": "Insufficient resource permissions", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "409": { "description": "Identifier conflict", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "413": { "description": "Body exceeds 100 KB", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "422": { "description": "Unavailable company or invalid linked record/assignee", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "429": { "description": "Rate limit reached; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "500": { "description": "Request failed; check the outcome before retrying a write", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "503": { "description": "Temporarily busy; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "orgnr": { "type": "string", "pattern": "^\\d{9}$" }, "status": { "type": "string", "enum": [ "lead", "prospect", "contacted", "customer", "inactive_customer", "supplier" ] }, "assigned_to": { "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": "null" } ] }, "email_address": { "anyOf": [ { "type": "string", "maxLength": 320, "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, { "type": "null" } ] }, "phone_number": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 50 }, { "type": "null" } ] }, "mobile_number": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 50 }, { "type": "null" } ] }, "website_url": { "anyOf": [ { "type": "string", "maxLength": 2000, "format": "uri" }, { "type": "null" } ] } }, "required": [ "orgnr" ], "additionalProperties": false }, "example": { "orgnr": "923609016", "status": "prospect" } } } } }, "get": { "operationId": "list-companies", "tags": [ "companies" ], "summary": "List companies", "description": "Read a bounded page of companies from your workspace, ordered by CRM ID. Deleted companies are excluded; archived companies are included.\n\nRequired permissions: Companies: read.\n\nUse `limit` (1–100, default 25) and `offset` (0–10000, default 0). Advance offset by limit while `page.has_more` is true. `page.size` is the requested limit, not the returned row count. Pagination is not a snapshot: concurrent inserts or deletes can shift pages. This endpoint is intended for bounded lookups, not a full database export.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 10000, "default": 0 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "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)$" }, "orgnr": { "type": "string", "pattern": "^\\d{9}$" }, "name": { "type": "string" }, "status": { "type": "string" }, "assigned_to": { "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": "null" } ] }, "source": { "type": "string" }, "org_form": { "type": "string" }, "registered_at": { "type": "string" }, "employees": { "type": [ "number", "null" ] }, "nace_primary": { "type": [ "string", "null" ] }, "email_address": { "type": [ "string", "null" ] }, "phone_number": { "type": [ "string", "null" ] }, "mobile_number": { "type": [ "string", "null" ] }, "website_url": { "type": [ "string", "null" ] }, "is_archived": { "type": "boolean" }, "is_deleted": { "type": "boolean" } }, "required": [ "id", "orgnr", "name", "status", "assigned_to", "source", "org_form", "registered_at", "employees", "nace_primary", "email_address", "phone_number", "mobile_number", "website_url", "is_archived", "is_deleted" ] } }, "page": { "type": "object", "properties": { "size": { "type": "number" }, "offset": { "type": "number" }, "has_more": { "type": "boolean" } }, "required": [ "size", "offset", "has_more" ] } }, "required": [ "data", "page" ] }, "example": { "data": [ { "id": "4d73dca4-7537-4f9c-924e-8bccd354663f", "orgnr": "923609016", "name": "Eksempel AS", "status": "prospect", "assigned_to": null, "source": "api", "org_form": "AS", "registered_at": "2019-10-16", "employees": 8, "nace_primary": "62.010", "email_address": null, "phone_number": null, "mobile_number": null, "website_url": null, "is_archived": false, "is_deleted": false } ], "page": { "size": 25, "offset": 0, "has_more": false } } } } }, "400": { "description": "Invalid input or malformed JSON", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "401": { "description": "Missing, invalid or revoked API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "403": { "description": "Insufficient resource permissions", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "429": { "description": "Rate limit reached; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "500": { "description": "Request failed; check the outcome before retrying a write", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "503": { "description": "Temporarily busy; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } } } } }, "/companies/{orgNr}": { "patch": { "operationId": "update-company", "tags": [ "companies" ], "summary": "Update a company", "description": "Update CRM status, assignment or contact details. Omitted fields stay unchanged; null clears nullable fields.\n\nRequired permissions: Companies: read and write.", "parameters": [ { "name": "orgNr", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^\\d{9}$" }, "example": "923609016" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "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)$" }, "orgnr": { "type": "string", "pattern": "^\\d{9}$" }, "name": { "type": "string" }, "status": { "type": "string" }, "assigned_to": { "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": "null" } ] }, "source": { "type": "string" }, "org_form": { "type": "string" }, "registered_at": { "type": "string" }, "employees": { "type": [ "number", "null" ] }, "nace_primary": { "type": [ "string", "null" ] }, "email_address": { "type": [ "string", "null" ] }, "phone_number": { "type": [ "string", "null" ] }, "mobile_number": { "type": [ "string", "null" ] }, "website_url": { "type": [ "string", "null" ] }, "is_archived": { "type": "boolean" }, "is_deleted": { "type": "boolean" } }, "required": [ "id", "orgnr", "name", "status", "assigned_to", "source", "org_form", "registered_at", "employees", "nace_primary", "email_address", "phone_number", "mobile_number", "website_url", "is_archived", "is_deleted" ] } }, "required": [ "data" ] }, "example": { "data": { "id": "4d73dca4-7537-4f9c-924e-8bccd354663f", "orgnr": "923609016", "name": "Eksempel AS", "status": "customer", "assigned_to": null, "source": "api", "org_form": "AS", "registered_at": "2019-10-16", "employees": 8, "nace_primary": "62.010", "email_address": null, "phone_number": null, "mobile_number": null, "website_url": null, "is_archived": false, "is_deleted": false } } } } }, "400": { "description": "Invalid input or malformed JSON", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "401": { "description": "Missing, invalid or revoked API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "403": { "description": "Insufficient resource permissions", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "404": { "description": "Record not found in your workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "409": { "description": "Identifier conflict", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "413": { "description": "Body exceeds 100 KB", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "422": { "description": "Unavailable company or invalid linked record/assignee", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "429": { "description": "Rate limit reached; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "500": { "description": "Request failed; check the outcome before retrying a write", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "503": { "description": "Temporarily busy; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "lead", "prospect", "contacted", "customer", "inactive_customer", "supplier" ] }, "assigned_to": { "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": "null" } ] }, "email_address": { "anyOf": [ { "type": "string", "maxLength": 320, "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, { "type": "null" } ] }, "phone_number": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 50 }, { "type": "null" } ] }, "mobile_number": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 50 }, { "type": "null" } ] }, "website_url": { "anyOf": [ { "type": "string", "maxLength": 2000, "format": "uri" }, { "type": "null" } ] } }, "additionalProperties": false }, "example": { "status": "customer" } } } } }, "get": { "operationId": "get-company", "tags": [ "companies" ], "summary": "Find a company", "description": "Find a company already in your workspace by its organisation number.\n\nRequired permissions: Companies: read.\n\nA missing or deleted company returns **404**. This looks up companies in your CRM workspace; it does not search the national company register.", "parameters": [ { "name": "orgNr", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^\\d{9}$" }, "example": "923609016" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "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)$" }, "orgnr": { "type": "string", "pattern": "^\\d{9}$" }, "name": { "type": "string" }, "status": { "type": "string" }, "assigned_to": { "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": "null" } ] }, "source": { "type": "string" }, "org_form": { "type": "string" }, "registered_at": { "type": "string" }, "employees": { "type": [ "number", "null" ] }, "nace_primary": { "type": [ "string", "null" ] }, "email_address": { "type": [ "string", "null" ] }, "phone_number": { "type": [ "string", "null" ] }, "mobile_number": { "type": [ "string", "null" ] }, "website_url": { "type": [ "string", "null" ] }, "is_archived": { "type": "boolean" }, "is_deleted": { "type": "boolean" } }, "required": [ "id", "orgnr", "name", "status", "assigned_to", "source", "org_form", "registered_at", "employees", "nace_primary", "email_address", "phone_number", "mobile_number", "website_url", "is_archived", "is_deleted" ] } }, "required": [ "data" ] }, "example": { "data": { "id": "4d73dca4-7537-4f9c-924e-8bccd354663f", "orgnr": "923609016", "name": "Eksempel AS", "status": "prospect", "assigned_to": null, "source": "api", "org_form": "AS", "registered_at": "2019-10-16", "employees": 8, "nace_primary": "62.010", "email_address": null, "phone_number": null, "mobile_number": null, "website_url": null, "is_archived": false, "is_deleted": false } } } } }, "400": { "description": "Invalid input or malformed JSON", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "401": { "description": "Missing, invalid or revoked API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "403": { "description": "Insufficient resource permissions", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "404": { "description": "Record not found in your workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "429": { "description": "Rate limit reached; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "500": { "description": "Request failed; check the outcome before retrying a write", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "503": { "description": "Temporarily busy; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } } } } }, "/companies/{orgNr}/notes": { "post": { "operationId": "create-note", "tags": [ "companies" ], "summary": "Add a company note", "description": "Add plain text to a company's activity timeline, attributed to the API key creator.\n\nRequired permissions: Companies: read and write.\n\nEvery successful request adds a new note. Notes have no idempotency key. After a timeout, check the company's timeline before sending the note again. Text is displayed as plain text; HTML is not supported.", "parameters": [ { "name": "orgNr", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^\\d{9}$" }, "example": "923609016" } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "company_id": { "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": { "type": "string", "const": "add_comment" }, "content": { "type": "object", "properties": { "text": { "type": "string" } }, "required": [ "text" ] }, "user_id": { "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)$" }, "created_at": { "type": "string" } }, "required": [ "id", "company_id", "type", "content", "user_id", "created_at" ] } }, "required": [ "data" ] }, "example": { "data": { "id": 44, "company_id": "4d73dca4-7537-4f9c-924e-8bccd354663f", "type": "add_comment", "content": { "text": "Requested a demo through our website. Interested in onboarding in October." }, "user_id": "f52b3fd3-5ff4-4d93-91c5-6ac79e21cdd5", "created_at": "2026-09-05T10:00:00Z" } } } } }, "400": { "description": "Invalid input or malformed JSON", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "401": { "description": "Missing, invalid or revoked API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "403": { "description": "Insufficient resource permissions", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "404": { "description": "Record not found in your workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "409": { "description": "Identifier conflict", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "413": { "description": "Body exceeds 100 KB", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "422": { "description": "Unavailable company or invalid linked record/assignee", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "429": { "description": "Rate limit reached; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "500": { "description": "Request failed; check the outcome before retrying a write", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "503": { "description": "Temporarily busy; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "minLength": 1, "maxLength": 20000 } }, "required": [ "text" ], "additionalProperties": false }, "example": { "text": "Requested a demo through our website. Interested in onboarding in October." } } } } } }, "/contacts": { "post": { "operationId": "create-contact", "tags": [ "contacts" ], "summary": "Create a contact", "description": "Create a person in your workspace. Add email/phone details and company relationships with the separate endpoints below.\n\nRequired permissions: Contacts: read and write.\n\nSave a UUID in your integration before sending this request. A reused ID returns **409**; GET the contact to check whether an earlier request succeeded. A name or email address is not a unique contact identifier. This request does not create company links or contact details.", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "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": { "type": "string" }, "notes": { "type": "string" }, "created_at": { "type": "string" } }, "required": [ "id", "name", "notes", "created_at" ] } }, "required": [ "data" ] }, "example": { "data": { "id": "56741677-c630-43a3-a7b0-cb88ee639675", "name": "Ola Nordmann", "notes": "Interested in a product demo.", "created_at": "2026-09-05T10:00:00Z" } } } } }, "400": { "description": "Invalid input or malformed JSON", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "401": { "description": "Missing, invalid or revoked API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "403": { "description": "Insufficient resource permissions", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "409": { "description": "Identifier conflict", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "413": { "description": "Body exceeds 100 KB", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "422": { "description": "Unavailable company or invalid linked record/assignee", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "429": { "description": "Rate limit reached; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "500": { "description": "Request failed; check the outcome before retrying a write", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "503": { "description": "Temporarily busy; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "Optional UUID generated by your integration. Reusing it returns 409; GET the record to recover after a timeout.", "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": { "type": "string", "minLength": 1, "maxLength": 300 }, "notes": { "default": "", "type": "string", "maxLength": 20000 } }, "required": [ "name" ], "additionalProperties": false }, "example": { "id": "56741677-c630-43a3-a7b0-cb88ee639675", "name": "Ola Nordmann", "notes": "Interested in a product demo." } } } } } }, "/contacts/{id}": { "patch": { "operationId": "update-contact", "tags": [ "contacts" ], "summary": "Update a contact", "description": "Change a contact's name or notes. Omitted fields stay unchanged. An empty notes string clears the notes.\n\nRequired permissions: Contacts: read and write.", "parameters": [ { "name": "id", "in": "path", "required": true, "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)$" }, "example": "4d73dca4-7537-4f9c-924e-8bccd354663f" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "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": { "type": "string" }, "notes": { "type": "string" }, "created_at": { "type": "string" } }, "required": [ "id", "name", "notes", "created_at" ] } }, "required": [ "data" ] }, "example": { "data": { "id": "56741677-c630-43a3-a7b0-cb88ee639675", "name": "Ola Nordmann", "notes": "Demo booked for next Tuesday.", "created_at": "2026-09-05T10:00:00Z" } } } } }, "400": { "description": "Invalid input or malformed JSON", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "401": { "description": "Missing, invalid or revoked API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "403": { "description": "Insufficient resource permissions", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "404": { "description": "Record not found in your workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "409": { "description": "Identifier conflict", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "413": { "description": "Body exceeds 100 KB", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "422": { "description": "Unavailable company or invalid linked record/assignee", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "429": { "description": "Rate limit reached; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "500": { "description": "Request failed; check the outcome before retrying a write", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "503": { "description": "Temporarily busy; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 300 }, "notes": { "type": "string", "maxLength": 20000 } }, "additionalProperties": false }, "example": { "notes": "Demo booked for next Tuesday." } } } } }, "get": { "operationId": "get-contact", "tags": [ "contacts" ], "summary": "Get a contact", "description": "Read a contact by CRM UUID, including after a create request times out.\n\nRequired permissions: Contacts: read.", "parameters": [ { "name": "id", "in": "path", "required": true, "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)$" }, "example": "4d73dca4-7537-4f9c-924e-8bccd354663f" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "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": { "type": "string" }, "notes": { "type": "string" }, "created_at": { "type": "string" } }, "required": [ "id", "name", "notes", "created_at" ] } }, "required": [ "data" ] }, "example": { "data": { "id": "56741677-c630-43a3-a7b0-cb88ee639675", "name": "Ola Nordmann", "notes": "Interested in a product demo.", "created_at": "2026-09-05T10:00:00Z" } } } } }, "400": { "description": "Invalid input or malformed JSON", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "401": { "description": "Missing, invalid or revoked API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "403": { "description": "Insufficient resource permissions", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "404": { "description": "Record not found in your workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "429": { "description": "Rate limit reached; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "500": { "description": "Request failed; check the outcome before retrying a write", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "503": { "description": "Temporarily busy; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } } } } }, "/contacts/{id}/points": { "post": { "operationId": "create-contact-point", "tags": [ "contacts" ], "summary": "Add contact details", "description": "Add an email address, mobile number, telephone number or another contact detail.\n\nRequired permissions: Contacts: read and write.\n\nEmail values must be valid email addresses. The `other` type requires a non-empty `label`. Each request adds a new contact detail, including duplicates. After a timeout, use GET points to check for the value before retrying; concurrent duplicate requests are not deduplicated.", "parameters": [ { "name": "id", "in": "path", "required": true, "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)$" }, "example": "4d73dca4-7537-4f9c-924e-8bccd354663f" } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "type": { "type": "string" }, "label": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id", "type", "label", "value" ] } }, "required": [ "data" ] }, "example": { "data": { "id": 42, "type": "email", "label": "", "value": "ola@example.com" } } } } }, "400": { "description": "Invalid input or malformed JSON", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "401": { "description": "Missing, invalid or revoked API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "403": { "description": "Insufficient resource permissions", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "404": { "description": "Record not found in your workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "409": { "description": "Identifier conflict", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "413": { "description": "Body exceeds 100 KB", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "422": { "description": "Unavailable company or invalid linked record/assignee", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "429": { "description": "Rate limit reached; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "500": { "description": "Request failed; check the outcome before retrying a write", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "503": { "description": "Temporarily busy; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email", "phone", "mobile", "other" ] }, "value": { "type": "string", "minLength": 1, "maxLength": 1000 }, "label": { "default": "", "type": "string", "maxLength": 100 } }, "required": [ "type", "value" ], "additionalProperties": false }, "example": { "type": "email", "value": "ola@example.com" } } } } }, "get": { "operationId": "list-contact-points", "tags": [ "contacts" ], "summary": "Get contact details", "description": "Read a contact's email addresses and other contact details, ordered by ID.\n\nRequired permissions: Contacts: read.", "parameters": [ { "name": "id", "in": "path", "required": true, "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)$" }, "example": "4d73dca4-7537-4f9c-924e-8bccd354663f" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "type": { "type": "string" }, "label": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id", "type", "label", "value" ] } } }, "required": [ "data" ] }, "example": { "data": [ { "id": 42, "type": "email", "label": "", "value": "ola@example.com" } ] } } } }, "400": { "description": "Invalid input or malformed JSON", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "401": { "description": "Missing, invalid or revoked API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "403": { "description": "Insufficient resource permissions", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "404": { "description": "Record not found in your workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "429": { "description": "Rate limit reached; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "500": { "description": "Request failed; check the outcome before retrying a write", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "503": { "description": "Temporarily busy; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } } } } }, "/contacts/{id}/companies": { "post": { "operationId": "link-contact-company", "tags": [ "contacts" ], "summary": "Link a contact to a company", "description": "Connect an existing contact and company in your workspace, with an optional role.\n\nRequired permissions: Contacts AND companies: read and write.\n\nUse the company's CRM UUID, not its organisation number. Each request creates a link. After a timeout, use GET companies for the contact before retrying. There is no duplicate protection across concurrent requests.", "parameters": [ { "name": "id", "in": "path", "required": true, "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)$" }, "example": "4d73dca4-7537-4f9c-924e-8bccd354663f" } ], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "company_id": { "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)$" }, "role": { "type": "string" } }, "required": [ "id", "company_id", "role" ] } }, "required": [ "data" ] }, "example": { "data": { "id": 43, "company_id": "4d73dca4-7537-4f9c-924e-8bccd354663f", "role": "Daglig leder" } } } } }, "400": { "description": "Invalid input or malformed JSON", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "401": { "description": "Missing, invalid or revoked API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "403": { "description": "Insufficient resource permissions", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "404": { "description": "Record not found in your workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "409": { "description": "Identifier conflict", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "413": { "description": "Body exceeds 100 KB", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "422": { "description": "Unavailable company or invalid linked record/assignee", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "429": { "description": "Rate limit reached; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "500": { "description": "Request failed; check the outcome before retrying a write", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "503": { "description": "Temporarily busy; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "company_id": { "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)$" }, "role": { "default": "", "type": "string", "maxLength": 300 } }, "required": [ "company_id" ], "additionalProperties": false }, "example": { "company_id": "4d73dca4-7537-4f9c-924e-8bccd354663f", "role": "Daglig leder" } } } } }, "get": { "operationId": "list-contact-companies", "tags": [ "contacts" ], "summary": "Get company links", "description": "Read a contact's company relationships, ordered by ID.\n\nRequired permissions: Contacts AND companies: read.", "parameters": [ { "name": "id", "in": "path", "required": true, "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)$" }, "example": "4d73dca4-7537-4f9c-924e-8bccd354663f" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "company_id": { "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)$" }, "role": { "type": "string" } }, "required": [ "id", "company_id", "role" ] } } }, "required": [ "data" ] }, "example": { "data": [ { "id": 43, "company_id": "4d73dca4-7537-4f9c-924e-8bccd354663f", "role": "Daglig leder" } ] } } } }, "400": { "description": "Invalid input or malformed JSON", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "401": { "description": "Missing, invalid or revoked API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "403": { "description": "Insufficient resource permissions", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "404": { "description": "Record not found in your workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "429": { "description": "Rate limit reached; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "500": { "description": "Request failed; check the outcome before retrying a write", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "503": { "description": "Temporarily busy; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } } } } }, "/tasks": { "post": { "operationId": "create-task", "tags": [ "tasks" ], "summary": "Create a follow-up task", "description": "Give a lead a next step. Set a due date, optional company and an assignee in your workspace.\n\nRequired permissions: Tasks: read and write.\n\n`user_id` is required. Use [GET users](/docs/reference/account/list-users) to find the assignee by email. Supply a stable `id` for timeout recovery. A repeated ID returns **409**; GET the task to check the result. Set `has_time_specified: false` for a date-only task; still provide a timestamp representing the intended date in your team's timezone.", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "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)$" }, "title": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "due_date": { "type": "string" }, "has_time_specified": { "type": "boolean" }, "user_id": { "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)$" }, "related_company_id": { "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": "null" } ] }, "completed": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "title", "description", "due_date", "has_time_specified", "user_id", "related_company_id", "completed", "created_at", "updated_at" ] } }, "required": [ "data" ] }, "example": { "data": { "id": "ea2fb66b-6c76-419f-a3e7-a9f8a2d6f47c", "title": "Follow up on demo request", "description": null, "due_date": "2026-10-05T07:00:00Z", "has_time_specified": true, "user_id": "f52b3fd3-5ff4-4d93-91c5-6ac79e21cdd5", "related_company_id": "4d73dca4-7537-4f9c-924e-8bccd354663f", "completed": false, "created_at": "2026-09-05T10:00:00Z", "updated_at": "2026-09-05T10:00:00" } } } } }, "400": { "description": "Invalid input or malformed JSON", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "401": { "description": "Missing, invalid or revoked API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "403": { "description": "Insufficient resource permissions", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "404": { "description": "Record not found in your workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "409": { "description": "Identifier conflict", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "413": { "description": "Body exceeds 100 KB", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "422": { "description": "Unavailable company or invalid linked record/assignee", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "429": { "description": "Rate limit reached; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "500": { "description": "Request failed; check the outcome before retrying a write", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "503": { "description": "Temporarily busy; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "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)$" }, "title": { "type": "string", "minLength": 1, "maxLength": 300 }, "description": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] }, "due_date": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "description": "ISO 8601 timestamp with Z or a UTC offset." }, "has_time_specified": { "default": true, "type": "boolean" }, "user_id": { "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)$", "description": "Required assignee UUID. Resolve it with GET /users?email=..." }, "related_company_id": { "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": "null" } ] }, "completed": { "default": false, "type": "boolean" } }, "required": [ "title", "due_date", "user_id" ], "additionalProperties": false }, "example": { "user_id": "f52b3fd3-5ff4-4d93-91c5-6ac79e21cdd5", "title": "Follow up on demo request", "due_date": "2026-10-05T09:00:00+02:00", "related_company_id": "4d73dca4-7537-4f9c-924e-8bccd354663f" } } } } } }, "/tasks/{id}": { "patch": { "operationId": "update-task", "tags": [ "tasks" ], "summary": "Update or complete a task", "description": "Change task details or mark it complete. Only supplied fields change.\n\nRequired permissions: Tasks: read and write.\n\nSet `related_company_id: null` to detach the company. `user_id` cannot be null: a task always has an assignee.", "parameters": [ { "name": "id", "in": "path", "required": true, "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)$" }, "example": "4d73dca4-7537-4f9c-924e-8bccd354663f" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "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)$" }, "title": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "due_date": { "type": "string" }, "has_time_specified": { "type": "boolean" }, "user_id": { "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)$" }, "related_company_id": { "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": "null" } ] }, "completed": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "title", "description", "due_date", "has_time_specified", "user_id", "related_company_id", "completed", "created_at", "updated_at" ] } }, "required": [ "data" ] }, "example": { "data": { "id": "ea2fb66b-6c76-419f-a3e7-a9f8a2d6f47c", "title": "Follow up on demo request", "description": null, "due_date": "2026-10-05T07:00:00Z", "has_time_specified": true, "user_id": "f52b3fd3-5ff4-4d93-91c5-6ac79e21cdd5", "related_company_id": "4d73dca4-7537-4f9c-924e-8bccd354663f", "completed": true, "created_at": "2026-09-05T10:00:00Z", "updated_at": "2026-09-05T10:00:00" } } } } }, "400": { "description": "Invalid input or malformed JSON", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "401": { "description": "Missing, invalid or revoked API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "403": { "description": "Insufficient resource permissions", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "404": { "description": "Record not found in your workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "409": { "description": "Identifier conflict", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "413": { "description": "Body exceeds 100 KB", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "422": { "description": "Unavailable company or invalid linked record/assignee", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "429": { "description": "Rate limit reached; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "500": { "description": "Request failed; check the outcome before retrying a write", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "503": { "description": "Temporarily busy; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 300 }, "description": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] }, "due_date": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "description": "ISO 8601 timestamp with Z or a UTC offset." }, "has_time_specified": { "type": "boolean" }, "user_id": { "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)$", "description": "Required assignee UUID. Resolve it with GET /users?email=..." }, "related_company_id": { "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": "null" } ] }, "completed": { "type": "boolean" } }, "additionalProperties": false }, "example": { "completed": true } } } } }, "get": { "operationId": "get-task", "tags": [ "tasks" ], "summary": "Get a task", "description": "Check a task's details and completion state by UUID.\n\nRequired permissions: Tasks: read.", "parameters": [ { "name": "id", "in": "path", "required": true, "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)$" }, "example": "4d73dca4-7537-4f9c-924e-8bccd354663f" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "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)$" }, "title": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "due_date": { "type": "string" }, "has_time_specified": { "type": "boolean" }, "user_id": { "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)$" }, "related_company_id": { "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": "null" } ] }, "completed": { "type": "boolean" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "title", "description", "due_date", "has_time_specified", "user_id", "related_company_id", "completed", "created_at", "updated_at" ] } }, "required": [ "data" ] }, "example": { "data": { "id": "ea2fb66b-6c76-419f-a3e7-a9f8a2d6f47c", "title": "Follow up on demo request", "description": null, "due_date": "2026-10-05T07:00:00Z", "has_time_specified": true, "user_id": "f52b3fd3-5ff4-4d93-91c5-6ac79e21cdd5", "related_company_id": "4d73dca4-7537-4f9c-924e-8bccd354663f", "completed": false, "created_at": "2026-09-05T10:00:00Z", "updated_at": "2026-09-05T10:00:00" } } } } }, "400": { "description": "Invalid input or malformed JSON", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "401": { "description": "Missing, invalid or revoked API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "403": { "description": "Insufficient resource permissions", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "404": { "description": "Record not found in your workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "429": { "description": "Rate limit reached; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "500": { "description": "Request failed; check the outcome before retrying a write", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "503": { "description": "Temporarily busy; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } } } } }, "/offers": { "post": { "operationId": "create-offer", "tags": [ "offers" ], "summary": "Create an offer", "description": "Create an opportunity in the sales pipeline, linked to a company in your workspace.\n\nRequired permissions: Offers: read and write.\n\nRevenue values are whole **Norwegian kroner (NOK), excluding VAT**, not øre. Recurring revenue is the amount per selected period. Creating an offer does not send an email, generate a quote document, or add a separate timeline event. `user_id` is required. Find the owner using [GET users](/docs/reference/account/list-users). Use a stable `id` for timeout recovery: duplicate IDs return **409**.", "parameters": [], "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "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)$" }, "title": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "company_id": { "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)$" }, "user_id": { "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)$" }, "status": { "type": "string" }, "one_time_revenue": { "type": "number" }, "recurring_revenue": { "type": "number" }, "recurring_frequency": { "type": "string" }, "weight": { "type": "number" }, "created_at": { "type": "string" } }, "required": [ "id", "title", "description", "company_id", "user_id", "status", "one_time_revenue", "recurring_revenue", "recurring_frequency", "weight", "created_at" ] } }, "required": [ "data" ] }, "example": { "data": { "id": "b84e23dd-9ab0-4df3-bbfd-0fba509cdab8", "title": "CRM onboarding", "description": null, "company_id": "4d73dca4-7537-4f9c-924e-8bccd354663f", "user_id": "f52b3fd3-5ff4-4d93-91c5-6ac79e21cdd5", "status": "new", "one_time_revenue": 15000, "recurring_revenue": 2500, "recurring_frequency": "monthly", "weight": 30, "created_at": "2026-09-05T10:00:00Z" } } } } }, "400": { "description": "Invalid input or malformed JSON", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "401": { "description": "Missing, invalid or revoked API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "403": { "description": "Insufficient resource permissions", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "404": { "description": "Record not found in your workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "409": { "description": "Identifier conflict", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "413": { "description": "Body exceeds 100 KB", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "422": { "description": "Unavailable company or invalid linked record/assignee", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "429": { "description": "Rate limit reached; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "500": { "description": "Request failed; check the outcome before retrying a write", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "503": { "description": "Temporarily busy; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "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)$" }, "title": { "type": "string", "minLength": 1, "maxLength": 300 }, "company_id": { "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)$" }, "user_id": { "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)$", "description": "Required owner UUID. Resolve it with GET /users?email=..." }, "description": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] }, "status": { "default": "new", "type": "string", "enum": [ "new", "sent", "negotiating", "accepted", "rejected" ] }, "one_time_revenue": { "default": 0, "description": "Whole Norwegian kroner (NOK), excluding VAT. Not øre.", "type": "integer", "minimum": 0, "maximum": 2147483647 }, "recurring_revenue": { "default": 0, "description": "Whole NOK per recurring period, excluding VAT.", "type": "integer", "minimum": 0, "maximum": 2147483647 }, "recurring_frequency": { "default": "monthly", "type": "string", "enum": [ "monthly", "quarterly", "biannually", "annually" ] }, "weight": { "default": 0, "description": "Probability of closing, as a percentage.", "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "title", "company_id", "user_id" ], "additionalProperties": false }, "example": { "user_id": "f52b3fd3-5ff4-4d93-91c5-6ac79e21cdd5", "title": "CRM onboarding", "company_id": "4d73dca4-7537-4f9c-924e-8bccd354663f", "one_time_revenue": 15000, "recurring_revenue": 2500, "recurring_frequency": "monthly", "weight": 30 } } } } } }, "/offers/{id}": { "patch": { "operationId": "update-offer", "tags": [ "offers" ], "summary": "Update an offer", "description": "Update pipeline status, value, probability, owner or linked company. Omitted fields are preserved.\n\nRequired permissions: Offers: read and write.\n\nAn accepted offer always gets `weight: 100`, including when it is created as accepted. A supplied lower weight is ignored while the offer is accepted. Other statuses preserve the supplied or existing weight. If the status changes concurrently, the update returns 409; read the offer before retrying. Updating an offer does not send an email or add a separate timeline event.", "parameters": [ { "name": "id", "in": "path", "required": true, "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)$" }, "example": "4d73dca4-7537-4f9c-924e-8bccd354663f" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "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)$" }, "title": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "company_id": { "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)$" }, "user_id": { "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)$" }, "status": { "type": "string" }, "one_time_revenue": { "type": "number" }, "recurring_revenue": { "type": "number" }, "recurring_frequency": { "type": "string" }, "weight": { "type": "number" }, "created_at": { "type": "string" } }, "required": [ "id", "title", "description", "company_id", "user_id", "status", "one_time_revenue", "recurring_revenue", "recurring_frequency", "weight", "created_at" ] } }, "required": [ "data" ] }, "example": { "data": { "id": "b84e23dd-9ab0-4df3-bbfd-0fba509cdab8", "title": "CRM onboarding", "description": null, "company_id": "4d73dca4-7537-4f9c-924e-8bccd354663f", "user_id": "f52b3fd3-5ff4-4d93-91c5-6ac79e21cdd5", "status": "accepted", "one_time_revenue": 15000, "recurring_revenue": 2500, "recurring_frequency": "monthly", "weight": 100, "created_at": "2026-09-05T10:00:00Z" } } } } }, "400": { "description": "Invalid input or malformed JSON", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "401": { "description": "Missing, invalid or revoked API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "403": { "description": "Insufficient resource permissions", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "404": { "description": "Record not found in your workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "409": { "description": "Identifier conflict", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "413": { "description": "Body exceeds 100 KB", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "415": { "description": "Content-Type must be application/json", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "422": { "description": "Unavailable company or invalid linked record/assignee", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "429": { "description": "Rate limit reached; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "500": { "description": "Request failed; check the outcome before retrying a write", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "503": { "description": "Temporarily busy; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 300 }, "company_id": { "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)$" }, "user_id": { "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)$", "description": "Required owner UUID. Resolve it with GET /users?email=..." }, "description": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "new", "sent", "negotiating", "accepted", "rejected" ] }, "one_time_revenue": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "recurring_revenue": { "type": "integer", "minimum": 0, "maximum": 2147483647 }, "recurring_frequency": { "type": "string", "enum": [ "monthly", "quarterly", "biannually", "annually" ] }, "weight": { "type": "integer", "minimum": 0, "maximum": 100 } }, "additionalProperties": false }, "example": { "status": "accepted" } } } } }, "get": { "operationId": "get-offer", "tags": [ "offers" ], "summary": "Get an offer", "description": "Read a sales opportunity by UUID, including its value and status.\n\nRequired permissions: Offers: read.", "parameters": [ { "name": "id", "in": "path", "required": true, "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)$" }, "example": "4d73dca4-7537-4f9c-924e-8bccd354663f" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "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)$" }, "title": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "company_id": { "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)$" }, "user_id": { "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)$" }, "status": { "type": "string" }, "one_time_revenue": { "type": "number" }, "recurring_revenue": { "type": "number" }, "recurring_frequency": { "type": "string" }, "weight": { "type": "number" }, "created_at": { "type": "string" } }, "required": [ "id", "title", "description", "company_id", "user_id", "status", "one_time_revenue", "recurring_revenue", "recurring_frequency", "weight", "created_at" ] } }, "required": [ "data" ] }, "example": { "data": { "id": "b84e23dd-9ab0-4df3-bbfd-0fba509cdab8", "title": "CRM onboarding", "description": null, "company_id": "4d73dca4-7537-4f9c-924e-8bccd354663f", "user_id": "f52b3fd3-5ff4-4d93-91c5-6ac79e21cdd5", "status": "new", "one_time_revenue": 15000, "recurring_revenue": 2500, "recurring_frequency": "monthly", "weight": 30, "created_at": "2026-09-05T10:00:00Z" } } } } }, "400": { "description": "Invalid input or malformed JSON", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "401": { "description": "Missing, invalid or revoked API key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "403": { "description": "Insufficient resource permissions", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "404": { "description": "Record not found in your workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "429": { "description": "Rate limit reached; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "500": { "description": "Request failed; check the outcome before retrying a write", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } }, "503": { "description": "Temporarily busy; use Retry-After", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "details": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "message" ] } } }, "required": [ "error", "code" ] } } } } } } } } }