{ "openapi": "3.1.1", "info": { "title": "ActivationKing API", "description": "Access to your own ActivationKing data: read events, sessions, results, subscriptions and credits; read and write Ops Calendar companies, event jobs and deals (for example to push jobs won in your CRM).\n\n**Authentication:** send your key as `Authorization: Bearer ak_live_...`. Create and revoke keys at https://activationking.com/dashboard/api-keys. A key only sees the data of the account that created it.\n\n**Limits:** 300 requests per minute per key. Every response carries `X-RateLimit-Limit` and `X-RateLimit-Remaining`; over the limit you get `429` with `Retry-After` (seconds).\n\n**Paging:** list endpoints return `{ items, nextCursor, totalCount }`. Pass `nextCursor` back as `cursor` until it is `null`. Cursors are opaque; `limit` is at most 100.\n\n**Errors:** `{ \"error\": { \"code\": \"not_found\", \"message\": \"...\" } }`. A record that belongs to another account is reported as `404`.\n\n**Ops Calendar (`/v1/ops/*`):** send `X-Organization-Id` (ids are listed by `/v1/me`). The key acts with its owner's role in that organization (for example `Jobs.Create`, `Crm.Edit`, `Deal.Edit`) and the organization needs an active Ops Calendar subscription (`402` otherwise). To sync from another system without duplicates use `PUT /v1/ops/companies/external/{source}/{externalId}` and `PUT /v1/ops/jobs/external/{source}/{externalId}`: the first call creates, later calls update the same record. PATCH changes only the fields you send.\n\n**AI agents:** MCP server at `https://api.activationking.com/mcp` (same key); Markdown reference at `https://api.activationking.com/llms.txt` and `/llms-full.txt`.", "version": "v1" }, "servers": [ { "url": "https://api.activationking.com" } ], "paths": { "/v1/me": { "get": { "tags": [ "ActivationKing.Api.Public" ], "summary": "Your account and totals", "operationId": "GetMe", "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeV1" } } } } } } }, "/v1/subscriptions": { "get": { "tags": [ "ActivationKing.Api.Public" ], "summary": "Your subscriptions, newest first", "operationId": "ListSubscriptions", "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageV1OfSubscriptionV1" } } } } } } }, "/v1/credits": { "get": { "tags": [ "ActivationKing.Api.Public" ], "summary": "Your AI credit balance", "operationId": "GetCredits", "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditsV1" } } } } } } }, "/v1/events": { "get": { "tags": [ "ActivationKing.Api.Public" ], "summary": "Your events, newest first", "description": "Archive (V1) events come after current ones. Optional appIdentifier filter, e.g. com.activationking.photobooth.", "operationId": "ListEvents", "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "appIdentifier", "in": "query", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageV1OfEventV1" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } } } } }, "/v1/events/{eventId}": { "get": { "tags": [ "ActivationKing.Api.Public" ], "summary": "One event", "operationId": "GetEvent", "parameters": [ { "name": "eventId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventV1" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } } } } }, "/v1/events/{eventId}/sessions": { "get": { "tags": [ "ActivationKing.Api.Public" ], "summary": "Sessions (guest visits) of an event, in arrival order", "description": "Stable while the event is live: new sessions do not shift pages. Media lists the result photos/videos.", "operationId": "ListEventSessions", "parameters": [ { "name": "eventId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageV1OfSessionV1" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } } } } }, "/v1/events/{eventId}/stats": { "get": { "tags": [ "ActivationKing.Api.Public" ], "summary": "Totals for one event", "operationId": "GetEventStats", "parameters": [ { "name": "eventId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventStatsV1" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } } } } }, "/v1/events/{eventId}/leads": { "get": { "tags": [ "ActivationKing.Api.Public" ], "summary": "Lead form and survey answers of an event", "description": "Same table as the dashboard Excel export: one row per participant, first column SessionId.", "operationId": "ListEventLeads", "parameters": [ { "name": "eventId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeadTableV1" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } } } } }, "/v1/sessions/{sessionId}": { "get": { "tags": [ "ActivationKing.Api.Public" ], "summary": "One session", "operationId": "GetSession", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionV1" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } } } } }, "/v1/ops/companies": { "get": { "tags": [ "Ops" ], "summary": "Companies (clients, brands, agencies, suppliers) of the organization", "description": "Requires the `X-Organization-Id` header.", "operationId": "ListOpsCompanies", "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "search", "in": "query", "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "402": { "description": "Payment Required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageV1OfOpsCompanyV1" } } } } } }, "post": { "tags": [ "Ops" ], "summary": "Create a company (Crm.Edit; billing fields need Crm.EditBilling)", "description": "Requires the `X-Organization-Id` header.", "operationId": "CreateOpsCompany", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpsCompanyWriteV1" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "402": { "description": "Payment Required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpsCompanyV1" } } } } } } }, "/v1/ops/companies/{id}": { "get": { "tags": [ "Ops" ], "summary": "One company", "description": "Requires the `X-Organization-Id` header.", "operationId": "GetOpsCompany", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "402": { "description": "Payment Required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpsCompanyV1" } } } } } }, "patch": { "tags": [ "Ops" ], "summary": "Change the given fields of a company; omitted fields stay as they are", "description": "Requires the `X-Organization-Id` header.", "operationId": "UpdateOpsCompany", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpsCompanyWriteV1" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "402": { "description": "Payment Required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpsCompanyV1" } } } } } }, "delete": { "tags": [ "Ops" ], "summary": "Delete a company (refused with 409 in_use while a job uses it)", "description": "Requires the `X-Organization-Id` header.", "operationId": "DeleteOpsCompany", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "402": { "description": "Payment Required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "204": { "description": "No Content" } } } }, "/v1/ops/companies/external/{source}/{externalId}": { "put": { "tags": [ "Ops" ], "summary": "Create or update a company by your system's id", "description": "The first call creates the company and binds it to (source, externalId); later calls update the same company. Use this from a CRM to avoid duplicates.\n\nRequires the `X-Organization-Id` header.", "operationId": "UpsertOpsCompanyByExternalId", "parameters": [ { "name": "source", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "externalId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpsCompanyWriteV1" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "402": { "description": "Payment Required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpsCompanyV1" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpsCompanyV1" } } } } } } }, "/v1/ops/jobs": { "get": { "tags": [ "Ops" ], "summary": "Event jobs of the organization, by planned start", "description": "Optional from/to (UTC) keep jobs whose planned phases overlap the range.\n\nRequires the `X-Organization-Id` header.", "operationId": "ListOpsJobs", "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "402": { "description": "Payment Required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageV1OfOpsJobV1" } } } } } }, "post": { "tags": [ "Ops" ], "summary": "Create an event job (Jobs.Create). A deal is opened for it automatically.", "description": "Requires the `X-Organization-Id` header.", "operationId": "CreateOpsJob", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpsJobWriteV1" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "402": { "description": "Payment Required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpsJobV1" } } } } } } }, "/v1/ops/jobs/{id}": { "get": { "tags": [ "Ops" ], "summary": "One event job", "description": "Requires the `X-Organization-Id` header.", "operationId": "GetOpsJob", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "402": { "description": "Payment Required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpsJobV1" } } } } } }, "patch": { "tags": [ "Ops" ], "summary": "Change the given fields of a job; omitted fields stay as they are", "description": "Requires the `X-Organization-Id` header.", "operationId": "UpdateOpsJob", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpsJobWriteV1" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "402": { "description": "Payment Required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpsJobV1" } } } } } }, "delete": { "tags": [ "Ops" ], "summary": "Delete a job (Jobs.Edit); its deal, equipment and comments go with it", "description": "Requires the `X-Organization-Id` header.", "operationId": "DeleteOpsJob", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "402": { "description": "Payment Required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "204": { "description": "No Content" } } } }, "/v1/ops/jobs/external/{source}/{externalId}": { "put": { "tags": [ "Ops" ], "summary": "Create or update a job by your system's id", "description": "The first call creates the job and binds it to (source, externalId); later calls update the same job.\n\nRequires the `X-Organization-Id` header.", "operationId": "UpsertOpsJobByExternalId", "parameters": [ { "name": "source", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "externalId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpsJobWriteV1" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "402": { "description": "Payment Required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpsJobV1" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpsJobV1" } } } } } } }, "/v1/ops/jobs/{id}/deal": { "get": { "tags": [ "Ops" ], "summary": "The deal (price, status) of a job (Deal.View)", "description": "Requires the `X-Organization-Id` header.", "operationId": "GetOpsJobDeal", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "402": { "description": "Payment Required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpsDealV1" } } } } } }, "patch": { "tags": [ "Ops" ], "summary": "Change the deal of a job (Deal.Edit)", "description": "Requires the `X-Organization-Id` header.", "operationId": "UpdateOpsJobDeal", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpsDealWriteV1" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "402": { "description": "Payment Required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpsDealV1" } } } } } } }, "/v1/ops/phases": { "get": { "tags": [ "Ops" ], "summary": "Phases a job can plan (setup, event, teardown...)", "description": "Requires the `X-Organization-Id` header.", "operationId": "ListOpsPhases", "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "402": { "description": "Payment Required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpsPhaseV1" } } } } } } } }, "/v1/ops/event-types": { "get": { "tags": [ "Ops" ], "summary": "Known event and venue types", "description": "Requires the `X-Organization-Id` header.", "operationId": "ListOpsEventTypes", "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "402": { "description": "Payment Required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpsTypesV1" } } } } } } }, "/v1/ops/members": { "get": { "tags": [ "Ops" ], "summary": "Accepted members (user ids for responsibleUserIds)", "description": "Requires the `X-Organization-Id` header.", "operationId": "ListOpsMembers", "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "402": { "description": "Payment Required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpsMemberV1" } } } } } } } }, "/v1/ops/products": { "get": { "tags": [ "Ops" ], "summary": "Products a job line can use", "description": "Requires the `X-Organization-Id` header.", "operationId": "ListOpsProducts", "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "402": { "description": "Payment Required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpsProductV1" } } } } } } } }, "/v1/ops/deal-statuses": { "get": { "tags": [ "Ops" ], "summary": "Deal columns (statusId values)", "description": "Requires the `X-Organization-Id` header.", "operationId": "ListOpsDealStatuses", "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "402": { "description": "Payment Required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorV1" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpsDealStatusV1" } } } } } } } } }, "components": { "schemas": { "AccountStatsV1": { "required": [ "totalEvents", "eventsThisMonth", "totalSessions", "lastActivityAt" ], "type": "object", "properties": { "totalEvents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "eventsThisMonth": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "totalSessions": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "lastActivityAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "ApiErrorBodyV1": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "ApiErrorV1": { "required": [ "error" ], "type": "object", "properties": { "error": { "$ref": "#/components/schemas/ApiErrorBodyV1" } } }, "CreditSpendV1": { "required": [ "consumed", "refunded", "net" ], "type": "object", "properties": { "consumed": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "refunded": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "net": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "CreditsV1": { "required": [ "balance" ], "type": "object", "properties": { "balance": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "EventStatsV1": { "required": [ "eventId", "sessions", "successfulSessions", "prints", "testPrints", "credits", "lastActivityAt", "isArchive" ], "type": "object", "properties": { "eventId": { "type": "string" }, "sessions": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "successfulSessions": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "prints": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "testPrints": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "credits": { "$ref": "#/components/schemas/CreditSpendV1" }, "lastActivityAt": { "type": "string", "format": "date-time" }, "isArchive": { "type": "boolean" } } }, "EventV1": { "required": [ "id", "name", "motto", "appIdentifier", "createdAt", "lastActivityAt", "sessionCount", "shareUrl", "coverImageUrl", "isArchive" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "motto": { "type": [ "null", "string" ] }, "appIdentifier": { "type": [ "null", "string" ] }, "createdAt": { "type": "string", "format": "date-time" }, "lastActivityAt": { "type": "string", "format": "date-time" }, "sessionCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "shareUrl": { "type": [ "null", "string" ] }, "coverImageUrl": { "type": [ "null", "string" ] }, "isArchive": { "type": "boolean" } } }, "ExternalRefV1": { "required": [ "source", "id" ], "type": "object", "properties": { "source": { "type": "string" }, "id": { "type": "string" } } }, "LeadTableV1": { "required": [ "columns", "rows", "nextCursor", "totalCount" ], "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "string" } }, "rows": { "type": "array", "items": { "type": "array" } }, "nextCursor": { "type": [ "null", "string" ] }, "totalCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "MediaV1": { "required": [ "url", "type", "aspectRatio" ], "type": "object", "properties": { "url": { "type": "string" }, "type": { "type": "string" }, "aspectRatio": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "MeV1": { "required": [ "id", "email", "stats", "organizations" ], "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": [ "null", "string" ] }, "stats": { "$ref": "#/components/schemas/AccountStatsV1" }, "organizations": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationV1" } } } }, "OpsCompanyBillingV1": { "required": [ "legalName", "taxNumber", "taxOffice", "address", "district", "city", "postalCode", "country", "email", "paymentTermDays", "isIndividual" ], "type": "object", "properties": { "legalName": { "type": [ "null", "string" ] }, "taxNumber": { "type": [ "null", "string" ] }, "taxOffice": { "type": [ "null", "string" ] }, "address": { "type": [ "null", "string" ] }, "district": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "postalCode": { "type": [ "null", "string" ] }, "country": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "paymentTermDays": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "isIndividual": { "type": "boolean" } } }, "OpsCompanyBillingWriteV1": { "type": "object", "properties": { "legalName": { "type": [ "null", "string" ] }, "taxNumber": { "type": [ "null", "string" ] }, "taxOffice": { "type": [ "null", "string" ] }, "address": { "type": [ "null", "string" ] }, "district": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "postalCode": { "type": [ "null", "string" ] }, "country": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "paymentTermDays": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "isIndividual": { "type": [ "null", "boolean" ] } } }, "OpsCompanyV1": { "required": [ "id", "external", "name", "type", "website", "phone", "notes", "billing", "contacts", "isArchived", "version", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string" }, "external": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ExternalRefV1" } ] }, "name": { "type": [ "null", "string" ] }, "type": { "type": "string" }, "website": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "notes": { "type": [ "null", "string" ] }, "billing": { "$ref": "#/components/schemas/OpsCompanyBillingV1" }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/OpsContactV1" } }, "isArchived": { "type": "boolean" }, "version": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "OpsCompanyWriteV1": { "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "type": { "type": [ "null", "string" ] }, "website": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "notes": { "type": [ "null", "string" ] }, "billing": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OpsCompanyBillingWriteV1" } ] }, "contacts": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/OpsContactV1" } }, "isArchived": { "type": [ "null", "boolean" ] } } }, "OpsContactV1": { "required": [ "id", "name", "title", "phone", "email", "isPrimary", "note" ], "type": "object", "properties": { "id": { "type": [ "null", "string" ] }, "name": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "isPrimary": { "type": "boolean" }, "note": { "type": [ "null", "string" ] } } }, "OpsDealLineV1": { "required": [ "lineId", "description", "amountExclVat", "vatRatePercent" ], "type": "object", "properties": { "lineId": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "amountExclVat": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "vatRatePercent": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "OpsDealStatusV1": { "required": [ "id", "name", "sortOrder" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": [ "null", "string" ] }, "sortOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "OpsDealV1": { "required": [ "id", "jobId", "statusId", "currency", "vatExempt", "quotedAt", "paymentDue", "notes", "lines", "totalExclVat", "version", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string" }, "jobId": { "type": "string" }, "statusId": { "type": [ "null", "string" ] }, "currency": { "type": [ "null", "string" ] }, "vatExempt": { "type": "boolean" }, "quotedAt": { "type": [ "null", "string" ], "format": "date-time" }, "paymentDue": { "type": [ "null", "string" ], "format": "date-time" }, "notes": { "type": [ "null", "string" ] }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/OpsDealLineV1" } }, "totalExclVat": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "version": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "OpsDealWriteV1": { "type": "object", "properties": { "statusId": { "type": [ "null", "string" ] }, "currency": { "type": [ "null", "string" ] }, "vatExempt": { "type": [ "null", "boolean" ] }, "quotedAt": { "type": [ "null", "string" ], "format": "date-time" }, "paymentDue": { "type": [ "null", "string" ], "format": "date-time" }, "notes": { "type": [ "null", "string" ] }, "lines": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/OpsDealLineV1" } } } }, "OpsJobContactV1": { "required": [ "id", "companyId", "contactId", "name", "phone", "note" ], "type": "object", "properties": { "id": { "type": [ "null", "string" ] }, "companyId": { "type": [ "null", "string" ] }, "contactId": { "type": [ "null", "string" ] }, "name": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "note": { "type": [ "null", "string" ] } } }, "OpsJobPhaseV1": { "required": [ "phase", "plannedStart", "plannedEnd", "actualStart", "actualEnd" ], "type": "object", "properties": { "phase": { "type": "string" }, "plannedStart": { "type": "string", "format": "date-time" }, "plannedEnd": { "type": [ "null", "string" ], "format": "date-time" }, "actualStart": { "type": [ "null", "string" ], "format": "date-time" }, "actualEnd": { "type": [ "null", "string" ], "format": "date-time" } } }, "OpsJobPhaseWriteV1": { "required": [ "phase", "plannedStart", "plannedEnd" ], "type": "object", "properties": { "phase": { "type": "string" }, "plannedStart": { "type": "string", "format": "date-time" }, "plannedEnd": { "type": [ "null", "string" ], "format": "date-time" } } }, "OpsJobProductV1": { "required": [ "lineId", "productId", "quantity" ], "type": "object", "properties": { "lineId": { "type": [ "null", "string" ] }, "productId": { "type": "string" }, "quantity": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "OpsJobProductWriteV1": { "required": [ "productId", "quantity" ], "type": "object", "properties": { "productId": { "type": "string" }, "quantity": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "OpsJobV1": { "required": [ "id", "external", "name", "clientCompanyId", "brandCompanyId", "venue", "eventType", "notes", "status", "phases", "products", "onSiteContacts", "responsibleUserIds", "releasedToOperations", "equipmentReserved", "version", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string" }, "external": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ExternalRefV1" } ] }, "name": { "type": [ "null", "string" ] }, "clientCompanyId": { "type": [ "null", "string" ] }, "brandCompanyId": { "type": [ "null", "string" ] }, "venue": { "$ref": "#/components/schemas/OpsJobVenueV1" }, "eventType": { "type": [ "null", "string" ] }, "notes": { "type": [ "null", "string" ] }, "status": { "type": "string" }, "phases": { "type": "array", "items": { "$ref": "#/components/schemas/OpsJobPhaseV1" } }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/OpsJobProductV1" } }, "onSiteContacts": { "type": "array", "items": { "$ref": "#/components/schemas/OpsJobContactV1" } }, "responsibleUserIds": { "type": "array", "items": { "type": "string" } }, "releasedToOperations": { "type": "boolean" }, "equipmentReserved": { "type": "boolean" }, "version": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "OpsJobVenueV1": { "required": [ "name", "type", "address", "latitude", "longitude", "timeZone" ], "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "type": { "type": [ "null", "string" ] }, "address": { "type": [ "null", "string" ] }, "latitude": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "longitude": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "timeZone": { "type": [ "null", "string" ] } } }, "OpsJobVenueWriteV1": { "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "type": { "type": [ "null", "string" ] }, "address": { "type": [ "null", "string" ] }, "latitude": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "longitude": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "timeZone": { "type": [ "null", "string" ] } } }, "OpsJobWriteV1": { "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "clientCompanyId": { "type": [ "null", "string" ] }, "brandCompanyId": { "type": [ "null", "string" ] }, "venue": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OpsJobVenueWriteV1" } ] }, "eventType": { "type": [ "null", "string" ] }, "notes": { "type": [ "null", "string" ] }, "phases": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/OpsJobPhaseWriteV1" } }, "products": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/OpsJobProductWriteV1" } }, "onSiteContacts": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/OpsJobContactV1" } }, "responsibleUserIds": { "type": [ "null", "array" ], "items": { "type": "string" } }, "status": { "type": [ "null", "string" ] }, "statusNote": { "type": [ "null", "string" ] }, "startApproved": { "type": [ "null", "boolean" ] } } }, "OpsMemberV1": { "required": [ "userId", "email", "displayName", "role" ], "type": "object", "properties": { "userId": { "type": "string" }, "email": { "type": [ "null", "string" ] }, "displayName": { "type": [ "null", "string" ] }, "role": { "type": "string" } } }, "OpsPhaseV1": { "required": [ "slug", "name", "sortOrder" ], "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": [ "null", "string" ] }, "sortOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "OpsProductV1": { "required": [ "id", "name", "description", "isArchived" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "isArchived": { "type": "boolean" } } }, "OpsTypesV1": { "required": [ "eventTypes", "venueTypes" ], "type": "object", "properties": { "eventTypes": { "type": "array", "items": { "type": "string" } }, "venueTypes": { "type": "array", "items": { "type": "string" } } } }, "OrganizationV1": { "required": [ "id", "name", "isOwner", "suspended" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": [ "null", "string" ] }, "isOwner": { "type": "boolean" }, "suspended": { "type": "boolean" } } }, "PageV1OfEventV1": { "required": [ "items", "nextCursor", "totalCount" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EventV1" } }, "nextCursor": { "type": [ "null", "string" ] }, "totalCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "PageV1OfOpsCompanyV1": { "required": [ "items", "nextCursor", "totalCount" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/OpsCompanyV1" } }, "nextCursor": { "type": [ "null", "string" ] }, "totalCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "PageV1OfOpsJobV1": { "required": [ "items", "nextCursor", "totalCount" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/OpsJobV1" } }, "nextCursor": { "type": [ "null", "string" ] }, "totalCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "PageV1OfSessionV1": { "required": [ "items", "nextCursor", "totalCount" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SessionV1" } }, "nextCursor": { "type": [ "null", "string" ] }, "totalCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "PageV1OfSubscriptionV1": { "required": [ "items", "nextCursor", "totalCount" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SubscriptionV1" } }, "nextCursor": { "type": [ "null", "string" ] }, "totalCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "SessionV1": { "required": [ "id", "eventId", "capturedAt", "lastActivityAt", "status", "result", "leadCaptured", "coverImageUrl", "shareUrl", "media" ], "type": "object", "properties": { "id": { "type": "string" }, "eventId": { "type": "string" }, "capturedAt": { "type": "string", "format": "date-time" }, "lastActivityAt": { "type": "string", "format": "date-time" }, "status": { "type": "string" }, "result": { "type": [ "null", "string" ] }, "leadCaptured": { "type": "boolean" }, "coverImageUrl": { "type": [ "null", "string" ] }, "shareUrl": { "type": [ "null", "string" ] }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/MediaV1" } } } }, "SubscriptionV1": { "required": [ "id", "product", "plan", "status", "isTrial", "isPerpetual", "accessExpiresAt", "nextPaymentAt", "seats", "store", "isSandbox", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "product": { "type": [ "null", "string" ] }, "plan": { "type": [ "null", "string" ] }, "status": { "type": "string" }, "isTrial": { "type": "boolean" }, "isPerpetual": { "type": "boolean" }, "accessExpiresAt": { "type": [ "null", "string" ], "format": "date-time" }, "nextPaymentAt": { "type": [ "null", "string" ], "format": "date-time" }, "seats": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "store": { "type": [ "null", "string" ] }, "isSandbox": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" } } } }, "securitySchemes": { "ApiKey": { "type": "http", "description": "Personal API key from https://activationking.com/dashboard/api-keys", "scheme": "bearer", "bearerFormat": "ak_live_..." } } }, "security": [ { "ApiKey": [ ] } ], "tags": [ { "name": "ActivationKing.Api.Public" }, { "name": "Ops" } ] }