openapi: 3.2.0 info: title: Explorer Workspace API description: The entire API V2 documentation is interactive and can be tested here. To the right side of every endpoint you will see a box with an example request. You can click on the "Try it" button to send a request to the server right from the docs. You will need to provide an API key by clicking the `ApiKeyAuth_token` blue text. version: 2.0.0 servers: - url: https://api.instantly.ai description: Instantly API Server security: - ApiKeyAuth: [] tags: - name: Workspace description: A workspace entity representing a workspace x-group: Workspace paths: /api/v2/workspaces/current: get: operationId: getWorkspace summary: Get workspace tags: - Workspace description: 'Get your current workspace details. Note that this endpoint doesn''t require any parameters. It will return the workspace based on the API key sent in the headers. Requires one of the following scopes: `workspaces:read`, `workspaces:all`, `all:read`, `all:all`' responses: '200': description: The requested Workspace content: application/json: schema: $ref: '#/components/schemas/Workspace' '401': description: This request is unauthorized (either the Authorization header is missing or invalid, or the API key has been revoked) content: application/json: schema: type: object properties: statusCode: type: number enum: - 401 examples: - 401 example: 401 error: type: string enum: - Unauthorized examples: - Unauthorized example: Unauthorized message: type: string examples: - Missing Authorization header example: Missing Authorization header required: - statusCode - error - message '402': description: This request cannot be fulfilled because the workspace does not have an active paid plan content: application/json: schema: type: object properties: statusCode: type: number enum: - 402 examples: - 402 example: 402 error: type: string enum: - Payment Required examples: - Payment Required example: Payment Required message: type: string examples: - Workspace does not have an active paid plan example: Workspace does not have an active paid plan required: - statusCode - error - message '404': description: The requested resource was not found content: application/json: schema: type: object properties: statusCode: type: number enum: - 404 examples: - 404 example: 404 error: type: string enum: - Not Found examples: - Not Found example: Not Found message: type: string examples: - Resource not found example: Resource not found required: - statusCode - error - message '429': description: You have exceeded the rate limit. Please check the rate limit docs for more information. content: application/json: schema: type: object properties: statusCode: type: number enum: - 429 examples: - 429 example: 429 error: type: string enum: - Too Many Requests examples: - Too Many Requests example: Too Many Requests message: type: string examples: - Rate limit exceeded example: Rate limit exceeded required: - statusCode - error - message patch: operationId: patchWorkspace summary: Patch workspace tags: - Workspace description: 'Update your current workspace details. Note that this endpoint doesn''t require any parameters. It will update the workspace based on the API key sent in the headers. Requires one of the following scopes: `workspaces:update`, `workspaces:all`, `all:update`, `all:all`' requestBody: content: application/json: schema: type: object properties: name: type: string description: Name of the workspace example: My Workspace org_logo_url: type: - string - 'null' description: URL to workspace logo example: https://example.com/logo.png required: [] additionalProperties: false minProperties: 1 responses: '200': description: The updated Workspace content: application/json: schema: $ref: '#/components/schemas/Workspace' '401': description: This request is unauthorized (either the Authorization header is missing or invalid, or the API key has been revoked) content: application/json: schema: type: object properties: statusCode: type: number enum: - 401 examples: - 401 example: 401 error: type: string enum: - Unauthorized examples: - Unauthorized example: Unauthorized message: type: string examples: - Missing Authorization header example: Missing Authorization header required: - statusCode - error - message '402': description: This request cannot be fulfilled because the workspace does not have an active paid plan content: application/json: schema: type: object properties: statusCode: type: number enum: - 402 examples: - 402 example: 402 error: type: string enum: - Payment Required examples: - Payment Required example: Payment Required message: type: string examples: - Workspace does not have an active paid plan example: Workspace does not have an active paid plan required: - statusCode - error - message '404': description: The requested resource was not found content: application/json: schema: type: object properties: statusCode: type: number enum: - 404 examples: - 404 example: 404 error: type: string enum: - Not Found examples: - Not Found example: Not Found message: type: string examples: - Resource not found example: Resource not found required: - statusCode - error - message '429': description: You have exceeded the rate limit. Please check the rate limit docs for more information. content: application/json: schema: type: object properties: statusCode: type: number enum: - 429 examples: - 429 example: 429 error: type: string enum: - Too Many Requests examples: - Too Many Requests example: Too Many Requests message: type: string examples: - Rate limit exceeded example: Rate limit exceeded required: - statusCode - error - message /api/v2/workspaces/current/schedule-for-removal: post: operationId: scheduleCurrentWorkspaceRemoval summary: Schedule Current Workspace Removal tags: - Workspace description: 'Schedule the current workspace to be removed in 24 hours. Requires one of the following scopes: `workspaces:delete`, `workspaces:all`, `all:delete`, `all:all`' responses: '200': description: The requested Workspace content: application/json: schema: $ref: '#/components/schemas/Workspace' '401': description: This request is unauthorized (either the Authorization header is missing or invalid, or the API key has been revoked) content: application/json: schema: type: object properties: statusCode: type: number enum: - 401 examples: - 401 example: 401 error: type: string enum: - Unauthorized examples: - Unauthorized example: Unauthorized message: type: string examples: - Missing Authorization header example: Missing Authorization header required: - statusCode - error - message '402': description: This request cannot be fulfilled because the workspace does not have an active paid plan content: application/json: schema: type: object properties: statusCode: type: number enum: - 402 examples: - 402 example: 402 error: type: string enum: - Payment Required examples: - Payment Required example: Payment Required message: type: string examples: - Workspace does not have an active paid plan example: Workspace does not have an active paid plan required: - statusCode - error - message '404': description: The requested resource was not found content: application/json: schema: type: object properties: statusCode: type: number enum: - 404 examples: - 404 example: 404 error: type: string enum: - Not Found examples: - Not Found example: Not Found message: type: string examples: - Resource not found example: Resource not found required: - statusCode - error - message '429': description: You have exceeded the rate limit. Please check the rate limit docs for more information. content: application/json: schema: type: object properties: statusCode: type: number enum: - 429 examples: - 429 example: 429 error: type: string enum: - Too Many Requests examples: - Too Many Requests example: Too Many Requests message: type: string examples: - Rate limit exceeded example: Rate limit exceeded required: - statusCode - error - message delete: operationId: cancelCurrentWorkspaceRemoval summary: Cancel Current Workspace Removal tags: - Workspace description: 'Requires one of the following scopes: `workspaces:delete`, `workspaces:all`, `all:delete`, `all:all`' responses: '200': description: The requested Workspace content: application/json: schema: $ref: '#/components/schemas/Workspace' '401': description: This request is unauthorized (either the Authorization header is missing or invalid, or the API key has been revoked) content: application/json: schema: type: object properties: statusCode: type: number enum: - 401 examples: - 401 example: 401 error: type: string enum: - Unauthorized examples: - Unauthorized example: Unauthorized message: type: string examples: - Missing Authorization header example: Missing Authorization header required: - statusCode - error - message '402': description: This request cannot be fulfilled because the workspace does not have an active paid plan content: application/json: schema: type: object properties: statusCode: type: number enum: - 402 examples: - 402 example: 402 error: type: string enum: - Payment Required examples: - Payment Required example: Payment Required message: type: string examples: - Workspace does not have an active paid plan example: Workspace does not have an active paid plan required: - statusCode - error - message '404': description: The requested resource was not found content: application/json: schema: type: object properties: statusCode: type: number enum: - 404 examples: - 404 example: 404 error: type: string enum: - Not Found examples: - Not Found example: Not Found message: type: string examples: - Resource not found example: Resource not found required: - statusCode - error - message '429': description: You have exceeded the rate limit. Please check the rate limit docs for more information. content: application/json: schema: type: object properties: statusCode: type: number enum: - 429 examples: - 429 example: 429 error: type: string enum: - Too Many Requests examples: - Too Many Requests example: Too Many Requests message: type: string examples: - Rate limit exceeded example: Rate limit exceeded required: - statusCode - error - message /api/v2/workspaces/current/whitelabel-domain: post: operationId: addWorkspaceAgencyDomain summary: Set the agency domain for the workspace tags: - Workspace description: 'Requires one of the following scopes: `workspaces:update`, `workspaces:all`, `all:update`, `all:all`' requestBody: content: application/json: schema: type: object properties: domain: type: string description: The agency domain to set for the workspace example: agency.example.com required: - domain required: true responses: '200': description: The requested Workspace content: application/json: schema: $ref: '#/components/schemas/Workspace' '401': description: This request is unauthorized (either the Authorization header is missing or invalid, or the API key has been revoked) content: application/json: schema: type: object properties: statusCode: type: number enum: - 401 examples: - 401 example: 401 error: type: string enum: - Unauthorized examples: - Unauthorized example: Unauthorized message: type: string examples: - Missing Authorization header example: Missing Authorization header required: - statusCode - error - message '402': description: This request cannot be fulfilled because the workspace does not have an active paid plan content: application/json: schema: type: object properties: statusCode: type: number enum: - 402 examples: - 402 example: 402 error: type: string enum: - Payment Required examples: - Payment Required example: Payment Required message: type: string examples: - Workspace does not have an active paid plan example: Workspace does not have an active paid plan required: - statusCode - error - message '404': description: The requested resource was not found content: application/json: schema: type: object properties: statusCode: type: number enum: - 404 examples: - 404 example: 404 error: type: string enum: - Not Found examples: - Not Found example: Not Found message: type: string examples: - Resource not found example: Resource not found required: - statusCode - error - message '429': description: You have exceeded the rate limit. Please check the rate limit docs for more information. content: application/json: schema: type: object properties: statusCode: type: number enum: - 429 examples: - 429 example: 429 error: type: string enum: - Too Many Requests examples: - Too Many Requests example: Too Many Requests message: type: string examples: - Rate limit exceeded example: Rate limit exceeded required: - statusCode - error - message get: operationId: getWorkspaceDomainInfo summary: Get organization verified agency domain information tags: - Workspace description: 'Requires one of the following scopes: `workspaces:read`, `workspaces:all`, `all:read`, `all:all`' responses: '200': description: Default Response content: application/json: schema: type: object properties: verified: type: boolean description: Whether the domain is verified example: true name: type: string description: The domain name example: example.com verification: type: array items: type: object properties: type: type: string description: The verification type example: TXT domain: type: string description: The domain name example: example.com value: type: string description: The verification value example: vercel-challenge=xyz123 reason: type: string description: The reason for the verification example: TXT record required for domain verification '401': description: This request is unauthorized (either the Authorization header is missing or invalid, or the API key has been revoked) content: application/json: schema: type: object properties: statusCode: type: number enum: - 401 examples: - 401 example: 401 error: type: string enum: - Unauthorized examples: - Unauthorized example: Unauthorized message: type: string examples: - Missing Authorization header example: Missing Authorization header required: - statusCode - error - message '402': description: This request cannot be fulfilled because the workspace does not have an active paid plan content: application/json: schema: type: object properties: statusCode: type: number enum: - 402 examples: - 402 example: 402 error: type: string enum: - Payment Required examples: - Payment Required example: Payment Required message: type: string examples: - Workspace does not have an active paid plan example: Workspace does not have an active paid plan required: - statusCode - error - message '404': description: The requested resource was not found content: application/json: schema: type: object properties: statusCode: type: number enum: - 404 examples: - 404 example: 404 error: type: string enum: - Not Found examples: - Not Found example: Not Found message: type: string examples: - Resource not found example: Resource not found required: - statusCode - error - message '429': description: You have exceeded the rate limit. Please check the rate limit docs for more information. content: application/json: schema: type: object properties: statusCode: type: number enum: - 429 examples: - 429 example: 429 error: type: string enum: - Too Many Requests examples: - Too Many Requests example: Too Many Requests message: type: string examples: - Rate limit exceeded example: Rate limit exceeded required: - statusCode - error - message delete: operationId: deleteWorkspaceDomain summary: Delete organization agency domain tags: - Workspace description: 'Requires one of the following scopes: `workspaces:update`, `workspaces:all`, `all:update`, `all:all`' responses: '200': description: The requested Workspace content: application/json: schema: $ref: '#/components/schemas/Workspace' '401': description: This request is unauthorized (either the Authorization header is missing or invalid, or the API key has been revoked) content: application/json: schema: type: object properties: statusCode: type: number enum: - 401 examples: - 401 example: 401 error: type: string enum: - Unauthorized examples: - Unauthorized example: Unauthorized message: type: string examples: - Missing Authorization header example: Missing Authorization header required: - statusCode - error - message '402': description: This request cannot be fulfilled because the workspace does not have an active paid plan content: application/json: schema: type: object properties: statusCode: type: number enum: - 402 examples: - 402 example: 402 error: type: string enum: - Payment Required examples: - Payment Required example: Payment Required message: type: string examples: - Workspace does not have an active paid plan example: Workspace does not have an active paid plan required: - statusCode - error - message '404': description: The requested resource was not found content: application/json: schema: type: object properties: statusCode: type: number enum: - 404 examples: - 404 example: 404 error: type: string enum: - Not Found examples: - Not Found example: Not Found message: type: string examples: - Resource not found example: Resource not found required: - statusCode - error - message '429': description: You have exceeded the rate limit. Please check the rate limit docs for more information. content: application/json: schema: type: object properties: statusCode: type: number enum: - 429 examples: - 429 example: 429 error: type: string enum: - Too Many Requests examples: - Too Many Requests example: Too Many Requests message: type: string examples: - Rate limit exceeded example: Rate limit exceeded required: - statusCode - error - message /api/v2/workspaces/current/change-owner: post: operationId: changeWorkspaceOwner summary: Change workspace owner tags: - Workspace description: 'Requires one of the following scopes: `workspaces:update`, `workspaces:all`, `all:update`, `all:all`' requestBody: content: application/json: schema: type: object properties: email: type: string format: email example: user@example.com sec: type: string example: SECRET_TOKEN required: - email - sec required: true responses: '200': description: The requested Workspace content: application/json: schema: $ref: '#/components/schemas/Workspace' '401': description: This request is unauthorized (either the Authorization header is missing or invalid, or the API key has been revoked) content: application/json: schema: type: object properties: statusCode: type: number enum: - 401 examples: - 401 example: 401 error: type: string enum: - Unauthorized examples: - Unauthorized example: Unauthorized message: type: string examples: - Missing Authorization header example: Missing Authorization header required: - statusCode - error - message '402': description: This request cannot be fulfilled because the workspace does not have an active paid plan content: application/json: schema: type: object properties: statusCode: type: number enum: - 402 examples: - 402 example: 402 error: type: string enum: - Payment Required examples: - Payment Required example: Payment Required message: type: string examples: - Workspace does not have an active paid plan example: Workspace does not have an active paid plan required: - statusCode - error - message '404': description: The requested resource was not found content: application/json: schema: type: object properties: statusCode: type: number enum: - 404 examples: - 404 example: 404 error: type: string enum: - Not Found examples: - Not Found example: Not Found message: type: string examples: - Resource not found example: Resource not found required: - statusCode - error - message '429': description: You have exceeded the rate limit. Please check the rate limit docs for more information. content: application/json: schema: type: object properties: statusCode: type: number enum: - 429 examples: - 429 example: 429 error: type: string enum: - Too Many Requests examples: - Too Many Requests example: Too Many Requests message: type: string examples: - Rate limit exceeded example: Rate limit exceeded required: - statusCode - error - message components: schemas: Workspace: title: Workspace description: A workspace entity representing a workspace x-tags: - Schemas - Workspace type: object properties: id: type: string description: Unique identifier for the workspace readOnly: true format: uuid example: 019ffad2-5cac-7fb9-a336-43df778ad26c timestamp_created: type: string description: Timestamp when the workspace was created readOnly: true format: date-time example: '2026-08-13T11:11:58.124Z' timestamp_updated: type: string description: Timestamp when the workspace was last updated readOnly: true format: date-time example: '2026-08-13T11:11:58.124Z' scheduled_for_removal_at: type: - 'null' - string description: Timestamp when this workspace is scheduled to be removed readOnly: true format: date-time example: '2026-08-13T11:11:58.124Z' owner: type: string description: User ID of the workspace owner readOnly: true format: uuid example: 019ffad2-5cac-7fb9-a336-43e00eee8acc name: type: string description: Name of the workspace example: My Workspace plan_id: type: - 'null' - string description: Plan ID for workspace readOnly: true example: pid_hg_v1 plan_id_bundle: type: - 'null' - string description: Plan ID for workspace bundle readOnly: true example: pid_bundle_scale_v2 add_unsub_to_block: type: - 'null' - boolean description: Whether to add unsubscribes to block list example: false default_opportunity_value: type: - 'null' - number description: Default value for opportunities example: 250 plan_id_leadfinder: type: - 'null' - string description: Plan ID for leadfinder readOnly: true example: pid_lf_ls_v1 plan_id_verification: type: object description: Plan ID for verification service readOnly: true properties: quantity: type: number example: 5 product_id: type: string example: pid_verify_v1_monthly timestamp_updated: type: string format: date-time example: '2024-07-22T05:56:58.667Z' org_logo_url: type: - 'null' - string description: URL to workspace logo example: https://example.com/logo.png org_client_domain: type: - 'null' - string description: The domain for the white label agency mode readOnly: true example: example.com plan_id_crm: type: - 'null' - string description: Plan ID for CRM readOnly: true example: pid_crm_v1 plan_id_website_visitor: type: - 'null' - string description: Plan ID for website visitor tracking readOnly: true example: pid_wvw_v1 plan_id_inbox_placement: type: - 'null' - string description: Plan ID for inbox placement readOnly: true example: pid_ip_v1 required: - id - timestamp_created - timestamp_updated - owner - name additionalProperties: false securitySchemes: ApiKeyAuth: type: http scheme: bearer