{ "openapi": "3.1.0", "info": { "title": "Kalinklo API", "version": "1.0.0", "description": "Machine-readable contract generated from the implemented versioned organization and keyless public API route tables.", "license": { "name": "Proprietary", "identifier": "LicenseRef-Proprietary" } }, "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema", "servers": [ { "url": "https://kalinklo.com" } ], "tags": [ { "name": "Organization API", "description": "Bearer-authenticated, organization-scoped API." }, { "name": "Public artists API", "description": "Keyless public artist discovery API." }, { "name": "Public API", "description": "Other keyless public read endpoints." } ], "paths": { "/api/org/v1/{slug}/contacts/{id}": { "get": { "tags": [ "Organization API" ], "summary": "Get Contacts Id", "operationId": "get_api_org_v1_slug_contacts_id", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "security": [ { "orgApiKey": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bearer API key is missing, invalid, or revoked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missing": { "value": { "success": false, "error": { "message": "Missing API key.", "code": "API_KEY_MISSING" } } }, "invalid": { "value": { "success": false, "error": { "message": "Invalid or revoked API key.", "code": "API_KEY_INVALID" } } } } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missingScope": { "value": { "success": false, "error": { "message": "This API key is missing the required scope.", "code": "API_SCOPE_MISSING" } } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "description": "Requires the `org:read:contacts` organization API scope.", "x-required-scopes": [ "org:read:contacts" ] }, "delete": { "tags": [ "Organization API" ], "summary": "Delete Contacts Id", "operationId": "delete_api_org_v1_slug_contacts_id", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "security": [ { "orgApiKey": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bearer API key is missing, invalid, or revoked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missing": { "value": { "success": false, "error": { "message": "Missing API key.", "code": "API_KEY_MISSING" } } }, "invalid": { "value": { "success": false, "error": { "message": "Invalid or revoked API key.", "code": "API_KEY_INVALID" } } } } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missingScope": { "value": { "success": false, "error": { "message": "This API key is missing the required scope.", "code": "API_SCOPE_MISSING" } } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "description": "Requires the `org:write:contacts` organization API scope.", "x-required-scopes": [ "org:write:contacts" ] }, "patch": { "tags": [ "Organization API" ], "summary": "Update Contacts Id", "operationId": "patch_api_org_v1_slug_contacts_id", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "security": [ { "orgApiKey": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bearer API key is missing, invalid, or revoked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missing": { "value": { "success": false, "error": { "message": "Missing API key.", "code": "API_KEY_MISSING" } } }, "invalid": { "value": { "success": false, "error": { "message": "Invalid or revoked API key.", "code": "API_KEY_INVALID" } } } } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missingScope": { "value": { "success": false, "error": { "message": "This API key is missing the required scope.", "code": "API_SCOPE_MISSING" } } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "description": "Requires the `org:write:contacts` organization API scope.", "x-required-scopes": [ "org:write:contacts" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/api/org/v1/{slug}/contacts": { "get": { "tags": [ "Organization API" ], "summary": "Get Slug Contacts", "operationId": "get_api_org_v1_slug_contacts", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "security": [ { "orgApiKey": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bearer API key is missing, invalid, or revoked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missing": { "value": { "success": false, "error": { "message": "Missing API key.", "code": "API_KEY_MISSING" } } }, "invalid": { "value": { "success": false, "error": { "message": "Invalid or revoked API key.", "code": "API_KEY_INVALID" } } } } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missingScope": { "value": { "success": false, "error": { "message": "This API key is missing the required scope.", "code": "API_SCOPE_MISSING" } } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "description": "Requires the `org:read:contacts` organization API scope.", "x-required-scopes": [ "org:read:contacts" ] }, "post": { "tags": [ "Organization API" ], "summary": "Create Slug Contacts", "operationId": "post_api_org_v1_slug_contacts", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "security": [ { "orgApiKey": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bearer API key is missing, invalid, or revoked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missing": { "value": { "success": false, "error": { "message": "Missing API key.", "code": "API_KEY_MISSING" } } }, "invalid": { "value": { "success": false, "error": { "message": "Invalid or revoked API key.", "code": "API_KEY_INVALID" } } } } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missingScope": { "value": { "success": false, "error": { "message": "This API key is missing the required scope.", "code": "API_SCOPE_MISSING" } } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "description": "Requires the `org:write:contacts` organization API scope.", "x-required-scopes": [ "org:write:contacts" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/api/org/v1/{slug}/instruments": { "get": { "tags": [ "Organization API" ], "summary": "Get Slug Instruments", "operationId": "get_api_org_v1_slug_instruments", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "security": [ { "orgApiKey": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bearer API key is missing, invalid, or revoked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missing": { "value": { "success": false, "error": { "message": "Missing API key.", "code": "API_KEY_MISSING" } } }, "invalid": { "value": { "success": false, "error": { "message": "Invalid or revoked API key.", "code": "API_KEY_INVALID" } } } } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missingScope": { "value": { "success": false, "error": { "message": "This API key is missing the required scope.", "code": "API_SCOPE_MISSING" } } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "description": "Requires the `org:read:resources` organization API scope.", "x-required-scopes": [ "org:read:resources" ] } }, "/api/org/v1/{slug}/member-requests": { "post": { "tags": [ "Organization API" ], "summary": "Create Slug Member Requests", "operationId": "post_api_org_v1_slug_member_requests", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "security": [ { "orgApiKey": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bearer API key is missing, invalid, or revoked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missing": { "value": { "success": false, "error": { "message": "Missing API key.", "code": "API_KEY_MISSING" } } }, "invalid": { "value": { "success": false, "error": { "message": "Invalid or revoked API key.", "code": "API_KEY_INVALID" } } } } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missingScope": { "value": { "success": false, "error": { "message": "This API key is missing the required scope.", "code": "API_SCOPE_MISSING" } } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "description": "Requires the `org:write:requests` organization API scope.", "x-required-scopes": [ "org:write:requests" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/api/org/v1/{slug}/members": { "get": { "tags": [ "Organization API" ], "summary": "Get Slug Members", "operationId": "get_api_org_v1_slug_members", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "security": [ { "orgApiKey": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bearer API key is missing, invalid, or revoked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missing": { "value": { "success": false, "error": { "message": "Missing API key.", "code": "API_KEY_MISSING" } } }, "invalid": { "value": { "success": false, "error": { "message": "Invalid or revoked API key.", "code": "API_KEY_INVALID" } } } } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missingScope": { "value": { "success": false, "error": { "message": "This API key is missing the required scope.", "code": "API_SCOPE_MISSING" } } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "description": "Requires the `org:read:personnel` organization API scope.", "x-required-scopes": [ "org:read:personnel" ] } }, "/api/org/v1/{slug}/performance-history": { "get": { "tags": [ "Organization API" ], "summary": "Get Slug Performance History", "operationId": "get_api_org_v1_slug_performance_history", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "security": [ { "orgApiKey": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bearer API key is missing, invalid, or revoked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missing": { "value": { "success": false, "error": { "message": "Missing API key.", "code": "API_KEY_MISSING" } } }, "invalid": { "value": { "success": false, "error": { "message": "Invalid or revoked API key.", "code": "API_KEY_INVALID" } } } } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missingScope": { "value": { "success": false, "error": { "message": "This API key is missing the required scope.", "code": "API_SCOPE_MISSING" } } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "description": "Requires the `org:read:operations` organization API scope.", "x-required-scopes": [ "org:read:operations" ] } }, "/api/org/v1/{slug}/productions/{id}/checklist/{itemId}": { "patch": { "tags": [ "Organization API" ], "summary": "Update Checklist ItemId", "operationId": "patch_api_org_v1_slug_productions_id_checklist_itemId", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "security": [ { "orgApiKey": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bearer API key is missing, invalid, or revoked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missing": { "value": { "success": false, "error": { "message": "Missing API key.", "code": "API_KEY_MISSING" } } }, "invalid": { "value": { "success": false, "error": { "message": "Invalid or revoked API key.", "code": "API_KEY_INVALID" } } } } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missingScope": { "value": { "success": false, "error": { "message": "This API key is missing the required scope.", "code": "API_SCOPE_MISSING" } } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "description": "Requires the `org:write:checklist` organization API scope.", "x-required-scopes": [ "org:write:checklist" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/api/org/v1/{slug}/productions/{id}/checklist": { "post": { "tags": [ "Organization API" ], "summary": "Create Id Checklist", "operationId": "post_api_org_v1_slug_productions_id_checklist", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "security": [ { "orgApiKey": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bearer API key is missing, invalid, or revoked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missing": { "value": { "success": false, "error": { "message": "Missing API key.", "code": "API_KEY_MISSING" } } }, "invalid": { "value": { "success": false, "error": { "message": "Invalid or revoked API key.", "code": "API_KEY_INVALID" } } } } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missingScope": { "value": { "success": false, "error": { "message": "This API key is missing the required scope.", "code": "API_SCOPE_MISSING" } } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "description": "Requires the `org:write:checklist` organization API scope.", "x-required-scopes": [ "org:write:checklist" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/api/org/v1/{slug}/productions/{id}": { "get": { "tags": [ "Organization API" ], "summary": "Get Productions Id", "operationId": "get_api_org_v1_slug_productions_id", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "security": [ { "orgApiKey": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bearer API key is missing, invalid, or revoked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missing": { "value": { "success": false, "error": { "message": "Missing API key.", "code": "API_KEY_MISSING" } } }, "invalid": { "value": { "success": false, "error": { "message": "Invalid or revoked API key.", "code": "API_KEY_INVALID" } } } } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missingScope": { "value": { "success": false, "error": { "message": "This API key is missing the required scope.", "code": "API_SCOPE_MISSING" } } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "description": "Requires the `org:read:operations` organization API scope.", "x-required-scopes": [ "org:read:operations" ] } }, "/api/org/v1/{slug}/productions": { "get": { "tags": [ "Organization API" ], "summary": "Get Slug Productions", "operationId": "get_api_org_v1_slug_productions", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "security": [ { "orgApiKey": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bearer API key is missing, invalid, or revoked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missing": { "value": { "success": false, "error": { "message": "Missing API key.", "code": "API_KEY_MISSING" } } }, "invalid": { "value": { "success": false, "error": { "message": "Invalid or revoked API key.", "code": "API_KEY_INVALID" } } } } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missingScope": { "value": { "success": false, "error": { "message": "This API key is missing the required scope.", "code": "API_SCOPE_MISSING" } } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "description": "Requires the `org:read:operations` organization API scope.", "x-required-scopes": [ "org:read:operations" ] } }, "/api/org/v1/{slug}/reports": { "get": { "tags": [ "Organization API" ], "summary": "Get Slug Reports", "operationId": "get_api_org_v1_slug_reports", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "security": [ { "orgApiKey": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bearer API key is missing, invalid, or revoked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missing": { "value": { "success": false, "error": { "message": "Missing API key.", "code": "API_KEY_MISSING" } } }, "invalid": { "value": { "success": false, "error": { "message": "Invalid or revoked API key.", "code": "API_KEY_INVALID" } } } } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missingScope": { "value": { "success": false, "error": { "message": "This API key is missing the required scope.", "code": "API_SCOPE_MISSING" } } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "description": "Requires the `org:read:operations` organization API scope.", "x-required-scopes": [ "org:read:operations" ] } }, "/api/org/v1/{slug}/resource-bookings/{id}/cancel": { "patch": { "tags": [ "Organization API" ], "summary": "Update Id Cancel", "operationId": "patch_api_org_v1_slug_resource_bookings_id_cancel", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "security": [ { "orgApiKey": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bearer API key is missing, invalid, or revoked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missing": { "value": { "success": false, "error": { "message": "Missing API key.", "code": "API_KEY_MISSING" } } }, "invalid": { "value": { "success": false, "error": { "message": "Invalid or revoked API key.", "code": "API_KEY_INVALID" } } } } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missingScope": { "value": { "success": false, "error": { "message": "This API key is missing the required scope.", "code": "API_SCOPE_MISSING" } } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "description": "Requires the `org:write:bookings` organization API scope.", "x-required-scopes": [ "org:write:bookings" ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/api/org/v1/{slug}/resource-bookings": { "post": { "tags": [ "Organization API" ], "summary": "Create Slug Resource Bookings", "operationId": "post_api_org_v1_slug_resource_bookings", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "security": [ { "orgApiKey": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bearer API key is missing, invalid, or revoked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missing": { "value": { "success": false, "error": { "message": "Missing API key.", "code": "API_KEY_MISSING" } } }, "invalid": { "value": { "success": false, "error": { "message": "Invalid or revoked API key.", "code": "API_KEY_INVALID" } } } } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missingScope": { "value": { "success": false, "error": { "message": "This API key is missing the required scope.", "code": "API_SCOPE_MISSING" } } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "description": "Requires the `org:write:bookings` organization API scope.", "x-required-scopes": [ "org:write:bookings" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/api/org/v1/{slug}/resources": { "get": { "tags": [ "Organization API" ], "summary": "Get Slug Resources", "operationId": "get_api_org_v1_slug_resources", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "security": [ { "orgApiKey": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bearer API key is missing, invalid, or revoked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missing": { "value": { "success": false, "error": { "message": "Missing API key.", "code": "API_KEY_MISSING" } } }, "invalid": { "value": { "success": false, "error": { "message": "Invalid or revoked API key.", "code": "API_KEY_INVALID" } } } } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missingScope": { "value": { "success": false, "error": { "message": "This API key is missing the required scope.", "code": "API_SCOPE_MISSING" } } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "description": "Requires the `org:read:resources` organization API scope.", "x-required-scopes": [ "org:read:resources" ] } }, "/api/org/v1/{slug}": { "get": { "tags": [ "Organization API" ], "summary": "Get V1 Slug", "operationId": "get_api_org_v1_slug", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "security": [ { "orgApiKey": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bearer API key is missing, invalid, or revoked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missing": { "value": { "success": false, "error": { "message": "Missing API key.", "code": "API_KEY_MISSING" } } }, "invalid": { "value": { "success": false, "error": { "message": "Invalid or revoked API key.", "code": "API_KEY_INVALID" } } } } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missingScope": { "value": { "success": false, "error": { "message": "This API key is missing the required scope.", "code": "API_SCOPE_MISSING" } } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "description": "Requires the `org:read:operations` organization API scope.", "x-required-scopes": [ "org:read:operations" ] } }, "/api/org/v1/{slug}/services": { "get": { "tags": [ "Organization API" ], "summary": "Get Slug Services", "operationId": "get_api_org_v1_slug_services", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "security": [ { "orgApiKey": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bearer API key is missing, invalid, or revoked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missing": { "value": { "success": false, "error": { "message": "Missing API key.", "code": "API_KEY_MISSING" } } }, "invalid": { "value": { "success": false, "error": { "message": "Invalid or revoked API key.", "code": "API_KEY_INVALID" } } } } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missingScope": { "value": { "success": false, "error": { "message": "This API key is missing the required scope.", "code": "API_SCOPE_MISSING" } } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "description": "Requires the `org:read:operations` organization API scope.", "x-required-scopes": [ "org:read:operations" ] } }, "/api/org/v1/{slug}/tours": { "get": { "tags": [ "Organization API" ], "summary": "Get Slug Tours", "operationId": "get_api_org_v1_slug_tours", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "security": [ { "orgApiKey": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bearer API key is missing, invalid, or revoked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missing": { "value": { "success": false, "error": { "message": "Missing API key.", "code": "API_KEY_MISSING" } } }, "invalid": { "value": { "success": false, "error": { "message": "Invalid or revoked API key.", "code": "API_KEY_INVALID" } } } } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missingScope": { "value": { "success": false, "error": { "message": "This API key is missing the required scope.", "code": "API_SCOPE_MISSING" } } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "description": "Requires the `org:read:operations` organization API scope.", "x-required-scopes": [ "org:read:operations" ] } }, "/api/org/v1/{slug}/works": { "get": { "tags": [ "Organization API" ], "summary": "Get Slug Works", "operationId": "get_api_org_v1_slug_works", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "security": [ { "orgApiKey": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Bearer API key is missing, invalid, or revoked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missing": { "value": { "success": false, "error": { "message": "Missing API key.", "code": "API_KEY_MISSING" } } }, "invalid": { "value": { "success": false, "error": { "message": "Invalid or revoked API key.", "code": "API_KEY_INVALID" } } } } } } }, "403": { "description": "The API key lacks the required scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "missingScope": { "value": { "success": false, "error": { "message": "This API key is missing the required scope.", "code": "API_SCOPE_MISSING" } } } } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "description": "Requires the `org:read:operations` organization API scope.", "x-required-scopes": [ "org:read:operations" ] } }, "/api/public/artists/search": { "get": { "tags": [ "Public API" ], "summary": "Get Artists Search", "operationId": "get_api_public_artists_search", "parameters": [], "security": [], "responses": { "200": { "description": "Artist search result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicSearchResult" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/public/org/{slug}/events.ics": { "get": { "tags": [ "Public API" ], "summary": "Get Slug Events Ics", "operationId": "get_api_public_org_slug_events_ics", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "security": [], "responses": { "200": { "description": "iCalendar feed", "content": { "text/calendar": { "schema": { "type": "string" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/public/org/{slug}/events": { "get": { "tags": [ "Public API" ], "summary": "Get Slug Events", "operationId": "get_api_public_org_slug_events", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "security": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/v1/artists/{id}/availability": { "get": { "tags": [ "Public artists API" ], "summary": "Get Id Availability", "operationId": "get_api_v1_artists_id_availability", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "security": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/v1/artists/{id}": { "get": { "tags": [ "Public artists API" ], "summary": "Get Artists Id", "operationId": "get_api_v1_artists_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "security": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/api/v1/artists": { "get": { "tags": [ "Public artists API" ], "summary": "Get V1 Artists", "operationId": "get_api_v1_artists", "parameters": [], "security": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Unexpected server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } } }, "components": { "securitySchemes": { "orgApiKey": { "type": "http", "scheme": "bearer", "bearerFormat": "abo_org_…", "description": "Organization API key. Keys are bound to one organization.", "x-scopes": [ "org:read:operations", "org:read:personnel", "org:read:resources", "org:read:contacts", "org:write:contacts", "org:write:bookings", "org:write:checklist", "org:write:requests" ] } }, "schemas": { "SuccessResponse": { "type": "object", "required": [ "success", "data" ], "properties": { "success": { "const": true }, "data": { "description": "Endpoint data. Collection endpoints expose counts inside data as total or pagination.total." } }, "additionalProperties": false }, "ErrorResponse": { "type": "object", "required": [ "success", "error" ], "properties": { "success": { "const": false }, "error": { "type": "object", "required": [ "message", "code" ], "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "additionalProperties": true } }, "additionalProperties": false }, "PublicSearchResult": { "type": "object", "required": [ "query", "items", "suggestions", "pagination" ], "properties": { "query": { "type": "object", "additionalProperties": true }, "items": { "type": "array", "items": {} }, "didYouMean": { "type": [ "string", "null" ] }, "suggestions": { "type": "array", "items": {} }, "pagination": { "type": "object", "required": [ "page", "limit", "total", "totalPages", "hasNextPage", "hasPreviousPage" ], "properties": { "page": { "type": "integer", "minimum": 1 }, "limit": { "type": "integer", "minimum": 1 }, "total": { "type": "integer", "minimum": 0 }, "totalPages": { "type": "integer", "minimum": 1 }, "hasNextPage": { "type": "boolean" }, "hasPreviousPage": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": false } } } }