{ "openapi": "3.1.0", "info": { "title": "GoPimi API Documentation", "version": "26.3.26", "description": "GoPimi is an API-first ticket management platform. All routes are prefixed with `\/api\/v1\/`. Authenticate with Bearer tokens via Laravel Sanctum." }, "servers": [ { "url": "https:\/\/core.gopimi.com\/api" } ], "security": [ { "http": [] } ], "paths": { "\/v1\/users": { "get": { "operationId": "user.getUsers", "tags": [ "Admin \u2014 Users" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`LengthAwarePaginator`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LengthAwarePaginator" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/users\/{id}": { "get": { "operationId": "user.getUser", "tags": [ "Admin \u2014 Users" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "put": { "operationId": "user.updateUser", "tags": [ "Admin \u2014 Users" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "email": { "type": "string", "format": "email", "maxLength": 255 }, "role": { "type": "string", "enum": [ "admin", "customer" ] } } } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "delete": { "operationId": "user.deleteUser", "tags": [ "Admin \u2014 Users" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/attachments": { "post": { "operationId": "attachment.store", "tags": [ "Attachments" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart\/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "contentMediaType": "application\/octet-stream", "maxLength": 10240 } }, "required": [ "file" ] } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "original_filename": { "type": "string" }, "mime_type": { "type": "string" }, "size": { "type": "integer" } }, "required": [ "id", "original_filename", "mime_type", "size" ] } }, "required": [ "data" ] } } } }, "429": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Storage limit reached for this workspace." } }, "required": [ "message" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/attachments\/{id}": { "get": { "operationId": "attachment.show", "tags": [ "Attachments" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "delete": { "operationId": "attachment.destroy", "tags": [ "Attachments" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/register": { "post": { "operationId": "account.register", "tags": [ "Auth & Account" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "email": { "type": "string", "format": "email", "maxLength": 255 }, "password": { "type": "string", "minLength": 8, "maxLength": 255 }, "invitation_token": { "type": "string", "maxLength": 100 }, "website": { "type": "string" }, "cf_turnstile_token": { "type": "string" } }, "required": [ "name", "email", "password" ] } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "user": { "type": "string" }, "token": { "type": "string" } }, "required": [ "user", "token" ] } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Registration is currently disabled." } }, "required": [ "message" ] } } } } } } }, "\/v1\/login": { "post": { "operationId": "account.login", "tags": [ "Auth & Account" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "maxLength": 255 }, "password": { "type": "string", "maxLength": 255 } }, "required": [ "email", "password" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "user": { "type": "string" }, "token": { "type": "string" } }, "required": [ "user", "token" ] } }, "required": [ "data" ] } } } }, "401": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Invalid credentials" } }, "required": [ "message" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/v1\/account": { "get": { "operationId": "account.getUser", "tags": [ "Auth & Account" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "email": { "type": "string" }, "role": { "$ref": "#\/components\/schemas\/UserRole" }, "email_verified_at": { "type": [ "string", "null" ], "format": "date-time" }, "plan_id": { "type": [ "integer", "null" ] }, "max_workspaces": { "type": [ "integer", "null" ] }, "onboarding_completed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "gravatar_url": { "type": "string" }, "created_workspaces_count": { "type": "integer" }, "subscription_status": { "type": "string", "const": "none" } }, "required": [ "id", "name", "email", "role", "email_verified_at", "plan_id", "max_workspaces", "onboarding_completed_at", "created_at", "updated_at", "gravatar_url", "created_workspaces_count", "subscription_status" ] } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "put": { "operationId": "account.updateUser", "tags": [ "Auth & Account" ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "email": { "type": "string", "format": "email", "maxLength": 255 }, "password": { "type": "string", "minLength": 8, "maxLength": 255 }, "password_confirmation": { "type": "string", "minLength": 8, "maxLength": 255 } } } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/User" } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "delete": { "operationId": "account.deleteUser", "tags": [ "Auth & Account" ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/account\/password": { "put": { "operationId": "account.updatePassword", "tags": [ "Auth & Account" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "current_password": { "type": "string" }, "password": { "type": "string", "minLength": 8, "maxLength": 255 }, "password_confirmation": { "type": "string", "minLength": 8, "maxLength": 255 } }, "required": [ "current_password", "password", "password_confirmation" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "message": { "type": "string", "const": "Password updated" } }, "required": [ "message" ] } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/account\/onboarding-complete": { "post": { "operationId": "account.completeOnboarding", "tags": [ "Auth & Account" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/User" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/account\/invitations": { "get": { "operationId": "account.myInvitations", "tags": [ "Auth & Account" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WorkspaceInvitation" } } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/account\/invitations\/{token}\/accept": { "post": { "operationId": "account.acceptInvitation", "tags": [ "Auth & Account" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "message": { "type": "string", "const": "Invitation accepted." }, "workspace": { "type": "string" } }, "required": [ "message", "workspace" ] } }, "required": [ "data" ] } } } }, "422": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "message": { "type": "string", "const": "You are already a member of this workspace." } }, "required": [ "message" ] }, { "type": "object", "properties": { "message": { "type": "string", "const": "Invitation is invalid or has expired." } }, "required": [ "message" ] } ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "This invitation was sent to a different email address." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/account\/invitations\/{token}\/decline": { "post": { "operationId": "account.declineInvitation", "tags": [ "Auth & Account" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "message": { "type": "string", "const": "Invitation declined." } }, "required": [ "message" ] } }, "required": [ "data" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "This invitation was sent to a different email address." } }, "required": [ "message" ] } } } }, "422": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Invitation is invalid or has expired." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/invitations\/{token}": { "get": { "operationId": "account.invitationInfo", "tags": [ "Auth & Account" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "email": { "type": "string" }, "role": { "type": "string" }, "workspace": { "type": "string" }, "inviter": { "type": "string" }, "expires_at": { "type": "string" }, "user_exists": { "type": "boolean" } }, "required": [ "email", "role", "workspace", "inviter", "expires_at", "user_exists" ] } }, "required": [ "data" ] } } } }, "422": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Invitation is invalid or has expired." } }, "required": [ "message" ] } } } } } } }, "\/v1\/workspaces\/{workspaceId}\/automations": { "get": { "operationId": "automation.index", "tags": [ "Automation" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Automation" } } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "automation.store", "tags": [ "Automation" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/Automation" } }, "required": [ "data" ] } } } }, "429": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Automation limit reached for this workspace." } }, "required": [ "message" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/automations\/reorder": { "patch": { "operationId": "automation.reorder", "tags": [ "Automation" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer" } } }, "required": [ "ids" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "reordered": { "type": "boolean" } }, "required": [ "reordered" ] } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/automations\/{id}": { "get": { "operationId": "automation.show", "tags": [ "Automation" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "put": { "operationId": "automation.update", "tags": [ "Automation" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "delete": { "operationId": "automation.destroy", "tags": [ "Automation" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleted": { "type": "boolean" } }, "required": [ "deleted" ] } }, "required": [ "data" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/automations\/{id}\/test": { "post": { "operationId": "automation.test", "tags": [ "Automation" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "from_email": { "type": [ "string", "null" ], "maxLength": 255 }, "subject": { "type": [ "string", "null" ], "maxLength": 500 }, "body": { "type": [ "string", "null" ] } } } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "matched": { "type": "boolean" }, "actions_would_apply": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } ] } }, "required": [ "matched", "actions_would_apply" ] } }, "required": [ "data" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/horizon\/api\/batches": { "get": { "operationId": "horizon.jobs-batches.index", "summary": "Get all of the batches", "tags": [ "Batches" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "batches": { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0, "additionalItems": false } }, "required": [ "batches" ] } } } } } } }, "\/horizon\/api\/batches\/{id}": { "get": { "operationId": "horizon.jobs-batches.show", "summary": "Get the details of a batch by ID", "tags": [ "Batches" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "batch": { "type": "string" }, "failedJobs": { "type": [ "string", "null" ] } }, "required": [ "batch", "failedJobs" ] } } } } } } }, "\/horizon\/api\/batches\/retry\/{id}": { "post": { "operationId": "horizon.jobs-batches.retry", "summary": "Retry the given batch", "tags": [ "Batches" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/telescope\/telescope-api\/cache": { "post": { "operationId": "cache.index", "summary": "List the entries of the given type", "tags": [ "Cache" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entries": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] }, "status": { "type": "string", "enum": [ "enabled", "off", "paused", "disabled" ] } }, "required": [ "entries", "status" ] } } } } } } }, "\/telescope\/telescope-api\/cache\/{id}": { "get": { "operationId": "cache.show", "summary": "Get an entry with the given ID", "tags": [ "Cache" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entry": { "type": "object" }, "batch": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "entry", "batch" ] } } } } } } }, "\/v1\/workspaces\/{workspaceId}\/canned-responses": { "get": { "operationId": "cannedResponse.index", "tags": [ "Canned Responses" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`LengthAwarePaginator`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LengthAwarePaginator" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "cannedResponse.store", "tags": [ "Canned Responses" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "content": { "type": "string", "minLength": 1, "maxLength": 10000 } }, "required": [ "name", "content" ] } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/CannedResponse" } }, "required": [ "data" ] } } } }, "429": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Canned response limit reached for your plan." } }, "required": [ "message" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/canned-responses\/bulk-delete": { "post": { "operationId": "cannedResponse.bulkDelete", "tags": [ "Canned Responses" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer" }, "minItems": 1, "maxItems": 100 } }, "required": [ "ids" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleted": {} }, "required": [ "deleted" ] } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/canned-responses\/{id}": { "get": { "operationId": "cannedResponse.show", "tags": [ "Canned Responses" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "put": { "operationId": "cannedResponse.update", "tags": [ "Canned Responses" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "content": { "type": "string", "minLength": 1, "maxLength": 10000 } } } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "delete": { "operationId": "cannedResponse.destroy", "tags": [ "Canned Responses" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/telescope\/telescope-api\/client-requests": { "post": { "operationId": "clientRequest.index", "summary": "List the entries of the given type", "tags": [ "Client Request" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entries": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] }, "status": { "type": "string", "enum": [ "enabled", "off", "paused", "disabled" ] } }, "required": [ "entries", "status" ] } } } } } } }, "\/telescope\/telescope-api\/client-requests\/{id}": { "get": { "operationId": "clientRequest.show", "summary": "Get an entry with the given ID", "tags": [ "Client Request" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entry": { "type": "object" }, "batch": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "entry", "batch" ] } } } } } } }, "\/telescope\/telescope-api\/commands": { "post": { "operationId": "commands.index", "summary": "List the entries of the given type", "tags": [ "Commands" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entries": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] }, "status": { "type": "string", "enum": [ "enabled", "off", "paused", "disabled" ] } }, "required": [ "entries", "status" ] } } } } } } }, "\/telescope\/telescope-api\/commands\/{id}": { "get": { "operationId": "commands.show", "summary": "Get an entry with the given ID", "tags": [ "Commands" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entry": { "type": "object" }, "batch": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "entry", "batch" ] } } } } } } }, "\/horizon\/api\/jobs\/completed": { "get": { "operationId": "horizon.completed-jobs.index", "summary": "Get all of the completed jobs", "tags": [ "Completed Jobs" ], "parameters": [ { "name": "starting_at", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "jobs": { "type": "string" }, "total": { "type": "string" } }, "required": [ "jobs", "total" ] } } } } } } }, "\/v1\/workspaces\/{workspaceId}\/contact-custom-fields": { "get": { "operationId": "contactCustomField.index", "tags": [ "Contact Custom Field" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ContactCustomField" } } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "contactCustomField.store", "tags": [ "Contact Custom Field" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 255 }, "key": { "type": "string", "pattern": "^[a-z0-9_]+$", "maxLength": 255 }, "type": { "type": "string", "enum": [ "text", "number", "date", "select", "boolean", "url", "email" ] }, "required": { "type": "boolean" }, "multiple": { "type": "boolean" }, "featured": { "type": "boolean" }, "sort_order": { "type": "integer", "minimum": 0 }, "options": { "type": [ "array", "null" ], "items": { "type": "string", "maxLength": 255 } } }, "required": [ "name", "key", "type" ] } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/ContactCustomField" } }, "required": [ "data" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/contact-custom-fields\/bulk-delete": { "post": { "operationId": "contactCustomField.bulkDelete", "tags": [ "Contact Custom Field" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer" }, "minItems": 1, "maxItems": 100 } }, "required": [ "ids" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleted": {} }, "required": [ "deleted" ] } }, "required": [ "data" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/contact-custom-fields\/reorder": { "post": { "operationId": "contactCustomField.reorder", "tags": [ "Contact Custom Field" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "order": { "type": "array", "items": { "type": "integer" } } }, "required": [ "order" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "message": { "type": "string", "const": "Order updated." } }, "required": [ "message" ] } }, "required": [ "data" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/contact-custom-fields\/{id}": { "get": { "operationId": "contactCustomField.show", "tags": [ "Contact Custom Field" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "put": { "operationId": "contactCustomField.update", "tags": [ "Contact Custom Field" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 255 }, "key": { "type": "string", "pattern": "^[a-z0-9_]+$", "maxLength": 255 }, "type": { "type": "string", "enum": [ "text", "number", "date", "select", "boolean", "url", "email" ] }, "required": { "type": "boolean" }, "multiple": { "type": "boolean" }, "featured": { "type": "boolean" }, "sort_order": { "type": "integer", "minimum": 0 }, "options": { "type": [ "array", "null" ], "items": { "type": "string", "maxLength": 255 } } } } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "delete": { "operationId": "contactCustomField.destroy", "tags": [ "Contact Custom Field" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/contacts": { "get": { "operationId": "workspaceContact.index", "tags": [ "Contacts" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "with", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "organization_id", "in": "query", "schema": { "type": "string" } }, { "name": "no_organization", "in": "query", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "schema": { "type": "string", "default": "id" } } ], "responses": { "200": { "description": "`LengthAwarePaginator`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LengthAwarePaginator" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "workspaceContact.store", "tags": [ "Contacts" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "title": { "type": [ "string", "null" ], "maxLength": 255 }, "email": { "type": "string", "format": "email", "maxLength": 255 }, "phone": { "type": [ "string", "null" ], "maxLength": 50 }, "organization_id": { "type": [ "string", "null" ] }, "custom_fields": { "type": "string" } }, "required": [ "name", "email" ] } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/Contact" } }, "required": [ "data" ] } } } }, "429": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Contact limit reached for your plan." } }, "required": [ "message" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/contacts\/bulk-delete": { "post": { "operationId": "workspaceContact.bulkDelete", "tags": [ "Contacts" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer" }, "minItems": 1, "maxItems": 100 } }, "required": [ "ids" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "affected": {} }, "required": [ "affected" ] } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/contacts\/{id}": { "get": { "operationId": "workspaceContact.show", "tags": [ "Contacts" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "with", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "put": { "operationId": "workspaceContact.update", "tags": [ "Contacts" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "title": { "type": [ "string", "null" ], "maxLength": 255 }, "email": { "type": "string", "format": "email", "maxLength": 255 }, "phone": { "type": [ "string", "null" ], "maxLength": 50 }, "organization_id": { "type": [ "string", "null" ] }, "custom_fields": { "type": "string" } } } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "delete": { "operationId": "workspaceContact.destroy", "tags": [ "Contacts" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/personal-inbox\/{conversationId}\/activities": { "get": { "operationId": "v1.conversationActivity.index_0", "tags": [ "Conversation Activity" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`LengthAwarePaginator`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LengthAwarePaginator" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/conversations\/{conversationId}\/activities": { "get": { "operationId": "v1.conversationActivity.index_0", "tags": [ "Conversation Activity" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`LengthAwarePaginator`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LengthAwarePaginator" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/conversations\/{conversationId}\/draft": { "get": { "operationId": "v1.conversationDraft.show_0", "tags": [ "Conversation Draft" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/ConversationMessage" }, { "type": "null" } ] } }, "required": [ "data" ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "No draft found." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "put": { "operationId": "v1.conversationDraft.upsert_1", "tags": [ "Conversation Draft" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "body": { "type": "string", "minLength": 1, "maxLength": 10000 }, "from_email": { "type": [ "string", "null" ], "format": "email", "maxLength": 255 }, "cc_emails": { "type": [ "array", "null" ], "items": { "type": "string", "format": "email", "maxLength": 255 } } }, "required": [ "body" ] } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/ConversationMessage" } }, "required": [ "data" ] } } } }, "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/ConversationMessage" }, { "type": "null" } ] } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "delete": { "operationId": "v1.conversationDraft.destroy_2", "tags": [ "Conversation Draft" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "No draft found." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/personal-inbox\/{conversationId}\/draft": { "get": { "operationId": "v1.conversationDraft.show_0", "tags": [ "Conversation Draft" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/ConversationMessage" }, { "type": "null" } ] } }, "required": [ "data" ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "No draft found." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "put": { "operationId": "v1.conversationDraft.upsert_1", "tags": [ "Conversation Draft" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "body": { "type": "string", "minLength": 1, "maxLength": 10000 }, "from_email": { "type": [ "string", "null" ], "format": "email", "maxLength": 255 }, "cc_emails": { "type": [ "array", "null" ], "items": { "type": "string", "format": "email", "maxLength": 255 } } }, "required": [ "body" ] } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/ConversationMessage" } }, "required": [ "data" ] } } } }, "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/ConversationMessage" }, { "type": "null" } ] } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "delete": { "operationId": "v1.conversationDraft.destroy_2", "tags": [ "Conversation Draft" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "No draft found." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/personal-inbox\/{conversationId}\/messages\/trashed": { "get": { "operationId": "v1.conversationMessage.trashed_0", "tags": [ "Conversation Messages" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`LengthAwarePaginator`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LengthAwarePaginator" } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/personal-inbox\/{conversationId}\/messages": { "post": { "operationId": "v1.conversationMessage.store_0", "tags": [ "Conversation Messages" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "body": { "type": "string", "minLength": 1, "maxLength": 10000 }, "type": { "type": "string", "enum": [ "outbound", "internal_note" ] }, "from": { "type": [ "string", "null" ], "format": "email", "maxLength": 255 }, "to": { "type": [ "string", "null" ], "format": "email", "maxLength": 255 }, "cc": { "type": "array", "items": { "type": "string", "format": "email", "maxLength": 255 } }, "attachment_ids": { "type": "array", "items": { "type": "integer" }, "maxItems": 10 } }, "required": [ "body", "type" ] } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/ConversationMessage" } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/personal-inbox\/{conversationId}\/messages\/{messageId}\/restore": { "post": { "operationId": "v1.conversationMessage.restore_0", "tags": [ "Conversation Messages" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/personal-inbox\/{conversationId}\/messages\/{messageId}\/force": { "delete": { "operationId": "v1.conversationMessage.forceDestroy_0", "tags": [ "Conversation Messages" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/personal-inbox\/{conversationId}\/messages\/{messageId}": { "delete": { "operationId": "v1.conversationMessage.destroy_0", "tags": [ "Conversation Messages" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/conversations\/{conversationId}\/messages\/trashed": { "get": { "operationId": "v1.conversationMessage.trashed_0", "tags": [ "Conversation Messages" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`LengthAwarePaginator`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LengthAwarePaginator" } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/conversations\/{conversationId}\/messages": { "post": { "operationId": "v1.conversationMessage.store_0", "tags": [ "Conversation Messages" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "body": { "type": "string", "minLength": 1, "maxLength": 10000 }, "type": { "type": "string", "enum": [ "outbound", "internal_note" ] }, "from": { "type": [ "string", "null" ], "format": "email", "maxLength": 255 }, "to": { "type": [ "string", "null" ], "format": "email", "maxLength": 255 }, "cc": { "type": "array", "items": { "type": "string", "format": "email", "maxLength": 255 } }, "attachment_ids": { "type": "array", "items": { "type": "integer" }, "maxItems": 10 } }, "required": [ "body", "type" ] } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/ConversationMessage" } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/conversations\/{conversationId}\/messages\/{messageId}\/restore": { "post": { "operationId": "v1.conversationMessage.restore_0", "tags": [ "Conversation Messages" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/conversations\/{conversationId}\/messages\/{messageId}\/force": { "delete": { "operationId": "v1.conversationMessage.forceDestroy_0", "tags": [ "Conversation Messages" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/conversations\/{conversationId}\/messages\/{messageId}": { "delete": { "operationId": "v1.conversationMessage.destroy_0", "tags": [ "Conversation Messages" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/personal-inbox\/{conversationId}\/tags": { "get": { "operationId": "v1.conversationTag.index_0", "tags": [ "Conversation Tag" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "v1.conversationTag.store_1", "tags": [ "Conversation Tag" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "tag_id": { "type": "integer" }, "tag_name": { "type": "string", "minLength": 1, "maxLength": 255 } } } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/Tag" } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/personal-inbox\/{conversationId}\/tags\/{tagId}": { "delete": { "operationId": "v1.conversationTag.destroy_0", "tags": [ "Conversation Tag" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tagId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Tag is not attached to this conversation." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/conversations\/{conversationId}\/tags": { "get": { "operationId": "v1.conversationTag.index_0", "tags": [ "Conversation Tag" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "v1.conversationTag.store_1", "tags": [ "Conversation Tag" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "tag_id": { "type": "integer" }, "tag_name": { "type": "string", "minLength": 1, "maxLength": 255 } } } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/Tag" } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/conversations\/{conversationId}\/tags\/{tagId}": { "delete": { "operationId": "v1.conversationTag.destroy_0", "tags": [ "Conversation Tag" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tagId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Tag is not attached to this conversation." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/conversations\/trashed": { "get": { "operationId": "conversation.trashed", "tags": [ "Conversations (Shared Inbox)" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`LengthAwarePaginator`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LengthAwarePaginator" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/conversations\/bulk": { "post": { "operationId": "conversation.bulkAction", "tags": [ "Conversations (Shared Inbox)" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "trash", "spam", "not_spam", "restore", "force_delete", "assign", "unassign", "close", "reopen", "mark_read", "mark_unread", "add_tag", "remove_tag" ] }, "agent_id": { "type": [ "string", "null" ] }, "tag_id": { "type": [ "integer", "null" ] }, "ids": { "type": "array", "items": { "type": "integer" }, "minItems": 1, "maxItems": 100 } }, "required": [ "action", "ids" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "affected": { "type": "integer" } }, "required": [ "affected" ] } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/conversations": { "get": { "operationId": "conversation.index", "tags": [ "Conversations (Shared Inbox)" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "is_spam", "in": "query", "description": "Spam filtering: default excludes spam, ?is_spam=1 shows only spam, ?is_spam=all shows everything", "schema": { "type": "string" } }, { "name": "agent_id", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "contact_id", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "is_read", "in": "query", "schema": { "type": "string" } }, { "name": "with", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`LengthAwarePaginator`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LengthAwarePaginator" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "conversation.store", "tags": [ "Conversations (Shared Inbox)" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "to": { "type": "string", "format": "email", "maxLength": 255 }, "subject": { "type": "string", "minLength": 1, "maxLength": 255 }, "body": { "type": "string", "minLength": 1, "maxLength": 10000 }, "workspace_email": { "type": [ "string", "null" ], "format": "email", "maxLength": 255 }, "cc": { "type": "array", "items": { "type": "string", "format": "email", "maxLength": 255 } }, "attachment_ids": { "type": "array", "items": { "type": "integer" }, "maxItems": 10 } }, "required": [ "to", "subject", "body" ] } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/Conversation" } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/conversations\/spam": { "delete": { "operationId": "conversation.deleteAllSpam", "tags": [ "Conversations (Shared Inbox)" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } }, "required": [ "data" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/conversations\/{id}": { "get": { "operationId": "conversation.show", "tags": [ "Conversations (Shared Inbox)" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "put": { "operationId": "conversation.update", "tags": [ "Conversations (Shared Inbox)" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "agent_id": { "type": [ "string", "null" ] }, "contact_id": { "type": [ "string", "null" ] }, "status": { "type": "string", "enum": [ "open", "closed" ] }, "is_read": { "type": "boolean" } } } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "delete": { "operationId": "conversation.destroy", "tags": [ "Conversations (Shared Inbox)" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/conversations\/{id}\/mark-spam": { "post": { "operationId": "conversation.markSpam", "tags": [ "Conversations (Shared Inbox)" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/conversations\/{id}\/not-spam": { "post": { "operationId": "conversation.notSpam", "tags": [ "Conversations (Shared Inbox)" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/conversations\/{id}\/restore": { "post": { "operationId": "conversation.restore", "tags": [ "Conversations (Shared Inbox)" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/conversations\/{id}\/force": { "delete": { "operationId": "conversation.forceDestroy", "tags": [ "Conversations (Shared Inbox)" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/admin\/blocked-senders\/create": { "get": { "operationId": "filament.admin.resources.blocked-senders.create", "tags": [ "Create Blocked Sender" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/canned-responses\/create": { "get": { "operationId": "filament.admin.resources.canned-responses.create", "tags": [ "Create Canned Response" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/contacts\/create": { "get": { "operationId": "filament.admin.resources.contacts.create", "tags": [ "Create Contact" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/organizations\/create": { "get": { "operationId": "filament.admin.resources.organizations.create", "tags": [ "Create Organization" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/plans\/create": { "get": { "operationId": "filament.admin.resources.plans.create", "tags": [ "Create Plan" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/sla-policies\/create": { "get": { "operationId": "filament.admin.resources.sla-policies.create", "tags": [ "Create Sla Policy" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/tags\/create": { "get": { "operationId": "filament.admin.resources.tags.create", "tags": [ "Create Tag" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/tickets\/create": { "get": { "operationId": "filament.admin.resources.tickets.create", "tags": [ "Create Ticket" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/users\/create": { "get": { "operationId": "filament.admin.resources.users.create", "tags": [ "Create User" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/workspaces\/create": { "get": { "operationId": "filament.admin.resources.workspaces.create", "tags": [ "Create Workspace" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/sanctum\/csrf-cookie": { "get": { "operationId": "sanctum.csrf-cookie", "summary": "Return an empty response simply to trigger the storage of the CSRF cookie in the browser", "tags": [ "Csrf Cookie" ], "responses": { "204": { "description": "No content\n\nNo content", "content": { "application\/json": { "schema": { "type": "array", "items": {} } } } } } } }, "\/v1\/workspaces\/{workspaceId}\/domains": { "get": { "operationId": "workspaceDomain.index", "tags": [ "Custom Domains" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`LengthAwarePaginator`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LengthAwarePaginator" } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "workspaceDomain.store", "tags": [ "Custom Domains" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "maxLength": 255 } }, "required": [ "domain" ] } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "domain": { "$ref": "#\/components\/schemas\/WorkspaceDomain" }, "dns_records": { "type": "string" } }, "required": [ "domain", "dns_records" ] } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "429": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Domain limit reached for your plan." } }, "required": [ "message" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/domains\/{id}": { "get": { "operationId": "workspaceDomain.show", "tags": [ "Custom Domains" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "delete": { "operationId": "workspaceDomain.destroy", "tags": [ "Custom Domains" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "422": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Cannot delete domain with active email addresses. Remove associated emails first." } }, "required": [ "message" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/domains\/{id}\/dns-records": { "get": { "operationId": "workspaceDomain.dnsRecords", "tags": [ "Custom Domains" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/domains\/{id}\/verify-ownership": { "post": { "operationId": "workspaceDomain.verifyOwnership", "tags": [ "Custom Domains" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "422": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] }, { "type": "object", "properties": { "message": { "type": "string", "const": "No verification token found for this domain." } }, "required": [ "message" ] } ] } } } }, "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/domains\/{id}\/verify": { "post": { "operationId": "workspaceDomain.verify", "tags": [ "Custom Domains" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "422": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] }, { "type": "object", "properties": { "message": { "type": "string", "const": "Domain ownership must be verified first. Add the TXT record and verify ownership." } }, "required": [ "message" ] } ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/admin": { "get": { "operationId": "filament.admin.pages.dashboard", "tags": [ "Dashboard" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/horizon\/api\/stats": { "get": { "operationId": "horizon.stats.index", "summary": "Get the key performance stats for the dashboard", "tags": [ "Dashboard Stats" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "failedJobs": { "type": "string" }, "jobsPerMinute": { "type": "string" }, "pausedMasters": { "type": "integer" }, "periods": { "type": "object", "properties": { "failedJobs": { "type": "string" }, "recentJobs": { "type": "string" } }, "required": [ "failedJobs", "recentJobs" ] }, "processes": { "type": "integer" }, "queueWithMaxRuntime": { "type": "string" }, "queueWithMaxThroughput": { "type": "string" }, "recentJobs": { "type": "string" }, "status": { "type": "string", "enum": [ "paused", "running", "inactive" ] }, "wait": { "type": "array", "items": { "type": "string" } } }, "required": [ "failedJobs", "jobsPerMinute", "pausedMasters", "periods", "processes", "queueWithMaxRuntime", "queueWithMaxThroughput", "recentJobs", "status", "wait" ] } } } } } } }, "\/filament\/exports\/{export}\/download": { "get": { "operationId": "filament.exports.download", "tags": [ "Download Export" ], "parameters": [ { "name": "export", "in": "path", "required": true, "description": "The export ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object" } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } } }, "\/filament\/imports\/{import}\/failed-rows\/download": { "get": { "operationId": "filament.imports.failed-rows.download", "tags": [ "Download Import Failure Csv" ], "parameters": [ { "name": "import", "in": "path", "required": true, "description": "The import ID", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "text\/csv": { "schema": { "type": "string" } } }, "headers": { "Transfer-Encoding": { "required": true, "schema": { "type": "string", "enum": [ "chunked" ] } } } }, "403": { "$ref": "#\/components\/responses\/AuthorizationException" }, "404": { "$ref": "#\/components\/responses\/ModelNotFoundException" } } } }, "\/telescope\/telescope-api\/dumps": { "post": { "operationId": "dump.index", "summary": "List the entries of the given type", "tags": [ "Dump" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "dump": { "type": [ "string", "null" ] }, "entries": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] }, "status": { "type": "string", "enum": [ "enabled", "off", "paused", "disabled", "wrong-cache" ] } }, "required": [ "dump", "entries", "status" ] } } } } } } }, "\/admin\/canned-responses\/{record}\/edit": { "get": { "operationId": "filament.admin.resources.canned-responses.edit", "tags": [ "Edit Canned Response" ], "parameters": [ { "name": "record", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/contacts\/{record}\/edit": { "get": { "operationId": "filament.admin.resources.contacts.edit", "tags": [ "Edit Contact" ], "parameters": [ { "name": "record", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/members\/{record}\/edit": { "get": { "operationId": "filament.admin.resources.members.edit", "tags": [ "Edit Member" ], "parameters": [ { "name": "record", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/organizations\/{record}\/edit": { "get": { "operationId": "filament.admin.resources.organizations.edit", "tags": [ "Edit Organization" ], "parameters": [ { "name": "record", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/plans\/{record}\/edit": { "get": { "operationId": "filament.admin.resources.plans.edit", "tags": [ "Edit Plan" ], "parameters": [ { "name": "record", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/sla-policies\/{record}\/edit": { "get": { "operationId": "filament.admin.resources.sla-policies.edit", "tags": [ "Edit Sla Policy" ], "parameters": [ { "name": "record", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/tags\/{record}\/edit": { "get": { "operationId": "filament.admin.resources.tags.edit", "tags": [ "Edit Tag" ], "parameters": [ { "name": "record", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/tickets\/{record}\/edit": { "get": { "operationId": "filament.admin.resources.tickets.edit", "tags": [ "Edit Ticket" ], "parameters": [ { "name": "record", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/users\/{record}\/edit": { "get": { "operationId": "filament.admin.resources.users.edit", "tags": [ "Edit User" ], "parameters": [ { "name": "record", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/workspaces\/{record}\/edit": { "get": { "operationId": "filament.admin.resources.workspaces.edit", "tags": [ "Edit Workspace" ], "parameters": [ { "name": "record", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/workspace-emails\/{record}\/edit": { "get": { "operationId": "filament.admin.resources.workspace-emails.edit", "tags": [ "Edit Workspace Email" ], "parameters": [ { "name": "record", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/email-files": { "get": { "operationId": "filament.admin.pages.email-files", "tags": [ "Email Files" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/telescope\/telescope-api\/entries": { "delete": { "operationId": "entries.destroy", "summary": "Delete all of the entries from storage", "tags": [ "Entries" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/telescope\/telescope-api\/events": { "post": { "operationId": "events.index", "summary": "List the entries of the given type", "tags": [ "Events" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entries": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] }, "status": { "type": "string", "enum": [ "enabled", "off", "paused", "disabled" ] } }, "required": [ "entries", "status" ] } } } } } } }, "\/telescope\/telescope-api\/events\/{id}": { "get": { "operationId": "events.show", "summary": "Get an entry with the given ID", "tags": [ "Events" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entry": { "type": "object" }, "batch": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "entry", "batch" ] } } } } } } }, "\/telescope\/telescope-api\/exceptions": { "post": { "operationId": "exception.index", "summary": "List the entries of the given type", "tags": [ "Exception" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entries": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] }, "status": { "type": "string", "enum": [ "enabled", "off", "paused", "disabled" ] } }, "required": [ "entries", "status" ] } } } } } } }, "\/telescope\/telescope-api\/exceptions\/{id}": { "get": { "operationId": "exception.show", "summary": "Get an entry with the given ID", "tags": [ "Exception" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entry": { "type": "object" }, "batch": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "entry", "batch" ] } } } } } }, "put": { "operationId": "exception.update", "summary": "Update an entry with the given ID", "tags": [ "Exception" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/horizon\/api\/jobs\/failed": { "get": { "operationId": "horizon.failed-jobs.index", "summary": "Get all of the failed jobs", "tags": [ "Failed Jobs" ], "parameters": [ { "name": "tag", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "jobs": { "type": "object" }, "total": { "type": "string" } }, "required": [ "jobs", "total" ] } } } } } } }, "\/horizon\/api\/jobs\/failed\/{id}": { "get": { "operationId": "horizon.failed-jobs.show", "summary": "Get a failed job instance", "tags": [ "Failed Jobs" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": {} } } } } } }, "\/livewire\/preview-file\/{filename}": { "get": { "operationId": "livewire.preview-file", "tags": [ "File Preview" ], "parameters": [ { "name": "filename", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } }, "401": { "description": "An error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "" } }, "required": [ "message" ] } } } } } } }, "\/livewire\/upload-file": { "post": { "operationId": "livewire.upload-file", "tags": [ "File Upload" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "paths": { "type": "array", "description": "Strip out the temporary upload directory from the paths.", "items": { "anyOf": [ { "type": "array", "items": {} }, { "type": "string" } ] } } }, "required": [ "paths" ] } } } }, "401": { "description": "An error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview.", "example": "" } }, "required": [ "message" ] } } } } } } }, "\/livewire\/livewire.min.js": { "get": { "operationId": "frontendAssets.returnJavaScriptAsFile", "tags": [ "Frontend Assets" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/livewire\/livewire.min.js.map": { "get": { "operationId": "frontendAssets.maps", "tags": [ "Frontend Assets" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/telescope\/telescope-api\/gates": { "post": { "operationId": "gates.index", "summary": "List the entries of the given type", "tags": [ "Gates" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entries": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] }, "status": { "type": "string", "enum": [ "enabled", "off", "paused", "disabled" ] } }, "required": [ "entries", "status" ] } } } } } } }, "\/telescope\/telescope-api\/gates\/{id}": { "get": { "operationId": "gates.show", "summary": "Get an entry with the given ID", "tags": [ "Gates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entry": { "type": "object" }, "batch": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "entry", "batch" ] } } } } } } }, "\/livewire\/update": { "post": { "operationId": "livewire.update", "tags": [ "Handle Requests" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/horizon\/{view}": { "get": { "operationId": "horizon.index", "summary": "Single page application catch-all route", "tags": [ "Home" ], "parameters": [ { "name": "view", "in": "path", "required": true, "description": "**Optional**", "schema": { "type": "string" }, "x-optional": true } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/telescope\/{view}": { "get": { "operationId": "telescope", "summary": "Display the Telescope view", "tags": [ "Home" ], "parameters": [ { "name": "view", "in": "path", "required": true, "description": "**Optional**", "schema": { "type": "string" }, "x-optional": true } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/horizon\/api\/metrics\/jobs": { "get": { "operationId": "horizon.jobs-metrics.index", "summary": "Get all of the measured jobs", "tags": [ "Job Metrics" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "array", "items": {} } } } } } } }, "\/horizon\/api\/metrics\/jobs\/{id}": { "get": { "operationId": "horizon.jobs-metrics.show", "summary": "Get metrics for a given job", "tags": [ "Job Metrics" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "\/horizon\/api\/jobs\/{id}": { "get": { "operationId": "horizon.jobs.show", "summary": "Get the details of a recent job by ID", "tags": [ "Jobs" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "array", "items": {} } } } } } } }, "\/admin\/blocked-senders": { "get": { "operationId": "filament.admin.resources.blocked-senders.index", "tags": [ "List Blocked Senders" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/canned-responses": { "get": { "operationId": "filament.admin.resources.canned-responses.index", "tags": [ "List Canned Responses" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/contacts": { "get": { "operationId": "filament.admin.resources.contacts.index", "tags": [ "List Contacts" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/conversations": { "get": { "operationId": "filament.admin.resources.conversations.index", "tags": [ "List Conversations" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/members": { "get": { "operationId": "filament.admin.resources.members.index", "tags": [ "List Members" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/organizations": { "get": { "operationId": "filament.admin.resources.organizations.index", "tags": [ "List Organizations" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/plans": { "get": { "operationId": "filament.admin.resources.plans.index", "tags": [ "List Plans" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/sla-policies": { "get": { "operationId": "filament.admin.resources.sla-policies.index", "tags": [ "List Sla Policies" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/tags": { "get": { "operationId": "filament.admin.resources.tags.index", "tags": [ "List Tags" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/tickets": { "get": { "operationId": "filament.admin.resources.tickets.index", "tags": [ "List Tickets" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/users": { "get": { "operationId": "filament.admin.resources.users.index", "tags": [ "List Users" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/workspace-domains": { "get": { "operationId": "filament.admin.resources.workspace-domains.index", "tags": [ "List Workspace Domains" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/workspace-emails": { "get": { "operationId": "filament.admin.resources.workspace-emails.index", "tags": [ "List Workspace Emails" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/workspaces": { "get": { "operationId": "filament.admin.resources.workspaces.index", "tags": [ "List Workspaces" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/telescope\/telescope-api\/logs": { "post": { "operationId": "log.index", "summary": "List the entries of the given type", "tags": [ "Log" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entries": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] }, "status": { "type": "string", "enum": [ "enabled", "off", "paused", "disabled" ] } }, "required": [ "entries", "status" ] } } } } } } }, "\/telescope\/telescope-api\/logs\/{id}": { "get": { "operationId": "log.show", "summary": "Get an entry with the given ID", "tags": [ "Log" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entry": { "type": "object" }, "batch": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "entry", "batch" ] } } } } } } }, "\/admin\/login": { "get": { "operationId": "filament.admin.auth.login", "tags": [ "Login" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "string" } } } } } } }, "\/admin\/logout": { "post": { "operationId": "filament.admin.auth.logout", "tags": [ "Logout" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/telescope\/telescope-api\/mail": { "post": { "operationId": "mail.index", "summary": "List the entries of the given type", "tags": [ "Mail" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entries": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] }, "status": { "type": "string", "enum": [ "enabled", "off", "paused", "disabled" ] } }, "required": [ "entries", "status" ] } } } } } } }, "\/telescope\/telescope-api\/mail\/{id}": { "get": { "operationId": "mail.show", "summary": "Get an entry with the given ID", "tags": [ "Mail" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/telescope\/telescope-api\/mail\/{id}\/download": { "get": { "operationId": "mailEml.show", "summary": "Download the Eml content of the email", "tags": [ "Mail Eml" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "message\/rfc822": { "schema": { "type": "string" } } }, "headers": { "Content-Disposition": { "schema": { "type": "string" } } } } } } }, "\/telescope\/telescope-api\/mail\/{id}\/preview": { "get": { "operationId": "mailHtml.show", "summary": "Get the HTML content of the given email", "tags": [ "Mail Html" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": {} } } } } } }, "\/horizon\/api\/masters": { "get": { "operationId": "horizon.masters.index", "summary": "Get all of the master supervisors and their underlying supervisors", "tags": [ "Master Supervisor" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "array", "items": {} } } } } } } }, "\/telescope\/telescope-api\/models": { "post": { "operationId": "models.index", "summary": "List the entries of the given type", "tags": [ "Models" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entries": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] }, "status": { "type": "string", "enum": [ "enabled", "off", "paused", "disabled" ] } }, "required": [ "entries", "status" ] } } } } } } }, "\/telescope\/telescope-api\/models\/{id}": { "get": { "operationId": "models.show", "summary": "Get an entry with the given ID", "tags": [ "Models" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entry": { "type": "object" }, "batch": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "entry", "batch" ] } } } } } } }, "\/telescope\/telescope-api\/monitored-tags": { "get": { "operationId": "monitoredTag.index", "summary": "Get all of the tags being monitored", "tags": [ "Monitored Tag" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "tags": { "type": "string" } }, "required": [ "tags" ] } } } } } }, "post": { "operationId": "monitoredTag.store", "summary": "Begin monitoring the given tag", "tags": [ "Monitored Tag" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/telescope\/telescope-api\/monitored-tags\/delete": { "post": { "operationId": "monitoredTag.destroy", "summary": "Stop monitoring the given tag", "tags": [ "Monitored Tag" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/horizon\/api\/monitoring": { "get": { "operationId": "horizon.monitoring.index", "summary": "Get all of the monitored tags and their job counts", "tags": [ "Monitoring" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "tag": { "type": "string" }, "count": { "type": "string" } }, "required": [ "tag", "count" ] } } } } } } }, "post": { "operationId": "horizon.monitoring.store", "summary": "Start monitoring the given tag", "tags": [ "Monitoring" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/horizon\/api\/monitoring\/{tag}": { "get": { "operationId": "horizon.monitoring-tag.paginate", "summary": "Paginate the jobs for a given tag", "tags": [ "Monitoring" ], "parameters": [ { "name": "tag", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "string", "default": 25 } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "jobs": { "type": "object" }, "total": { "type": "string" } }, "required": [ "jobs", "total" ] } } } } } }, "delete": { "operationId": "horizon.monitoring-tag.destroy", "summary": "Stop monitoring the given tag", "tags": [ "Monitoring" ], "parameters": [ { "name": "tag", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/v1\/workspaces\/{workspaceId}\/notification-preferences": { "get": { "operationId": "notificationPreference.index", "tags": [ "Notification Preferences" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "put": { "operationId": "notificationPreference.update", "tags": [ "Notification Preferences" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "ticket_assigned": { "type": "boolean" }, "ticket_reply": { "type": "boolean" }, "conversation_message": { "type": "boolean" }, "ticket_status_changed": { "type": "boolean" }, "sla_breach": { "type": "boolean" } } } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/unsubscribe": { "post": { "operationId": "notificationPreference.unsubscribe", "tags": [ "Notification Preferences" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "user_id": { "type": "number" }, "workspace_id": { "type": "number" }, "type": { "type": "string" }, "token": { "type": "string" } }, "required": [ "user_id", "workspace_id", "type", "token" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "message": { "type": "string", "const": "You have been unsubscribed from this notification type." } }, "required": [ "message" ] } }, "required": [ "data" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Invalid or expired unsubscribe link." } }, "required": [ "message" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" } } } }, "\/telescope\/telescope-api\/notifications": { "post": { "operationId": "notifications.index", "summary": "List the entries of the given type", "tags": [ "Notifications" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entries": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] }, "status": { "type": "string", "enum": [ "enabled", "off", "paused", "disabled" ] } }, "required": [ "entries", "status" ] } } } } } } }, "\/telescope\/telescope-api\/notifications\/{id}": { "get": { "operationId": "notifications.show", "summary": "Get an entry with the given ID", "tags": [ "Notifications" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entry": { "type": "object" }, "batch": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "entry", "batch" ] } } } } } } }, "\/v1\/workspaces\/{workspaceId}\/organizations": { "get": { "operationId": "workspaceOrganization.index", "tags": [ "Organizations" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "with", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`LengthAwarePaginator`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LengthAwarePaginator" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "workspaceOrganization.store", "tags": [ "Organizations" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 } }, "required": [ "name" ] } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/Organization" } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/organizations\/bulk-delete": { "post": { "operationId": "workspaceOrganization.bulkDelete", "tags": [ "Organizations" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer" }, "minItems": 1, "maxItems": 100 } }, "required": [ "ids" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleted": {} }, "required": [ "deleted" ] } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/organizations\/{id}": { "get": { "operationId": "workspaceOrganization.show", "tags": [ "Organizations" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "with", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "put": { "operationId": "workspaceOrganization.update", "tags": [ "Organizations" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 } } } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "delete": { "operationId": "workspaceOrganization.destroy", "tags": [ "Organizations" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/paddle-webhook": { "post": { "operationId": "v1.paddleWebhook", "summary": "Handle a Paddle webhook call", "tags": [ "Paddle Webhook" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/horizon\/api\/jobs\/pending": { "get": { "operationId": "horizon.pending-jobs.index", "summary": "Get all of the pending jobs", "tags": [ "Pending Jobs" ], "parameters": [ { "name": "starting_at", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "jobs": { "type": "string" }, "total": { "type": "string" } }, "required": [ "jobs", "total" ] } } } } } } }, "\/v1\/tokens": { "get": { "operationId": "token.index", "tags": [ "Personal Access Tokens" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "last_used_at": { "type": "string" }, "created_at": { "type": "string" }, "is_current": { "type": "boolean" } }, "required": [ "id", "name", "last_used_at", "created_at", "is_current" ] } } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "token.store", "tags": [ "Personal Access Tokens" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 } }, "required": [ "name" ] } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "created_at": { "type": "string" } }, "required": [ "id", "name", "created_at" ] }, "plain_text_token": { "type": "string" } }, "required": [ "data", "plain_text_token" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/tokens\/{id}": { "delete": { "operationId": "token.destroy", "tags": [ "Personal Access Tokens" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "422": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Cannot revoke the token currently in use." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/personal-inbox\/trashed": { "get": { "operationId": "personalInbox.trashed", "tags": [ "Personal Inbox" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`LengthAwarePaginator`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LengthAwarePaginator" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/personal-inbox\/bulk": { "post": { "operationId": "personalInbox.bulkAction", "tags": [ "Personal Inbox" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "trash", "spam", "not_spam", "restore", "force_delete", "close", "reopen", "mark_read", "mark_unread", "add_tag", "remove_tag" ] }, "tag_id": { "type": [ "integer", "null" ] }, "ids": { "type": "array", "items": { "type": "integer" }, "minItems": 1, "maxItems": 100 } }, "required": [ "action", "ids" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "affected": { "type": "string" } }, "required": [ "affected" ] } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/personal-inbox": { "get": { "operationId": "personalInbox.index", "tags": [ "Personal Inbox" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "is_spam", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "contact_id", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "is_read", "in": "query", "schema": { "type": "string" } }, { "name": "with", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`LengthAwarePaginator`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LengthAwarePaginator" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "personalInbox.store", "tags": [ "Personal Inbox" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "to": { "type": "string", "format": "email", "maxLength": 255 }, "subject": { "type": "string", "minLength": 1, "maxLength": 255 }, "body": { "type": "string", "minLength": 1, "maxLength": 10000 }, "workspace_email": { "type": [ "string", "null" ], "format": "email", "maxLength": 255 }, "cc": { "type": "array", "items": { "type": "string", "format": "email", "maxLength": 255 } }, "attachment_ids": { "type": "array", "items": { "type": "integer" }, "maxItems": 10 } }, "required": [ "to", "subject", "body" ] } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/Conversation" } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/personal-inbox\/{id}": { "get": { "operationId": "personalInbox.show", "tags": [ "Personal Inbox" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "put": { "operationId": "personalInbox.update", "tags": [ "Personal Inbox" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "open", "closed" ] }, "is_read": { "type": "boolean" }, "contact_id": { "type": [ "integer", "null" ] } } } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "delete": { "operationId": "personalInbox.destroy", "tags": [ "Personal Inbox" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/personal-inbox\/{id}\/mark-spam": { "post": { "operationId": "personalInbox.spam", "tags": [ "Personal Inbox" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/personal-inbox\/{id}\/not-spam": { "post": { "operationId": "personalInbox.notSpam", "tags": [ "Personal Inbox" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/personal-inbox\/{id}\/restore": { "post": { "operationId": "personalInbox.restore", "tags": [ "Personal Inbox" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/personal-inbox\/{id}\/force": { "delete": { "operationId": "personalInbox.forceDestroy", "tags": [ "Personal Inbox" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/plans": { "get": { "operationId": "plan.index", "tags": [ "Plan" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Plan" } } }, "required": [ "data" ] } } } } } } }, "\/telescope\/telescope-api\/queries": { "post": { "operationId": "queries.index", "summary": "List the entries of the given type", "tags": [ "Queries" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entries": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] }, "status": { "type": "string", "enum": [ "enabled", "off", "paused", "disabled" ] } }, "required": [ "entries", "status" ] } } } } } } }, "\/telescope\/telescope-api\/queries\/{id}": { "get": { "operationId": "queries.show", "summary": "Get an entry with the given ID", "tags": [ "Queries" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entry": { "type": "object" }, "batch": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "entry", "batch" ] } } } } } } }, "\/telescope\/telescope-api\/jobs": { "post": { "operationId": "queue.index", "summary": "List the entries of the given type", "tags": [ "Queue" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entries": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] }, "status": { "type": "string", "enum": [ "enabled", "off", "paused", "disabled" ] } }, "required": [ "entries", "status" ] } } } } } } }, "\/telescope\/telescope-api\/jobs\/{id}": { "get": { "operationId": "queue.show", "summary": "Get an entry with the given ID", "tags": [ "Queue" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entry": { "type": "object" }, "batch": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "entry", "batch" ] } } } } } } }, "\/telescope\/telescope-api\/batches": { "post": { "operationId": "queueBatches.index", "summary": "List the entries of the given type", "tags": [ "Queue Batches" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entries": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] }, "status": { "type": "string", "enum": [ "enabled", "off", "paused", "disabled" ] } }, "required": [ "entries", "status" ] } } } } } } }, "\/telescope\/telescope-api\/batches\/{id}": { "get": { "operationId": "queueBatches.show", "summary": "Get an entry with the given ID", "tags": [ "Queue Batches" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entry": { "type": "object" }, "batch": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "entry", "batch" ] } } } } } } }, "\/horizon\/api\/metrics\/queues": { "get": { "operationId": "horizon.queues-metrics.index", "summary": "Get all of the measured queues", "tags": [ "Queue Metrics" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "array", "items": {} } } } } } } }, "\/horizon\/api\/metrics\/queues\/{id}": { "get": { "operationId": "horizon.queues-metrics.show", "summary": "Get metrics for a given queue", "tags": [ "Queue Metrics" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "\/telescope\/telescope-api\/toggle-recording": { "post": { "operationId": "recording.toggle", "summary": "Toggle recording", "tags": [ "Recording" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/telescope\/telescope-api\/redis": { "post": { "operationId": "redis.index", "summary": "List the entries of the given type", "tags": [ "Redis" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entries": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] }, "status": { "type": "string", "enum": [ "enabled", "off", "paused", "disabled" ] } }, "required": [ "entries", "status" ] } } } } } } }, "\/telescope\/telescope-api\/redis\/{id}": { "get": { "operationId": "redis.show", "summary": "Get an entry with the given ID", "tags": [ "Redis" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entry": { "type": "object" }, "batch": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "entry", "batch" ] } } } } } } }, "\/telescope\/telescope-api\/requests": { "post": { "operationId": "requests.index", "summary": "List the entries of the given type", "tags": [ "Requests" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entries": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] }, "status": { "type": "string", "enum": [ "enabled", "off", "paused", "disabled" ] } }, "required": [ "entries", "status" ] } } } } } } }, "\/telescope\/telescope-api\/requests\/{id}": { "get": { "operationId": "requests.show", "summary": "Get an entry with the given ID", "tags": [ "Requests" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entry": { "type": "object" }, "batch": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "entry", "batch" ] } } } } } } }, "\/horizon\/api\/jobs\/retry\/{id}": { "post": { "operationId": "horizon.retry-jobs.show", "summary": "Retry a failed job", "tags": [ "Retry" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/v1\/workspaces\/{workspaceId}\/sla-policies": { "get": { "operationId": "slaPolicy.index", "tags": [ "SLA Policies" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "array", "items": { "$ref": "#\/components\/schemas\/SlaPolicy" } } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "slaPolicy.store", "tags": [ "SLA Policies" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "priority": { "type": "string", "enum": [ "low", "medium", "high" ] }, "first_response_minutes": { "type": [ "integer", "null" ], "minimum": 1 }, "resolution_minutes": { "type": [ "integer", "null" ], "minimum": 1 }, "is_active": { "type": "boolean" } }, "required": [ "priority" ] } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/SlaPolicy" } }, "required": [ "data" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/sla-policies\/{id}": { "get": { "operationId": "slaPolicy.show", "tags": [ "SLA Policies" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "put": { "operationId": "slaPolicy.update", "tags": [ "SLA Policies" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "priority": { "type": "string", "enum": [ "low", "medium", "high" ] }, "first_response_minutes": { "type": [ "integer", "null" ], "minimum": 1 }, "resolution_minutes": { "type": [ "integer", "null" ], "minimum": 1 }, "is_active": { "type": "boolean" } } } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "delete": { "operationId": "slaPolicy.destroy", "tags": [ "SLA Policies" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/telescope\/telescope-api\/schedule": { "post": { "operationId": "schedule.index", "summary": "List the entries of the given type", "tags": [ "Schedule" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entries": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] }, "status": { "type": "string", "enum": [ "enabled", "off", "paused", "disabled" ] } }, "required": [ "entries", "status" ] } } } } } } }, "\/telescope\/telescope-api\/schedule\/{id}": { "get": { "operationId": "schedule.show", "summary": "Get an entry with the given ID", "tags": [ "Schedule" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entry": { "type": "object" }, "batch": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "entry", "batch" ] } } } } } } }, "\/horizon\/api\/jobs\/silenced": { "get": { "operationId": "horizon.silenced-jobs.index", "summary": "Get all of the silenced jobs", "tags": [ "Silenced Jobs" ], "parameters": [ { "name": "starting_at", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "jobs": { "type": "string" }, "total": { "type": "string" } }, "required": [ "jobs", "total" ] } } } } } } }, "\/v1\/subscription": { "get": { "operationId": "subscription.show", "tags": [ "Subscription" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "data": { "type": "object", "properties": { "plan": { "$ref": "#\/components\/schemas\/Plan" }, "status": { "type": "string" }, "paddle_status": { "type": "string" }, "current_period_end": { "type": "string" }, "on_grace_period": { "type": "string" }, "paused": { "type": "string" } }, "required": [ "plan", "status", "paddle_status", "current_period_end", "on_grace_period", "paused" ] } }, "required": [ "data" ] }, { "type": "object", "properties": { "data": { "type": "object", "properties": { "plan": { "$ref": "#\/components\/schemas\/Plan" }, "status": { "type": "string", "const": "none" }, "on_grace_period": { "type": "boolean" } }, "required": [ "plan", "status", "on_grace_period" ] } }, "required": [ "data" ] } ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/subscribe": { "post": { "operationId": "subscription.store", "tags": [ "Subscription" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "plan_id": { "type": "integer" }, "return_url": { "type": "string" } }, "required": [ "plan_id" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/Checkout" }, "trial_days": { "type": "string" } }, "required": [ "data", "trial_days" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/subscription\/change": { "post": { "operationId": "subscription.change", "tags": [ "Subscription" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "plan_id": { "type": "integer" } }, "required": [ "plan_id" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "message": { "type": "string", "const": "Plan changed successfully." } }, "required": [ "message" ] }, { "type": "object", "properties": { "message": { "type": "string", "const": "Subscription canceled. Access continues until the end of the billing period." } }, "required": [ "message" ] } ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/subscription\/cancel": { "post": { "operationId": "subscription.cancel", "tags": [ "Subscription" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Subscription canceled. Access continues until the end of the billing period." } }, "required": [ "message" ] } } } }, "422": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "message": { "type": "string", "const": "Subscription is already canceled." } }, "required": [ "message" ] }, { "type": "object", "properties": { "message": { "type": "string", "const": "No active subscription found." } }, "required": [ "message" ] } ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/subscription\/resume": { "post": { "operationId": "subscription.resume", "tags": [ "Subscription" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Subscription resumed." } }, "required": [ "message" ] } } } }, "422": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "No subscription to resume." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/tags": { "get": { "operationId": "workspaceTag.index", "tags": [ "Tags" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`LengthAwarePaginator`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LengthAwarePaginator" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "workspaceTag.store", "tags": [ "Tags" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "color": { "type": "string", "pattern": "^#[0-9A-Fa-f]{6}$", "minLength": 7, "maxLength": 7 } }, "required": [ "name", "color" ] } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/Tag" } }, "required": [ "data" ] } } } }, "429": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Tag limit reached for your plan." } }, "required": [ "message" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/tags\/{id}": { "get": { "operationId": "workspaceTag.show", "tags": [ "Tags" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "put": { "operationId": "workspaceTag.update", "tags": [ "Tags" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "color": { "type": "string", "pattern": "^#[0-9A-Fa-f]{6}$", "minLength": 7, "maxLength": 7 } } } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "delete": { "operationId": "workspaceTag.destroy", "tags": [ "Tags" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/tickets\/{ticketId}\/activities": { "get": { "operationId": "ticketActivity.index", "tags": [ "Ticket Activities" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ticketId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`LengthAwarePaginator`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LengthAwarePaginator" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/tickets\/{ticketId}\/draft": { "get": { "operationId": "ticketDraft.show", "tags": [ "Ticket Draft" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ticketId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/TicketMessage" }, { "type": "null" } ] } }, "required": [ "data" ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "No draft found." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "put": { "operationId": "ticketDraft.upsert", "tags": [ "Ticket Draft" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ticketId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "minLength": 1, "maxLength": 10000 }, "from_email": { "type": [ "string", "null" ], "format": "email", "maxLength": 255 }, "cc_emails": { "type": [ "array", "null" ], "items": { "type": "string", "format": "email", "maxLength": 255 } } }, "required": [ "message" ] } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/TicketMessage" } }, "required": [ "data" ] } } } }, "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "$ref": "#\/components\/schemas\/TicketMessage" }, { "type": "null" } ] } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "delete": { "operationId": "ticketDraft.destroy", "tags": [ "Ticket Draft" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ticketId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "No draft found." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/tickets\/{ticket_id}\/messages\/trashed": { "get": { "operationId": "message.trashed", "tags": [ "Ticket Messages" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ticket_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`LengthAwarePaginator`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LengthAwarePaginator" } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/tickets\/{ticket_id}\/messages": { "get": { "operationId": "message.index", "tags": [ "Ticket Messages" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ticket_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`LengthAwarePaginator`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LengthAwarePaginator" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "message.store", "tags": [ "Ticket Messages" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ticket_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "sender_id": { "type": "integer" }, "message": { "type": "string", "minLength": 1, "maxLength": 10000 }, "type": { "type": "string", "enum": [ "email", "internal_note" ] }, "to": { "type": [ "string", "null" ], "format": "email", "maxLength": 255 }, "cc": { "type": "array", "items": { "type": "string", "format": "email", "maxLength": 255 } }, "attachment_ids": { "type": "array", "items": { "type": "integer" }, "maxItems": 10 }, "mentioned_user_ids": { "type": "array", "items": { "type": "integer" } } }, "required": [ "sender_id", "message", "type" ] } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/TicketMessage" } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/tickets\/{ticket_id}\/messages\/{message_id}\/resend": { "post": { "operationId": "message.resend", "tags": [ "Ticket Messages" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ticket_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "message_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "message": { "type": "string", "const": "Email queued for resend" } }, "required": [ "message" ] } }, "required": [ "data" ] } } } }, "422": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Only outgoing agent emails can be resent" } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/tickets\/{ticket_id}\/messages\/{message_id}\/reparse": { "post": { "operationId": "message.reparse", "tags": [ "Ticket Messages" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ticket_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "message_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Raw payload file not found on disk" } }, "required": [ "message" ] } } } }, "422": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "No raw payload available for this message" } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/tickets\/{ticket_id}\/messages\/{message_id}\/restore": { "post": { "operationId": "message.restore", "tags": [ "Ticket Messages" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ticket_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "message_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/tickets\/{ticket_id}\/messages\/{message_id}\/raw": { "get": { "operationId": "message.rawPayload", "tags": [ "Ticket Messages" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ticket_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "message_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": [ "object", "null" ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "message": { "type": "string", "const": "Raw payload file not found on disk" } }, "required": [ "message" ] }, { "type": "object", "properties": { "message": { "type": "string", "const": "No raw payload available for this message" } }, "required": [ "message" ] } ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/tickets\/{ticket_id}\/messages\/{message_id}\/force": { "delete": { "operationId": "message.forceDestroy", "tags": [ "Ticket Messages" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ticket_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "message_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/tickets\/{ticket_id}\/messages\/{message_id}": { "delete": { "operationId": "message.destroy", "tags": [ "Ticket Messages" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ticket_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "message_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "422": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "The first message of a ticket cannot be deleted." } }, "required": [ "message" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/tickets\/{ticketId}\/tags": { "get": { "operationId": "ticketTag.index", "tags": [ "Ticket Tags" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ticketId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "ticketTag.store", "tags": [ "Ticket Tags" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ticketId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "tag_id": { "type": "integer" }, "tag_name": { "type": "string", "minLength": 1, "maxLength": 255 } } } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/Tag" } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/tickets\/{ticketId}\/tags\/{tagId}": { "delete": { "operationId": "ticketTag.destroy", "tags": [ "Ticket Tags" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ticketId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tagId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "404": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Tag is not attached to this ticket." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/tickets\/trashed": { "get": { "operationId": "workspaceTicket.trashed", "tags": [ "Tickets" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "with", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`LengthAwarePaginator`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LengthAwarePaginator" } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/tickets\/bulk": { "post": { "operationId": "workspaceTicket.bulkAction", "tags": [ "Tickets" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "trash", "spam", "not_spam", "restore", "force_delete", "assign", "unassign", "close", "reopen", "mark_read", "mark_unread", "add_tag", "remove_tag" ] }, "agent_id": { "type": [ "string", "null" ] }, "tag_id": { "type": [ "integer", "null" ] }, "ids": { "type": "array", "items": { "type": "integer" }, "minItems": 1, "maxItems": 100 } }, "required": [ "action", "ids" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "affected": { "type": "integer" } }, "required": [ "affected" ] } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/tickets\/spam": { "delete": { "operationId": "workspaceTicket.deleteAllSpam", "tags": [ "Tickets" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] } }, "required": [ "data" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/tickets": { "get": { "operationId": "workspaceTicket.index", "tags": [ "Tickets" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "is_spam", "in": "query", "description": "Spam filtering: default excludes spam, ?is_spam=1 shows only spam, ?is_spam=all shows everything", "schema": { "type": "string" } }, { "name": "with", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "priority", "in": "query", "schema": { "type": "string" } }, { "name": "agent_id", "in": "query", "schema": { "type": "string" } }, { "name": "contact_id", "in": "query", "schema": { "type": "string" } }, { "name": "tag", "in": "query", "schema": { "type": "string" } }, { "name": "is_read", "in": "query", "schema": { "type": "string" } }, { "name": "sla_status", "in": "query", "schema": { "type": "string" } }, { "name": "date_from", "in": "query", "schema": { "type": "string" } }, { "name": "date_to", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`LengthAwarePaginator`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LengthAwarePaginator" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "workspaceTicket.store", "tags": [ "Tickets" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "contact_id": { "type": "string" }, "contact": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "email": { "type": "string", "format": "email", "maxLength": 255 }, "phone": { "type": [ "string", "null" ], "maxLength": 50 }, "organization_id": { "type": [ "integer", "null" ] } }, "required": [ "name", "email" ] } }, "required": [ "contact" ] } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/Ticket" } }, "required": [ "data" ] } } } }, "400": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Contact ID or Contact JSON is required." } }, "required": [ "message" ] } } } }, "404": { "description": "", "content": { "application\/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "message": { "type": "string", "const": "Contact does not belong to current workspace." } }, "required": [ "message" ] }, { "type": "object", "properties": { "message": { "type": "string", "const": "Contact not found." } }, "required": [ "message" ] } ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/tickets\/{id}": { "get": { "operationId": "workspaceTicket.show", "tags": [ "Tickets" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "with", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "put": { "operationId": "workspaceTicket.update", "tags": [ "Tickets" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "subject": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "minLength": 1, "maxLength": 10000 }, "status": { "type": "string", "enum": [ "open", "in_progress", "closed", "pending" ] }, "priority": { "type": "string", "enum": [ "low", "medium", "high" ] }, "agent_id": { "type": [ "string", "null" ] }, "is_read": { "type": "boolean" } } } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "delete": { "operationId": "workspaceTicket.destroy", "tags": [ "Tickets" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/tickets\/{id}\/resend-confirmation": { "post": { "operationId": "workspaceTicket.resendConfirmationEmail", "tags": [ "Tickets" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "message": { "type": "string", "const": "Confirmation email queued." } }, "required": [ "message" ] } }, "required": [ "data" ] } } } }, "400": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Ticket has no contact." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/tickets\/{id}\/mark-spam": { "post": { "operationId": "workspaceTicket.markSpam", "tags": [ "Tickets" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/tickets\/{id}\/not-spam": { "post": { "operationId": "workspaceTicket.notSpam", "tags": [ "Tickets" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/tickets\/{id}\/restore": { "post": { "operationId": "workspaceTicket.restore", "tags": [ "Tickets" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/tickets\/{id}\/force": { "delete": { "operationId": "workspaceTicket.forceDestroy", "tags": [ "Tickets" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/telescope\/telescope-api\/views": { "post": { "operationId": "views.index", "summary": "List the entries of the given type", "tags": [ "Views" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entries": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] }, "status": { "type": "string", "enum": [ "enabled", "off", "paused", "disabled" ] } }, "required": [ "entries", "status" ] } } } } } } }, "\/telescope\/telescope-api\/views\/{id}": { "get": { "operationId": "views.show", "summary": "Get an entry with the given ID", "tags": [ "Views" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "entry": { "type": "object" }, "batch": { "anyOf": [ { "type": "object" }, { "type": "array", "items": { "type": "object" } } ] } }, "required": [ "entry", "batch" ] } } } } } } }, "\/paddle\/webhook": { "post": { "operationId": "cashier.webhook", "summary": "Handle a Paddle webhook call", "tags": [ "Webhooks" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object" } } } } } } }, "\/v1\/workspaces\/{workspace_id}\/webhooks\/events": { "get": { "operationId": "webhook.events", "tags": [ "Webhooks" ], "parameters": [ { "name": "workspace_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/webhooks": { "get": { "operationId": "webhook.index", "tags": [ "Webhooks" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`LengthAwarePaginator`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LengthAwarePaginator" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "webhook.store", "tags": [ "Webhooks" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "description": { "type": [ "string", "null" ], "maxLength": 255 }, "is_active": { "type": "boolean" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "ticket.created", "ticket.updated", "ticket.closed", "ticket.reopened", "ticket.assigned", "ticket.replied", "ticket.tagged", "ticket.deleted", "conversation.created", "conversation.replied", "conversation.closed", "conversation.assigned", "conversation.tagged", "contact.created", "contact.updated", "contact.deleted", "sla.breached" ] }, "minItems": 1 } }, "required": [ "url", "events" ] } } } }, "responses": { "201": { "description": "Return with secret visible for initial creation", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "integer" }, "workspace_id": { "type": "integer" }, "url": { "type": "string" }, "events": { "type": "array", "items": {} }, "description": { "type": [ "string", "null" ] }, "is_active": { "type": "boolean" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "secret": { "type": "string" } }, "required": [ "id", "workspace_id", "url", "events", "description", "is_active", "created_at", "updated_at", "secret" ] } }, "required": [ "data" ] } } } }, "429": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Webhook limit reached for your plan." } }, "required": [ "message" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Only workspace owners can manage webhooks." } }, "required": [ "message" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/webhooks\/{id}": { "get": { "operationId": "webhook.show", "tags": [ "Webhooks" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "put": { "operationId": "webhook.update", "tags": [ "Webhooks" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "maxLength": 2048 }, "description": { "type": [ "string", "null" ], "maxLength": 255 }, "is_active": { "type": "boolean" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "ticket.created", "ticket.updated", "ticket.closed", "ticket.reopened", "ticket.assigned", "ticket.replied", "ticket.tagged", "ticket.deleted", "conversation.created", "conversation.replied", "conversation.closed", "conversation.assigned", "conversation.tagged", "contact.created", "contact.updated", "contact.deleted", "sla.breached" ] }, "minItems": 1 } } } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Only workspace owners can manage webhooks." } }, "required": [ "message" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "delete": { "operationId": "webhook.destroy", "tags": [ "Webhooks" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Only workspace owners can manage webhooks." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/webhooks\/{id}\/regenerate-secret": { "post": { "operationId": "webhook.regenerateSecret", "tags": [ "Webhooks" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "secret": { "type": "string" } }, "required": [ "secret" ] } }, "required": [ "data" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Only workspace owners can manage webhooks." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/webhooks\/{id}\/test": { "post": { "operationId": "webhook.test", "tags": [ "Webhooks" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "message": { "type": "string", "const": "Test webhook queued for delivery." } }, "required": [ "message" ] } }, "required": [ "data" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Only workspace owners can manage webhooks." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/webhooks\/{id}\/deliveries": { "get": { "operationId": "webhook.deliveries", "tags": [ "Webhooks" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`LengthAwarePaginator`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LengthAwarePaginator" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/horizon\/api\/workload": { "get": { "operationId": "horizon.workload.index", "summary": "Get the current queue workload for the application", "tags": [ "Workload" ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "array", "items": {} } } } } } } }, "\/v1\/workspaces\/{workspaceId}\/emails\/available-domains": { "get": { "operationId": "workspaceEmail.availableDomains", "tags": [ "Workspace Emails" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "domain": { "type": "string" }, "send_verified": { "type": "string" }, "mx_verified": { "type": "string" } }, "required": [ "id", "domain", "send_verified", "mx_verified" ] } } }, "required": [ "data" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/emails": { "get": { "operationId": "workspaceEmail.index", "tags": [ "Workspace Emails" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "purpose", "in": "query", "schema": { "type": "string" } }, { "name": "can_send", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`LengthAwarePaginator`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LengthAwarePaginator" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "workspaceEmail.store", "tags": [ "Workspace Emails" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "maxLength": 255 }, "purpose": { "type": "string", "enum": [ "ticket", "inbox" ] }, "user_id": { "type": [ "integer", "null" ] }, "sender_name": { "type": [ "string", "null" ], "maxLength": 255 }, "receive_method": { "type": [ "string", "null" ], "enum": [ "forwarding", "mx" ] }, "can_send": { "type": "boolean" }, "code": { "type": "string", "minLength": 6, "maxLength": 6 } }, "required": [ "email" ] } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/WorkspaceEmail" } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "429": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Email limit reached for your plan." } }, "required": [ "message" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Only workspace owners can manage emails." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/emails\/send-verification": { "post": { "operationId": "workspaceEmail.sendVerification", "tags": [ "Workspace Emails" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "maxLength": 255 } }, "required": [ "email" ] } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "message": { "type": "string", "const": "Verification code sent." } }, "required": [ "message" ] } }, "required": [ "data" ] } } } }, "429": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Verification code already sent. Please wait before requesting a new one." } }, "required": [ "message" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Only workspace owners can manage emails." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/emails\/custom": { "post": { "operationId": "workspaceEmail.storeCustom", "tags": [ "Workspace Emails" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "maxLength": 255 }, "code": { "type": "string", "minLength": 6, "maxLength": 6 }, "purpose": { "type": "string", "enum": [ "ticket", "inbox" ] }, "sender_name": { "type": [ "string", "null" ], "maxLength": 255 } }, "required": [ "email", "code" ] } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/WorkspaceEmail" } }, "required": [ "data" ] } } } }, "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "429": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Email limit reached for your plan." } }, "required": [ "message" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Only workspace owners can manage emails." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/emails\/{id}": { "get": { "operationId": "workspaceEmail.show", "tags": [ "Workspace Emails" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "put": { "operationId": "workspaceEmail.update", "tags": [ "Workspace Emails" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "purpose": { "type": "string", "enum": [ "ticket", "inbox" ] }, "user_id": { "type": [ "integer", "null" ] }, "sender_name": { "type": [ "string", "null" ], "maxLength": 255 }, "can_send": { "type": "boolean" }, "receive_method": { "type": [ "string", "null" ], "enum": [ "forwarding", "mx" ] }, "code": { "type": "string", "minLength": 6, "maxLength": 6 } } } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Only workspace owners can manage emails." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "delete": { "operationId": "workspaceEmail.destroy", "tags": [ "Workspace Emails" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "422": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Platform email cannot be deleted." } }, "required": [ "message" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Only workspace owners can manage emails." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/invitations": { "get": { "operationId": "workspaceInvitation.index", "tags": [ "Workspace Invitation" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "`LengthAwarePaginator`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LengthAwarePaginator" } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "workspaceInvitation.store", "tags": [ "Workspace Invitation" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "maxLength": 255 }, "role": { "type": "string", "enum": [ "owner", "member" ] } }, "required": [ "email", "role" ] } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/WorkspaceInvitation" } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "429": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Member limit reached for your plan." } }, "required": [ "message" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/invitations\/{id}\/resend": { "post": { "operationId": "workspaceInvitation.resend", "tags": [ "Workspace Invitation" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "429": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Too many resend attempts. Please try again later." } }, "required": [ "message" ] } } } }, "422": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Only pending invitations can be resent." } }, "required": [ "message" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/invitations\/{id}": { "delete": { "operationId": "workspaceInvitation.destroy", "tags": [ "Workspace Invitation" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/users": { "get": { "operationId": "workspaceUser.index", "tags": [ "Workspace Members" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "`LengthAwarePaginator`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LengthAwarePaginator" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{workspaceId}\/users\/{id}": { "get": { "operationId": "workspaceUser.show", "tags": [ "Workspace Members" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "put": { "operationId": "workspaceUser.update", "tags": [ "Workspace Members" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "email": { "type": "string", "format": "email", "maxLength": 255 }, "role_in_workspace": { "type": "string", "enum": [ "owner", "member" ] } } } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "delete": { "operationId": "workspaceUser.destroy", "tags": [ "Workspace Members" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "422": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "You cannot remove yourself from the workspace." } }, "required": [ "message" ] } } } }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces": { "get": { "operationId": "workspace.index", "tags": [ "Workspaces" ], "responses": { "200": { "description": "`LengthAwarePaginator`", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LengthAwarePaginator" } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "post": { "operationId": "workspace.store", "tags": [ "Workspaces" ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 } }, "required": [ "name" ] } } } }, "responses": { "201": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "$ref": "#\/components\/schemas\/Workspace" } }, "required": [ "data" ] } } } }, "429": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Workspace limit reached for your plan." } }, "required": [ "message" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{id}": { "get": { "operationId": "workspace.show", "tags": [ "Workspaces" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "put": { "operationId": "workspace.update", "tags": [ "Workspaces" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application\/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "tickets_enabled": { "type": "boolean" }, "shared_inbox_enabled": { "type": "boolean" }, "personal_inbox_enabled": { "type": "boolean" } } } } } }, "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "422": { "$ref": "#\/components\/responses\/ValidationException" }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } }, "delete": { "operationId": "workspace.destroy", "tags": [ "Workspaces" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content" }, "403": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "const": "Unauthorized." } }, "required": [ "message" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{id}\/usage": { "get": { "operationId": "workspace.usage", "tags": [ "Workspaces" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } }, "\/v1\/workspaces\/{id}\/dashboard": { "get": { "operationId": "workspace.dashboard", "tags": [ "Workspaces" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application\/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "my_open_tickets": { "type": "integer" }, "unassigned_tickets": { "type": "integer" }, "unread_tickets": { "type": "integer" }, "my_open_conversations": { "type": "integer" }, "unassigned_conversations": { "type": "integer" }, "unread_conversations": { "type": "integer" }, "open_personal_conversations": { "type": "integer" }, "unread_personal_conversations": { "type": "integer" }, "sla_breached": { "type": "integer" }, "recent_my_tickets": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Ticket" } }, "recent_activity": { "type": "array", "items": { "$ref": "#\/components\/schemas\/TicketActivity" } }, "recent_conversations": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Conversation" } }, "recent_personal_conversations": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Conversation" } }, "agent_workload": { "type": "string" }, "onboarding": { "type": "object", "properties": { "has_custom_email": { "type": "string" }, "member_count": { "type": "string" } }, "required": [ "has_custom_email", "member_count" ] } }, "required": [ "my_open_tickets", "unassigned_tickets", "unread_tickets", "my_open_conversations", "unassigned_conversations", "unread_conversations", "open_personal_conversations", "unread_personal_conversations", "sla_breached", "recent_my_tickets", "recent_activity", "recent_conversations", "recent_personal_conversations", "agent_workload", "onboarding" ] } }, "required": [ "data" ] } } } }, "401": { "$ref": "#\/components\/responses\/AuthenticationException" } } } } }, "components": { "securitySchemes": { "http": { "type": "http", "scheme": "bearer" } }, "schemas": { "Automation": { "type": "object", "properties": { "id": { "type": "integer" }, "workspace_id": { "type": "integer" }, "name": { "type": "string" }, "event": { "type": "string" }, "conditions": { "type": "array", "items": {} }, "actions": { "type": "array", "items": {} }, "priority": { "type": "integer" }, "stop_on_match": { "type": "boolean" }, "is_active": { "type": "boolean" }, "last_matched_at": { "type": [ "string", "null" ], "format": "date-time" }, "match_count": { "type": "integer" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "workspace_id", "name", "event", "conditions", "actions", "priority", "stop_on_match", "is_active", "last_matched_at", "match_count", "created_at", "updated_at" ], "title": "Automation" }, "CannedResponse": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "content": { "type": "string" }, "workspace_id": { "type": "integer" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "name", "content", "workspace_id", "created_at", "updated_at" ], "title": "CannedResponse" }, "Checkout": { "type": "array", "items": {}, "title": "Checkout" }, "Contact": { "type": "object", "properties": { "id": { "type": "integer" }, "workspace_id": { "type": "integer" }, "organization_id": { "type": [ "integer", "null" ] }, "name": { "type": "string" }, "title": { "type": [ "string", "null" ] }, "email": { "type": "string" }, "phone": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "gravatar_url": { "type": "string" } }, "required": [ "id", "workspace_id", "organization_id", "name", "title", "email", "phone", "created_at", "updated_at", "gravatar_url" ], "title": "Contact" }, "ContactCustomField": { "type": "object", "properties": { "id": { "type": "integer" }, "workspace_id": { "type": "integer" }, "name": { "type": "string" }, "key": { "type": "string" }, "type": { "type": "string" }, "options": { "type": [ "array", "null" ], "items": {} }, "required": { "type": "boolean" }, "multiple": { "type": "boolean" }, "featured": { "type": "boolean" }, "sort_order": { "type": "integer" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "workspace_id", "name", "key", "type", "options", "required", "multiple", "featured", "sort_order", "created_at", "updated_at" ], "title": "ContactCustomField" }, "Conversation": { "type": "object", "properties": { "id": { "type": "integer" }, "workspace_id": { "type": "integer" }, "contact_id": { "type": [ "integer", "null" ] }, "agent_id": { "type": [ "integer", "null" ] }, "owner_id": { "type": [ "integer", "null" ] }, "status": { "$ref": "#\/components\/schemas\/ConversationStatus" }, "subject": { "type": "string" }, "preview": { "type": [ "string", "null" ] }, "workspace_email": { "type": [ "string", "null" ] }, "is_spam": { "type": "boolean" }, "spam_score": { "type": [ "number", "null" ] }, "is_read": { "type": "boolean" }, "sending_email": { "type": [ "string", "null" ] }, "last_message_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "workspace_id", "contact_id", "agent_id", "owner_id", "status", "subject", "preview", "workspace_email", "is_spam", "spam_score", "is_read", "sending_email", "last_message_at", "created_at", "updated_at", "deleted_at" ], "title": "Conversation" }, "ConversationMessage": { "type": "object", "properties": { "id": { "type": "integer" }, "conversation_id": { "type": "integer" }, "type": { "$ref": "#\/components\/schemas\/ConversationMessageType" }, "sender_type": { "type": [ "string", "null" ] }, "sender_id": { "type": [ "integer", "null" ] }, "body": { "type": "string" }, "from_email": { "type": [ "string", "null" ] }, "to_email": { "type": [ "string", "null" ] }, "reply_to": { "type": [ "string", "null" ] }, "cc_emails": { "type": [ "array", "null" ], "items": {} }, "message_id": { "type": [ "string", "null" ] }, "in_reply_to": { "type": [ "string", "null" ] }, "is_draft": { "type": "boolean" }, "is_automated": { "type": "boolean" }, "raw_payload_path": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "conversation_id", "type", "sender_type", "sender_id", "body", "from_email", "to_email", "reply_to", "cc_emails", "message_id", "in_reply_to", "is_draft", "is_automated", "raw_payload_path", "created_at", "updated_at", "deleted_at" ], "title": "ConversationMessage" }, "ConversationMessageType": { "type": "string", "enum": [ "inbound", "outbound", "internal_note" ], "title": "ConversationMessageType" }, "ConversationStatus": { "type": "string", "enum": [ "open", "closed" ], "title": "ConversationStatus" }, "EmailPurpose": { "type": "string", "enum": [ "ticket", "inbox" ], "title": "EmailPurpose" }, "LengthAwarePaginator": { "type": "object", "properties": { "current_page": { "type": "integer" }, "data": { "type": "string" }, "first_page_url": { "type": "string" }, "from": { "type": [ "integer", "null" ] }, "last_page": { "type": "integer" }, "last_page_url": { "type": "string" }, "links": { "type": "object", "additionalProperties": {} }, "next_page_url": { "type": "string" }, "path": { "type": [ "string", "null" ] }, "per_page": { "type": "integer" }, "prev_page_url": { "type": [ "string", "null" ] }, "to": { "type": [ "integer", "null" ] }, "total": { "type": "integer" } }, "required": [ "current_page", "data", "first_page_url", "from", "last_page", "last_page_url", "links", "next_page_url", "path", "per_page", "prev_page_url", "to", "total" ], "title": "LengthAwarePaginator" }, "MessageType": { "type": "string", "enum": [ "email", "internal_note" ], "title": "MessageType" }, "Organization": { "type": "object", "properties": { "id": { "type": "integer" }, "workspace_id": { "type": "integer" }, "name": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "workspace_id", "name", "created_at", "updated_at" ], "title": "Organization" }, "Plan": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "price": { "type": "string" }, "paddle_price_id": { "type": [ "string", "null" ] }, "max_workspaces_per_user": { "type": "integer" }, "max_members": { "type": "integer" }, "max_emails": { "type": "integer" }, "max_domains": { "type": "integer" }, "max_contacts": { "type": "integer" }, "max_tags": { "type": "integer" }, "max_canned_responses": { "type": "integer" }, "max_storage_mb": { "type": "integer" }, "max_webhooks": { "type": [ "integer", "null" ] }, "max_automations": { "type": [ "integer", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "name", "slug", "description", "price", "paddle_price_id", "max_workspaces_per_user", "max_members", "max_emails", "max_domains", "max_contacts", "max_tags", "max_canned_responses", "max_storage_mb", "max_webhooks", "max_automations", "created_at", "updated_at" ], "title": "Plan" }, "ReceiveMethod": { "type": "string", "enum": [ "forwarding", "mx", "platform" ], "title": "ReceiveMethod" }, "SlaPolicy": { "type": "object", "properties": { "id": { "type": "integer" }, "workspace_id": { "type": "integer" }, "priority": { "$ref": "#\/components\/schemas\/TicketPriority" }, "first_response_minutes": { "type": [ "integer", "null" ] }, "resolution_minutes": { "type": [ "integer", "null" ] }, "is_active": { "type": "boolean" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "workspace_id", "priority", "first_response_minutes", "resolution_minutes", "is_active", "created_at", "updated_at" ], "title": "SlaPolicy" }, "Tag": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "color": { "type": "string" }, "workspace_id": { "type": "integer" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "name", "color", "workspace_id", "created_at", "updated_at" ], "title": "Tag" }, "Ticket": { "type": "object", "properties": { "id": { "type": "integer" }, "workspace_id": { "type": "integer" }, "workspace_email": { "type": [ "string", "null" ] }, "sending_email": { "type": [ "string", "null" ] }, "contact_id": { "type": [ "integer", "null" ] }, "agent_id": { "type": [ "integer", "null" ] }, "subject": { "type": "string" }, "description": { "type": "string" }, "status": { "$ref": "#\/components\/schemas\/TicketStatus" }, "priority": { "$ref": "#\/components\/schemas\/TicketPriority" }, "is_spam": { "type": "boolean" }, "spam_score": { "type": [ "number", "null" ] }, "is_read": { "type": "boolean" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, "first_response_at": { "type": [ "string", "null" ], "format": "date-time" }, "last_activity_at": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "workspace_id", "workspace_email", "sending_email", "contact_id", "agent_id", "subject", "description", "status", "priority", "is_spam", "spam_score", "is_read", "created_at", "updated_at", "closed_at", "first_response_at", "last_activity_at", "deleted_at" ], "title": "Ticket" }, "TicketActivity": { "type": "object", "properties": { "id": { "type": "integer" }, "ticket_id": { "type": "integer" }, "user_id": { "type": [ "integer", "null" ] }, "action": { "type": "string" }, "properties": { "type": [ "array", "null" ], "items": {} }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "ticket_id", "user_id", "action", "properties", "created_at" ], "title": "TicketActivity" }, "TicketMessage": { "type": "object", "properties": { "id": { "type": "integer" }, "ticket_id": { "type": "integer" }, "sender_type": { "type": [ "string", "null" ] }, "sender_id": { "type": [ "integer", "null" ] }, "message": { "type": "string" }, "type": { "$ref": "#\/components\/schemas\/MessageType" }, "from_email": { "type": [ "string", "null" ] }, "to_email": { "type": [ "string", "null" ] }, "reply_to": { "type": [ "string", "null" ] }, "cc_emails": { "type": [ "array", "null" ], "items": {} }, "mentioned_user_ids": { "type": [ "array", "null" ], "items": {} }, "raw_payload_path": { "type": [ "string", "null" ] }, "message_id": { "type": [ "string", "null" ] }, "in_reply_to": { "type": [ "string", "null" ] }, "is_draft": { "type": "boolean" }, "is_automated": { "type": "boolean" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "deleted_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "ticket_id", "sender_type", "sender_id", "message", "type", "from_email", "to_email", "reply_to", "cc_emails", "mentioned_user_ids", "raw_payload_path", "message_id", "in_reply_to", "is_draft", "is_automated", "created_at", "updated_at", "deleted_at" ], "title": "TicketMessage" }, "TicketPriority": { "type": "string", "enum": [ "low", "medium", "high" ], "title": "TicketPriority" }, "TicketStatus": { "type": "string", "enum": [ "open", "in_progress", "pending", "closed" ], "title": "TicketStatus" }, "User": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "email": { "type": "string" }, "role": { "$ref": "#\/components\/schemas\/UserRole" }, "email_verified_at": { "type": [ "string", "null" ], "format": "date-time" }, "plan_id": { "type": [ "integer", "null" ] }, "max_workspaces": { "type": [ "integer", "null" ] }, "onboarding_completed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "gravatar_url": { "type": "string" } }, "required": [ "id", "name", "email", "role", "email_verified_at", "plan_id", "max_workspaces", "onboarding_completed_at", "created_at", "updated_at", "gravatar_url" ], "title": "User" }, "UserRole": { "type": "string", "enum": [ "admin", "customer" ], "title": "UserRole" }, "Workspace": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "slug": { "type": "string" }, "created_by": { "type": [ "integer", "null" ] }, "plan_id": { "type": [ "integer", "null" ] }, "max_members": { "type": [ "integer", "null" ] }, "max_emails": { "type": [ "integer", "null" ] }, "max_domains": { "type": [ "integer", "null" ] }, "max_contacts": { "type": [ "integer", "null" ] }, "max_tags": { "type": [ "integer", "null" ] }, "max_canned_responses": { "type": [ "integer", "null" ] }, "max_storage_mb": { "type": [ "integer", "null" ] }, "max_webhooks": { "type": [ "integer", "null" ] }, "max_automations": { "type": [ "integer", "null" ] }, "tickets_enabled": { "type": "boolean" }, "shared_inbox_enabled": { "type": "boolean" }, "personal_inbox_enabled": { "type": "boolean" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "has_sendable_inbox_email": { "type": "string" } }, "required": [ "id", "name", "slug", "created_by", "plan_id", "max_members", "max_emails", "max_domains", "max_contacts", "max_tags", "max_canned_responses", "max_storage_mb", "max_webhooks", "max_automations", "tickets_enabled", "shared_inbox_enabled", "personal_inbox_enabled", "created_at", "updated_at", "has_sendable_inbox_email" ], "title": "Workspace" }, "WorkspaceDomain": { "type": "object", "properties": { "id": { "type": "integer" }, "workspace_id": { "type": "integer" }, "domain": { "type": "string" }, "mx_verified": { "type": "boolean" }, "send_verified": { "type": "boolean" }, "mailgun_route_id": { "type": [ "string", "null" ] }, "verification_token": { "type": [ "string", "null" ] }, "verified_at": { "type": [ "string", "null" ], "format": "date-time" }, "ownership_verified_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "workspace_id", "domain", "mx_verified", "send_verified", "mailgun_route_id", "verification_token", "verified_at", "ownership_verified_at", "created_at", "updated_at" ], "title": "WorkspaceDomain" }, "WorkspaceEmail": { "type": "object", "properties": { "id": { "type": "integer" }, "workspace_id": { "type": "integer" }, "workspace_domain_id": { "type": [ "integer", "null" ] }, "user_id": { "type": [ "integer", "null" ] }, "email": { "type": "string" }, "purpose": { "$ref": "#\/components\/schemas\/EmailPurpose" }, "receive_method": { "$ref": "#\/components\/schemas\/ReceiveMethod" }, "sender_name": { "type": [ "string", "null" ] }, "can_send": { "type": "boolean" }, "forwarding_address": { "type": [ "string", "null" ] }, "incoming_email_count": { "type": "integer" }, "outgoing_email_count": { "type": "integer" }, "last_email_received_at": { "type": [ "string", "null" ] }, "last_email_sent_at": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "can_send_resolved": { "type": "string" }, "can_receive_resolved": { "type": "string" } }, "required": [ "id", "workspace_id", "workspace_domain_id", "user_id", "email", "purpose", "receive_method", "sender_name", "can_send", "forwarding_address", "incoming_email_count", "outgoing_email_count", "last_email_received_at", "last_email_sent_at", "created_at", "updated_at", "can_send_resolved", "can_receive_resolved" ], "title": "WorkspaceEmail" }, "WorkspaceInvitation": { "type": "object", "properties": { "id": { "type": "integer" }, "workspace_id": { "type": "integer" }, "invited_by": { "type": "integer" }, "email": { "type": "string" }, "role": { "type": "string" }, "status": { "type": "string" }, "expires_at": { "type": "string", "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id", "workspace_id", "invited_by", "email", "role", "status", "expires_at", "created_at", "updated_at" ], "title": "WorkspaceInvitation" } }, "responses": { "ModelNotFoundException": { "description": "Not found", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } }, "AuthorizationException": { "description": "Authorization error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } }, "ValidationException": { "description": "Validation error", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Errors overview." }, "errors": { "type": "object", "description": "A detailed description of each field that failed validation.", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "required": [ "message", "errors" ] } } } }, "AuthenticationException": { "description": "Unauthenticated", "content": { "application\/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Error overview." } }, "required": [ "message" ] } } } } } } }