{ "openapi": "3.1.0", "info": { "title": "Staffly API", "version": "1.0.0", "description": "Connect your tools to Staffly. Manage CRM records, explore call activity, and keep integrations in sync.\n\n## Authentication\nCreate an API key in **Settings → Integrations** as an organization owner or admin. Grant only the resource scopes your integration needs. Send the secret as `Authorization: Bearer ` or `x-api-key: `. Every request is restricted to the key’s organization. Existing keys do not acquire new scopes automatically.\n\nUse the **Test Request** explorer to send real requests. Write and delete requests change live data. Credentials are held only for the current page session.\n\n## Pagination\nCollection endpoints for contacts, companies, deals, pipelines, activity types, and outcomes accept `limit` and `offset`. Default limit: 50; maximum: 100. Responses contain `data`, `limit`, `offset`, and `total`. Call metrics return aggregate results instead.\n\n## Call reporting\nDiscover your pipeline IDs using `GET /pipelines`. Discover activity and outcome IDs using `GET /calls/activity-types` and `GET /calls/call-outcomes`. Pass those IDs to `GET /calls` with a date range. Category names come from each organization’s settings.\n\n## Errors\nErrors use a JSON object with an `error` message. A 401 means the key is absent, invalid, or revoked; 403 means a required scope is missing. Records outside your organization are not accessible.\n\nThis reference is generated from the repository implementation. New endpoints become available after their API release is deployed." }, "servers": [ { "url": "https://api.stafflyhq.ai/api", "description": "Staffly API" } ], "security": [ { "BearerAuth": [] }, { "ApiKey": [] } ], "tags": [ { "name": "Calls" }, { "name": "Call settings" }, { "name": "Pipelines" }, { "name": "Contacts" }, { "name": "Companies" }, { "name": "Deals" }, { "name": "Notifications" } ], "paths": { "/contacts": { "get": { "tags": [ "Contacts" ], "summary": "List contacts", "operationId": "get__contacts", "description": "**Required scope:** `contacts:read`.\n\nNewest created records first. All records and totals are restricted to the API key’s organization. Phone and email filters are optional; when both are supplied, both must match. Values are trimmed, with no phone-format normalization. Empty or repeated filters return 400. Pagination and total apply to the filtered results.", "x-required-scope": "contacts:read", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } }, "limit": { "type": "integer", "minimum": 0 }, "offset": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 } }, "required": [ "data", "limit", "offset", "total" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, or revoked API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Required scope missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in your organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation or configuration error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Page size; values above 100 are capped.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "offset", "in": "query", "required": false, "description": "Zero-based offset into the matching collection.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "phone", "in": "query", "required": false, "description": "Exact match on primary_phone or secondary_phone. Use the stored format; encode a leading + as %2B.", "schema": { "type": "string", "example": "15551234567" } }, { "name": "email", "in": "query", "required": false, "description": "Exact, case-sensitive match on primary_email or secondary_email.", "schema": { "type": "string", "example": "john@acme.com" } } ] }, "post": { "tags": [ "Contacts" ], "summary": "Create contact", "operationId": "post__contacts", "description": "**Required scope:** `contacts:write`.\n\nOnly documented writable fields are accepted. The organization is assigned from the API key.", "x-required-scope": "contacts:write", "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Contact" } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, or revoked API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Required scope missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in your organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation or configuration error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactCreate" } } } } } }, "/contacts/{id}": { "get": { "tags": [ "Contacts" ], "summary": "Get contact", "operationId": "get__contacts_id_", "description": "**Required scope:** `contacts:read`.\n\n", "x-required-scope": "contacts:read", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Contact" } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, or revoked API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Required scope missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in your organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation or configuration error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Staffly resource UUID.", "schema": { "type": "string", "format": "uuid" } } ] }, "patch": { "tags": [ "Contacts" ], "summary": "Update contact", "operationId": "patch__contacts_id_", "description": "**Required scope:** `contacts:write`.\n\nPartial update; omitted fields retain their values. PUT uses the same partial-update behavior as PATCH.", "x-required-scope": "contacts:write", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Contact" } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, or revoked API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Required scope missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in your organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation or configuration error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Staffly resource UUID.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactUpdate" } } } } }, "put": { "tags": [ "Contacts" ], "summary": "Update contact (PUT alias)", "operationId": "put__contacts_id_", "description": "**Required scope:** `contacts:write`.\n\nPartial update; omitted fields retain their values. PUT uses the same partial-update behavior as PATCH.", "x-required-scope": "contacts:write", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Contact" } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, or revoked API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Required scope missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in your organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation or configuration error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Staffly resource UUID.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactUpdate" } } } } }, "delete": { "tags": [ "Contacts" ], "summary": "Delete contact", "operationId": "delete__contacts_id_", "description": "**Required scope:** `contacts:delete`.\n\nPermanently deletes the record. Requests sent through the explorer modify real organization data.", "x-required-scope": "contacts:delete", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "deleted": { "type": "boolean", "const": true } }, "required": [ "id", "deleted" ] } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, or revoked API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Required scope missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in your organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation or configuration error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Staffly resource UUID.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/companies": { "get": { "tags": [ "Companies" ], "summary": "List companies", "operationId": "get__companies", "description": "**Required scope:** `companies:read`.\n\nNewest created records first. All records and totals are restricted to the API key’s organization.", "x-required-scope": "companies:read", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Company" } }, "limit": { "type": "integer", "minimum": 0 }, "offset": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 } }, "required": [ "data", "limit", "offset", "total" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, or revoked API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Required scope missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in your organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation or configuration error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Page size; values above 100 are capped.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "offset", "in": "query", "required": false, "description": "Zero-based offset into the matching collection.", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ] }, "post": { "tags": [ "Companies" ], "summary": "Create company", "operationId": "post__companies", "description": "**Required scope:** `companies:write`.\n\nOnly documented writable fields are accepted. The organization is assigned from the API key.", "x-required-scope": "companies:write", "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Company" } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, or revoked API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Required scope missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in your organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation or configuration error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyCreate" } } } } } }, "/companies/{id}": { "get": { "tags": [ "Companies" ], "summary": "Get company", "operationId": "get__companies_id_", "description": "**Required scope:** `companies:read`.\n\n", "x-required-scope": "companies:read", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Company" } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, or revoked API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Required scope missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in your organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation or configuration error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Staffly resource UUID.", "schema": { "type": "string", "format": "uuid" } } ] }, "patch": { "tags": [ "Companies" ], "summary": "Update company", "operationId": "patch__companies_id_", "description": "**Required scope:** `companies:write`.\n\nPartial update; omitted fields retain their values. PUT uses the same partial-update behavior as PATCH.", "x-required-scope": "companies:write", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Company" } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, or revoked API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Required scope missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in your organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation or configuration error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Staffly resource UUID.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyUpdate" } } } } }, "put": { "tags": [ "Companies" ], "summary": "Update company (PUT alias)", "operationId": "put__companies_id_", "description": "**Required scope:** `companies:write`.\n\nPartial update; omitted fields retain their values. PUT uses the same partial-update behavior as PATCH.", "x-required-scope": "companies:write", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Company" } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, or revoked API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Required scope missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in your organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation or configuration error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Staffly resource UUID.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyUpdate" } } } } }, "delete": { "tags": [ "Companies" ], "summary": "Delete company", "operationId": "delete__companies_id_", "description": "**Required scope:** `companies:delete`.\n\nPermanently deletes the record. Requests sent through the explorer modify real organization data.", "x-required-scope": "companies:delete", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "deleted": { "type": "boolean", "const": true } }, "required": [ "id", "deleted" ] } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, or revoked API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Required scope missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in your organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation or configuration error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Staffly resource UUID.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/deals": { "get": { "tags": [ "Deals" ], "summary": "List deals", "operationId": "get__deals", "description": "**Required scope:** `deals:read`.\n\nNewest created records first. All records and totals are restricted to the API key’s organization.", "x-required-scope": "deals:read", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Deal" } }, "limit": { "type": "integer", "minimum": 0 }, "offset": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 } }, "required": [ "data", "limit", "offset", "total" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, or revoked API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Required scope missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in your organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation or configuration error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Page size; values above 100 are capped.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "offset", "in": "query", "required": false, "description": "Zero-based offset into the matching collection.", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ] }, "post": { "tags": [ "Deals" ], "summary": "Create deal", "operationId": "post__deals", "description": "**Required scope:** `deals:write`.\n\nCreates a deal with a required primary contact and optional additional contacts in one transaction.", "x-required-scope": "deals:write", "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Deal" } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, or revoked API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Required scope missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in your organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation or configuration error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealCreate" } } } } } }, "/deals/{id}": { "get": { "tags": [ "Deals" ], "summary": "Get deal", "operationId": "get__deals_id_", "description": "**Required scope:** `deals:read`.\n\n", "x-required-scope": "deals:read", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Deal" } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, or revoked API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Required scope missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in your organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation or configuration error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Staffly resource UUID.", "schema": { "type": "string", "format": "uuid" } } ] }, "patch": { "tags": [ "Deals" ], "summary": "Update deal", "operationId": "patch__deals_id_", "description": "**Required scope:** `deals:write`.\n\nPartial update; omitted fields retain their values. PUT uses the same partial-update behavior as PATCH.", "x-required-scope": "deals:write", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Deal" } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, or revoked API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Required scope missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in your organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation or configuration error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Staffly resource UUID.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealUpdate" } } } } }, "put": { "tags": [ "Deals" ], "summary": "Update deal (PUT alias)", "operationId": "put__deals_id_", "description": "**Required scope:** `deals:write`.\n\nPartial update; omitted fields retain their values. PUT uses the same partial-update behavior as PATCH.", "x-required-scope": "deals:write", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Deal" } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, or revoked API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Required scope missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in your organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation or configuration error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Staffly resource UUID.", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealUpdate" } } } } }, "delete": { "tags": [ "Deals" ], "summary": "Delete deal", "operationId": "delete__deals_id_", "description": "**Required scope:** `deals:delete`.\n\nPermanently deletes the record. Requests sent through the explorer modify real organization data.", "x-required-scope": "deals:delete", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "deleted": { "type": "boolean", "const": true } }, "required": [ "id", "deleted" ] } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, or revoked API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Required scope missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in your organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation or configuration error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Staffly resource UUID.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/calls/activity-types": { "get": { "tags": [ "Call settings" ], "summary": "List activity types", "operationId": "get__calls_activity_types", "description": "**Required scope:** `activity-types:read`.\n\nSorted by display order, then ID; null display orders last. Inactive definitions are included by default. Use returned IDs as filters on GET /calls.", "x-required-scope": "activity-types:read", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityType" } }, "limit": { "type": "integer", "minimum": 0 }, "offset": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 } }, "required": [ "data", "limit", "offset", "total" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, or revoked API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Required scope missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in your organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation or configuration error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Page size; values above 100 are capped.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "offset", "in": "query", "required": false, "description": "Zero-based offset into the matching collection.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "is_active", "in": "query", "required": false, "description": "Omit to include both active and inactive values.", "schema": { "type": "boolean" } }, { "name": "department", "in": "query", "required": false, "description": "Limit definitions to a department.", "schema": { "type": "string", "enum": [ "sales", "customer_success" ] } } ] } }, "/calls/activity-types/{id}": { "get": { "tags": [ "Call settings" ], "summary": "Get activity type", "operationId": "get__calls_activity_types_id_", "description": "**Required scope:** `activity-types:read`.\n\nReturns a single definition from your organization. No query filters are accepted.", "x-required-scope": "activity-types:read", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ActivityType" } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, or revoked API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Required scope missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in your organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation or configuration error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Staffly resource UUID.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/calls/call-outcomes": { "get": { "tags": [ "Call settings" ], "summary": "List call outcomes", "operationId": "get__calls_call_outcomes", "description": "**Required scope:** `call-outcomes:read`.\n\nSorted by display order, then ID; null display orders last. Inactive definitions are included by default. Use returned IDs as filters on GET /calls.", "x-required-scope": "call-outcomes:read", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CallOutcome" } }, "limit": { "type": "integer", "minimum": 0 }, "offset": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 } }, "required": [ "data", "limit", "offset", "total" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, or revoked API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Required scope missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in your organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation or configuration error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Page size; values above 100 are capped.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "offset", "in": "query", "required": false, "description": "Zero-based offset into the matching collection.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "is_active", "in": "query", "required": false, "description": "Omit to include both active and inactive values.", "schema": { "type": "boolean" } }, { "name": "department", "in": "query", "required": false, "description": "Limit definitions to a department.", "schema": { "type": "string", "enum": [ "sales", "customer_success" ] } } ] } }, "/calls/call-outcomes/{id}": { "get": { "tags": [ "Call settings" ], "summary": "Get call outcome", "operationId": "get__calls_call_outcomes_id_", "description": "**Required scope:** `call-outcomes:read`.\n\nReturns a single definition from your organization. No query filters are accepted.", "x-required-scope": "call-outcomes:read", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CallOutcome" } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, or revoked API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Required scope missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in your organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation or configuration error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Staffly resource UUID.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/pipelines": { "get": { "tags": [ "Pipelines" ], "summary": "List pipelines", "operationId": "get__pipelines", "description": "**Required scope:** `pipelines:read`.\n\nSorted by display order, then ID; null display orders last. Inactive definitions are included by default. Use returned IDs as filters on GET /calls.", "x-required-scope": "pipelines:read", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Pipeline" } }, "limit": { "type": "integer", "minimum": 0 }, "offset": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 } }, "required": [ "data", "limit", "offset", "total" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, or revoked API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Required scope missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in your organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation or configuration error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Page size; values above 100 are capped.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "offset", "in": "query", "required": false, "description": "Zero-based offset into the matching collection.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "is_active", "in": "query", "required": false, "description": "Omit to include both active and inactive values.", "schema": { "type": "boolean" } } ] } }, "/pipelines/{id}": { "get": { "tags": [ "Pipelines" ], "summary": "Get pipeline", "operationId": "get__pipelines_id_", "description": "**Required scope:** `pipelines:read`.\n\nReturns a single definition from your organization. No query filters are accepted.", "x-required-scope": "pipelines:read", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Pipeline" } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, or revoked API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Required scope missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in your organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation or configuration error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Staffly resource UUID.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/pipelines/{pipeline_id}/stages": { "get": { "tags": [ "Pipelines" ], "summary": "List pipeline stages", "operationId": "get__pipelines_pipeline_id_stages", "description": "**Required scope:** `pipelines:read`.\n\nLists stages in a pipeline belonging to your organization, sorted by display order then ID. All stages are included unless filtered. Use a returned stage ID as stage_id when creating or updating a deal in this pipeline. An unknown or foreign pipeline returns 404; an empty pipeline returns an empty page.", "x-required-scope": "pipelines:read", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PipelineStage" } }, "limit": { "type": "integer", "minimum": 0 }, "offset": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 } }, "required": [ "data", "limit", "offset", "total" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, or revoked API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Required scope missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in your organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation or configuration error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "pipeline_id", "in": "path", "required": true, "description": "Parent pipeline UUID from GET /pipelines.", "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "required": false, "description": "Page size; values above 100 are capped.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "offset", "in": "query", "required": false, "description": "Zero-based offset into the matching collection.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "is_closed", "in": "query", "required": false, "description": "Filter open or closed stages.", "schema": { "type": "boolean" } }, { "name": "is_won", "in": "query", "required": false, "description": "Filter won or non-won stages.", "schema": { "type": "boolean" } } ] } }, "/pipelines/{pipeline_id}/stages/{id}": { "get": { "tags": [ "Pipelines" ], "summary": "Get pipeline stage", "operationId": "get__pipelines_pipeline_id_stages_id_", "description": "**Required scope:** `pipelines:read`.\n\nGets a stage from the specified pipeline. An unknown pipeline, foreign pipeline, or stage from a different pipeline returns 404. No query filters are accepted.", "x-required-scope": "pipelines:read", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PipelineStage" } }, "required": [ "data" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, or revoked API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Required scope missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in your organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation or configuration error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "pipeline_id", "in": "path", "required": true, "description": "Parent pipeline UUID from GET /pipelines.", "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "description": "Staffly resource UUID.", "schema": { "type": "string", "format": "uuid" } } ] } }, "/calls": { "get": { "tags": [ "Calls" ], "summary": "Get call metrics", "operationId": "get__calls", "description": "**Required scope:** `calls:read`.\n\nReturns aggregate counts, not individual calls. No pagination is needed for underlying call rows: aggregation happens in PostgreSQL.\n\nRepeat a filter parameter to select multiple values (OR within a field; AND across fields). Filters apply before all counts. All pipelines in the organization are included by default.\n\nActivity and outcome groups reflect your organization’s dynamic settings. Each includes count and completed_count (log_status = completed). Groups are keyed by exact stored name and department, with current labels and IDs. Inactive definitions remain in historical results. Deleted/unknown definitions use the stored name with null ID and active status. Unclassified calls appear with a null name. Only observed categories appear; empty pipelines have zero volume and empty arrays.\n\nBoth breakdowns describe the same calls: do not add them together. Volume includes unanswered and manual calls, excludes transfer targets, and uses started_at. Pipeline attribution uses the deal’s current pipeline; moving a deal changes historical attribution. Calls without a linked deal or start time are excluded. Unknown or foreign filter IDs match no records.", "x-required-scope": "calls:read", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PipelineCallMetrics" } }, "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" }, "missing_pipelines": { "type": "array", "items": { "type": "string" } }, "filters": { "type": "object", "properties": { "pipeline_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "activity_type_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "call_outcome_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "definitions": { "type": "object", "properties": { "pipeline_attribution": { "type": "string", "const": "current_deal_pipeline" }, "time_field": { "type": "string", "const": "started_at" } } } }, "required": [ "data", "from", "to", "missing_pipelines", "filters", "definitions" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, or revoked API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Required scope missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in your organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation or configuration error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "from", "in": "query", "required": true, "description": "Inclusive start timestamp. Must include a timezone.", "schema": { "type": "string", "format": "date-time", "example": "2026-09-01T00:00:00Z" } }, { "name": "to", "in": "query", "required": true, "description": "Exclusive end timestamp. Must be later than from.", "schema": { "type": "string", "format": "date-time", "example": "2026-10-01T00:00:00Z" } }, { "name": "pipeline", "in": "query", "required": false, "description": "Exact pipeline names. Use pipeline names or pipeline_id, not both.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 200 }, "maxItems": 20 }, "style": "form", "explode": true }, { "name": "pipeline_id", "in": "query", "required": false, "description": "IDs from GET /pipelines. Omit to include all organization pipelines.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 20 }, "style": "form", "explode": true }, { "name": "activity_type_id", "in": "query", "required": false, "description": "IDs from GET /calls/activity-types.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 20 }, "style": "form", "explode": true }, { "name": "call_outcome_id", "in": "query", "required": false, "description": "IDs from GET /calls/call-outcomes.", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" }, "maxItems": 20 }, "style": "form", "explode": true } ] } }, "/notifications": { "post": { "tags": [ "Notifications" ], "summary": "Ingest email events", "operationId": "post__notifications", "description": "**Required scope:** `notifications:write`.\n\nConfigure a notification mapping in Settings → Integrations before sending events. The API prefers a key-specific mapping, then the organization default. Events match existing contacts/companies by email. Returns ingestion counts. A missing mapping returns 422.", "x-required-scope": "notifications:write", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "received": { "type": "integer", "minimum": 0 }, "matched": { "type": "integer", "minimum": 0 }, "created": { "type": "integer", "minimum": 0 }, "activities": { "type": "integer", "minimum": 0 } }, "required": [ "received", "matched", "created", "activities" ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, or revoked API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Required scope missing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found in your organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method not allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation or configuration error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "parameters": [ { "name": "type", "in": "query", "required": false, "description": "Only email ingestion is supported.", "schema": { "type": "string", "enum": [ "email" ], "default": "email" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "description": "Provider-specific JSON object or array. Configure the corresponding field mapping in Settings → Integrations. There is no universal payload shape.", "oneOf": [ { "type": "object", "additionalProperties": true }, { "type": "array", "items": {} } ] } } } } } } }, "components": { "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "description": "Organization API key, not a Supabase session token." }, "ApiKey": { "type": "apiKey", "in": "header", "name": "x-api-key" } }, "schemas": { "Error": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] }, "Contact": { "type": "object", "properties": { "address_line_1": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address_line_2": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "company_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "facebook": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "first_name": { "type": "string" }, "followers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "following": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "type": "string", "format": "uuid" }, "import_filename": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instagram": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_activity_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "last_name": { "type": "string" }, "linkedin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "origin_reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin_type": { "type": "string" }, "owner_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "position": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "primary_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "primary_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "secondary_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "secondary_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source_metadata": {}, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tiktok": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "twitter": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "zip_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "address_line_1", "address_line_2", "city", "company_id", "country", "created_at", "facebook", "first_name", "followers", "following", "full_name", "id", "import_filename", "instagram", "last_activity_at", "last_name", "linkedin", "organization_id", "origin_reference", "origin_type", "owner_id", "position", "primary_email", "primary_phone", "secondary_email", "secondary_phone", "source_metadata", "state", "tiktok", "timezone", "twitter", "updated_at", "website", "zip_code" ] }, "ContactCreate": { "type": "object", "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "primary_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "secondary_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "primary_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "secondary_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "position": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "company_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "owner_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "instagram": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "facebook": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tiktok": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "twitter": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "linkedin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "followers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "following": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address_line_1": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address_line_2": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "zip_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "first_name", "last_name" ] }, "ContactUpdate": { "type": "object", "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "primary_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "secondary_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "primary_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "secondary_phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "position": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "company_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "owner_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "instagram": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "facebook": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tiktok": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "twitter": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "linkedin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "followers": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "following": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address_line_1": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address_line_2": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "zip_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "minProperties": 1 }, "Company": { "type": "object", "properties": { "address_line_1": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address_line_2": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "annual_revenue": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "employee_count": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "facebook": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "founded_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "type": "string", "format": "uuid" }, "import_filename": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instagram": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_activity_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "linkedin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "organization_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "origin_reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin_type": { "type": "string" }, "owner_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source_metadata": {}, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tiktok": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "twitter": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "vertical": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "zip_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "address_line_1", "address_line_2", "annual_revenue", "city", "country", "created_at", "description", "email", "employee_count", "facebook", "founded_date", "id", "import_filename", "instagram", "last_activity_at", "linkedin", "name", "organization_id", "origin_reference", "origin_type", "owner_id", "phone", "source_metadata", "state", "tiktok", "timezone", "twitter", "updated_at", "vertical", "website", "zip_code" ] }, "CompanyCreate": { "type": "object", "properties": { "name": { "type": "string" }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "owner_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "vertical": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "annual_revenue": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "employee_count": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "founded_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instagram": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "facebook": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tiktok": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "twitter": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "linkedin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address_line_1": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address_line_2": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "zip_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "name" ] }, "CompanyUpdate": { "type": "object", "properties": { "name": { "type": "string" }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "owner_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "vertical": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "annual_revenue": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "employee_count": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "founded_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instagram": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "facebook": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tiktok": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "twitter": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "linkedin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address_line_1": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address_line_2": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "zip_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "minProperties": 1 }, "Deal": { "type": "object", "properties": { "account_manager_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "address_line_1": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address_line_2": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "annual_revenue": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "close_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "company_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "csm_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "deal_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "type": "string", "format": "uuid" }, "import_filename": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_activity_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "legal_business_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "organization_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "origin_reference": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin_type": { "type": "string" }, "owner_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "payment_frequency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pipeline_id": { "type": "string", "format": "uuid" }, "primary_phone_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "priority": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "product_segment": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "referral_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sdr_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "source_metadata": {}, "stage_id": { "type": "string", "format": "uuid" }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "zip_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "primary_contact_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "contact_ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "required": [ "account_manager_id", "address_line_1", "address_line_2", "amount", "annual_revenue", "city", "close_date", "company_id", "country", "created_at", "csm_id", "currency", "deal_source", "description", "id", "import_filename", "last_activity_at", "legal_business_name", "name", "organization_id", "origin_reference", "origin_type", "owner_id", "payment_frequency", "pipeline_id", "primary_phone_source", "priority", "product_segment", "referral_source", "sdr_id", "source_metadata", "stage_id", "state", "timezone", "updated_at", "zip_code", "primary_contact_id", "contact_ids" ] }, "DealCreate": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pipeline_id": { "type": "string", "format": "uuid" }, "stage_id": { "type": "string", "format": "uuid" }, "amount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "priority": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "product_segment": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "deal_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "referral_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "company_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "primary_phone_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "owner_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "sdr_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "account_manager_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "csm_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "close_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "payment_frequency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "legal_business_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "annual_revenue": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address_line_1": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address_line_2": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "zip_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "primary_contact_id": { "type": "string", "format": "uuid" }, "additional_contact_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true, "description": "Optional additional contacts. Must exclude the primary contact." } }, "required": [ "name", "pipeline_id", "stage_id", "primary_contact_id" ] }, "DealUpdate": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pipeline_id": { "type": "string", "format": "uuid" }, "stage_id": { "type": "string", "format": "uuid" }, "amount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "priority": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "product_segment": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "deal_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "referral_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "company_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "primary_phone_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "owner_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "sdr_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "account_manager_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "csm_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "close_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "payment_frequency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "legal_business_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "annual_revenue": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address_line_1": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address_line_2": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "state": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "zip_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "primary_contact_id": { "type": "string", "format": "uuid" }, "contact_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "minItems": 1, "uniqueItems": true, "description": "Replace the complete contact set. Must include primary_contact_id, which must also be supplied." } }, "minProperties": 1 }, "ActivityType": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "label": { "type": "string" }, "department": { "type": "string" }, "color": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "display_order": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] } }, "required": [ "id", "name", "label", "department", "color", "display_order", "is_active", "created_at", "updated_at" ] }, "CallOutcome": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "label": { "type": "string" }, "department": { "type": "string" }, "color": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "display_order": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "is_connection": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "is_meeting": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "is_positive": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "is_escalation": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "is_system": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "id", "name", "label", "department", "color", "display_order", "is_active", "created_at", "updated_at", "is_connection", "is_meeting", "is_positive", "is_escalation", "is_system" ] }, "Pipeline": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "display_order": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] } }, "required": [ "id", "name", "slug", "description", "display_order", "is_active", "created_at" ] }, "PipelineStage": { "type": "object", "properties": { "color": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "display_order": { "type": "number" }, "id": { "type": "string", "format": "uuid" }, "is_closed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "is_won": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "name": { "type": "string" }, "pipeline_id": { "type": "string", "format": "uuid" }, "slug": { "type": "string" } }, "required": [ "color", "created_at", "display_order", "id", "is_closed", "is_won", "name", "pipeline_id", "slug" ] }, "CallMetricGroup": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "department": { "type": "string", "enum": [ "sales", "customer_success" ] }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "count": { "type": "integer", "minimum": 0 }, "completed_count": { "type": "integer", "minimum": 0 } }, "required": [ "id", "name", "label", "department", "is_active", "count", "completed_count" ] }, "PipelineCallMetrics": { "type": "object", "properties": { "pipeline_id": { "type": "string", "format": "uuid" }, "pipeline_name": { "type": "string" }, "call_volume": { "type": "integer", "minimum": 0 }, "activity_types": { "type": "array", "items": { "$ref": "#/components/schemas/CallMetricGroup" } }, "call_outcomes": { "type": "array", "items": { "$ref": "#/components/schemas/CallMetricGroup" } } }, "required": [ "pipeline_id", "pipeline_name", "call_volume", "activity_types", "call_outcomes" ] } } } }