{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Firma","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/firma-2c386052/zZQF-ql17YHCcEFj/logo/light.svg?fit=max\u0026auto=format\u0026n=zZQF-ql17YHCcEFj\u0026q=85\u0026s=cddc3619a3422ba9f59fc78eb8b67d13","dark":"https://mintcdn.com/firma-2c386052/zZQF-ql17YHCcEFj/logo/dark.svg?fit=max\u0026auto=format\u0026n=zZQF-ql17YHCcEFj\u0026q=85\u0026s=a897b48eec029f4a09f41c0c8843d2bf"},"favicon":"https://mintcdn.com/firma-2c386052/zZQF-ql17YHCcEFj/favicon.svg?fit=max\u0026auto=format\u0026n=zZQF-ql17YHCcEFj\u0026q=85\u0026s=f25676b802cdcd26f6ad90015ed4bde5","api":{"openapi":["api-reference/openapi.es.json","api-reference/openapi.fr.json","api-reference/openapi.json","api-reference/v01.39.01/openapi-v01.39.01.es.json","api-reference/v01.39.01/openapi-v01.39.01.fr.json","api-reference/v01.39.01/openapi-v01.39.01.json","api-reference/v01.40.00/openapi-v01.40.00.es.json","api-reference/v01.40.00/openapi-v01.40.00.fr.json","api-reference/v01.40.00/openapi-v01.40.00.json","api-reference/v01.40.01/openapi-v01.40.01.es.json","api-reference/v01.40.01/openapi-v01.40.01.fr.json","api-reference/v01.40.01/openapi-v01.40.01.json","api-reference/v01.40.02/openapi-v01.40.02.es.json","api-reference/v01.40.02/openapi-v01.40.02.fr.json","api-reference/v01.40.02/openapi-v01.40.02.json","api-reference/v01.40.04/openapi-v01.40.04.es.json","api-reference/v01.40.04/openapi-v01.40.04.fr.json","api-reference/v01.40.04/openapi-v01.40.04.json","api-reference/v01.43.00/openapi-v01.43.00.es.json","api-reference/v01.43.00/openapi-v01.43.00.fr.json","api-reference/v01.43.00/openapi-v01.43.00.json"]},"navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://app.firma.dev"}},"footer":{},"integrations":{"gtm":{"tagId":"GTM-TG5C83VZ"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","cursor","vscode","assistant","grok","mcp","add-mcp"],"display":"header"},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","href":"guides/complete-setup-guide"},{"language":"es","href":"es/guides/complete-setup-guide"},{"language":"fr","href":"fr/guides/complete-setup-guide"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"firma-2c386052","hasAudioNarration":false,"actualSubdomain":"firma-2c386052","customDomains":["docs.firma.dev"],"gitSource":{"type":"github","owner":"firma-esign","repo":"firma-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afc0195fd13a633a9fdd561","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"en","tag":"API reference","count":124},{"language":"en","tag":"Endpoints","count":124},{"language":"es","tag":"Referencia de API","count":124},{"language":"es","tag":"Endpoints","count":124},{"language":"fr","tag":"Référence API","count":124},{"language":"fr","tag":"Endpoints","count":124},{"language":"en","tag":"Integrations","count":48},{"language":"es","tag":"Integraciones","count":44},{"language":"fr","tag":"Intégrations","count":44},{"language":"en","tag":"Guides","count":27},{"language":"es","tag":"Guías","count":27},{"language":"fr","tag":"Guides","count":27},{"language":"en","tag":"Signing Requests","count":26},{"language":"es","tag":"Solicitudes de Firma","count":26},{"language":"fr","tag":"Demandes de Signature","count":26},{"language":"en","tag":"Email Domains","count":16},{"language":"en","tag":"Templates","count":16},{"language":"en","tag":"Starter guides","count":16},{"language":"es","tag":"Dominios de Correo","count":16},{"language":"es","tag":"Plantillas","count":16},{"language":"es","tag":"Guías de Inicio","count":16},{"language":"fr","tag":"Domaines de Messagerie","count":16},{"language":"fr","tag":"Modèles","count":16},{"language":"fr","tag":"Guides de Démarrage","count":16},{"language":"en","tag":"Advanced guides","count":11},{"language":"es","tag":"Guías avanzadas","count":11},{"language":"fr","tag":"Guides avancés","count":11},{"language":"en","tag":"Custom Fields","count":10},{"language":"es","tag":"Campos Personalizados","count":10},{"language":"fr","tag":"Champs Personnalisés","count":10}],"searchSettings":{"showContentSnippets":true}},"assistantConfig":{"enableStarterQuestions":true,"deflection":{"enabled":true,"email":"support@firma.dev","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[],"starterQuestions":[{"_id":"697bec2a72516805f9aaef63","deploymentId":"68b6b10583bfa572098556ab","questionText":"How do I embed signing in my app?","status":"active","generatedBy":"manual","createdAt":"2026-01-29T23:24:26.887Z","updatedAt":"2026-01-29T23:24:26.887Z","__v":0}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"details.accordion>summary{font-weight:500}details.accordion>summary+div{padding:0.5rem 1.25rem 1.5rem 1.25rem}details.accordion>summary+div>*:first-child{margin-top:0}details.accordion>summary+div li{margin-top:0.375rem;margin-bottom:0.375rem}details.accordion{margin-bottom:1rem}"}]}
{"page":{"pagePath":"api-reference/workspaces/list-workspaces","slug":"/api-reference/workspaces/list-workspaces","pageMetadata":{"openapi":"api-reference/openapi.json get /workspaces","title":"List workspaces","description":"Retrieve a paginated list of workspaces for the authenticated company","href":"/api-reference/workspaces/list-workspaces"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieve a paginated list of workspaces for the authenticated company\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"api-reference/openapi.json get /workspaces","title":"List workspaces","description":"Retrieve a paginated list of workspaces for the authenticated company","href":"/api-reference/workspaces/list-workspaces"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/firma-2c386052/b328df15e0604347/marketing.js"],"openApiReferenceData":{"operation":{"summary":"List workspaces","description":"Retrieve a paginated list of workspaces for the authenticated company","tags":["Workspaces"],"security":["d437c6c4-c86c-4973-aa25-10a81940a414"],"parameters":["e74ff64c-bb29-4f54-8b5d-bd768aca1a96","2fd1ee5c-2b07-4961-8c5c-0168770d1189","6f9f2c5b-7a1f-49ac-82e6-e9d90a00df12","b504d717-d50d-4718-945c-f0b58f3a9857","c301bae6-e68a-4b4b-a8a7-a6103abc0d77","ce17fab7-6608-41e1-9d59-d8e9e1f2edb7","9457e631-74ed-4ce3-81ba-898adc919e66","934e653b-f727-4b1d-a507-72a5201e56f7"],"responses":{"200":"2ec428e9-dc41-494d-bc5f-744f6248d911","400":"db739bc7-82a7-403c-b57e-8f964f010d68","401":"f70b5430-ddba-4882-b302-a9c314953d75","429":"a6619188-8fee-4922-bd45-f6c8e7bded1c"},"operationId":"listWorkspaces","x-codeSamples":[{"lang":"TypeScript","label":"@firma-dev/sdk","source":"import { FirmaClient } from \"@firma-dev/sdk\";\n\nconst firma = new FirmaClient({ apiKey: \"YOUR_API_KEY\" });\n\nconst response = await firma.workspaces.listWorkspaces();\nconsole.log(response);"}],"method":"get","type":"path","servers":["2fbf9adc-9b3f-4071-ad07-d46b0b923201","ff5813a0-6d09-480e-bcba-6f0eb9e1dde4"],"path":"/https/docs.firma.dev/workspaces","baseUrlOptions":["https://api.firma.dev/functions/v1/signing-request-api","https://api.firma.dev/api/v1"],"title":"List workspaces","codeSamples":[{"label":"@firma-dev/sdk","lang":"TypeScript","source":"import { FirmaClient } from \"@firma-dev/sdk\";\n\nconst firma = new FirmaClient({ apiKey: \"YOUR_API_KEY\" });\n\nconst response = await firma.workspaces.listWorkspaces();\nconsole.log(response);"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"e74ff64c-bb29-4f54-8b5d-bd768aca1a96":{"name":"page","in":"query","description":"Page number for pagination","schema":{"type":"integer","minimum":1,"default":1,"description":"Page number for pagination","uniqueKey":"","typeLabel":"integer"}},"2fd1ee5c-2b07-4961-8c5c-0168770d1189":{"name":"page_size","in":"query","description":"Number of items per page","schema":{"type":"integer","minimum":1,"maximum":200,"default":50,"description":"Number of items per page","uniqueKey":"","typeLabel":"integer"}},"6f9f2c5b-7a1f-49ac-82e6-e9d90a00df12":{"name":"name","in":"query","schema":{"type":"string","description":"Filter by workspace name (partial match, case-insensitive)","uniqueKey":"","typeLabel":"string"},"description":"Filter by workspace name (partial match, case-insensitive)"},"b504d717-d50d-4718-945c-f0b58f3a9857":{"name":"protected","in":"query","schema":{"type":"string","enum":["0","1","true","false"],"description":"Filter by protected status","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Filter by protected status"},"c301bae6-e68a-4b4b-a8a7-a6103abc0d77":{"name":"created_after","in":"query","schema":{"type":"string","format":"date-time","description":"Filter workspaces created after this date (ISO 8601 format)","uniqueKey":"","typeLabel":"string\u003cdate-time>"},"description":"Filter workspaces created after this date (ISO 8601 format)"},"ce17fab7-6608-41e1-9d59-d8e9e1f2edb7":{"name":"created_before","in":"query","schema":{"type":"string","format":"date-time","description":"Filter workspaces created before this date (ISO 8601 format)","uniqueKey":"","typeLabel":"string\u003cdate-time>"},"description":"Filter workspaces created before this date (ISO 8601 format)"},"9457e631-74ed-4ce3-81ba-898adc919e66":{"name":"sort_by","in":"query","schema":{"type":"string","enum":["name","protected","created_on"],"default":"created_on","description":"Field to sort by","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Field to sort by"},"934e653b-f727-4b1d-a507-72a5201e56f7":{"name":"sort_order","in":"query","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort order","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Sort order"}},"responses":{"2ec428e9-dc41-494d-bc5f-744f6248d911":{"description":"Workspaces retrieved successfully","headers":{"X-RateLimit-Limit":{"schema":{"type":"integer"},"description":"Rate limit: 200 requests per minute"},"X-RateLimit-Remaining":{"schema":{"type":"integer"},"description":"Remaining requests in current window"},"X-RateLimit-Reset":{"schema":{"type":"integer"},"description":"Unix timestamp when rate limit resets"}},"content":{"application/json":{"schema":{"type":"object","description":"Paginated list of workspaces","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the workspace","isRequired":true,"uniqueKey":"results.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Workspace name","maxLength":255,"isRequired":true,"uniqueKey":"results.items.[INDEX].name","typeLabel":"string"},"created_date":{"type":"string","format":"date-time","description":"Workspace creation timestamp","isRequired":true,"uniqueKey":"results.items.[INDEX].created_date","typeLabel":"string\u003cdate-time>"},"protected":{"type":"boolean","description":"Protected workspaces cannot be deleted","uniqueKey":"results.items.[INDEX].protected","typeLabel":"boolean"},"api_key":{"oneOf":[{"type":"string","description":"Live-mode API key for this workspace. Used for authenticating API requests scoped to this workspace.","uniqueKey":"results.items.[INDEX].api_key.oneOf.0","typeLabel":"string"},{"type":"null","description":"Live-mode API key for this workspace. Used for authenticating API requests scoped to this workspace.","uniqueKey":"results.items.[INDEX].api_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].api_key","typeLabel":"string | null"},"test_api_key":{"oneOf":[{"type":"string","description":"Test-mode API key for this workspace. Requests authenticated with this key do not consume credits and produce test-flagged, watermarked signing requests.","uniqueKey":"results.items.[INDEX].test_api_key.oneOf.0","typeLabel":"string"},{"type":"null","description":"Test-mode API key for this workspace. Requests authenticated with this key do not consume credits and produce test-flagged, watermarked signing requests.","uniqueKey":"results.items.[INDEX].test_api_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].test_api_key","typeLabel":"string | null"},"updated_date":{"type":"string","format":"date-time","description":"Workspace last update timestamp","uniqueKey":"results.items.[INDEX].updated_date","typeLabel":"string\u003cdate-time>"},"webhook_enabled":{"type":"boolean","description":"Whether workspace-level webhooks are enabled","uniqueKey":"results.items.[INDEX].webhook_enabled","typeLabel":"boolean"},"webhook_secret":{"oneOf":[{"type":"string","description":"Webhook signing secret for this workspace","uniqueKey":"results.items.[INDEX].webhook_secret.oneOf.0","typeLabel":"string"},{"type":"null","description":"Webhook signing secret for this workspace","uniqueKey":"results.items.[INDEX].webhook_secret.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].webhook_secret","typeLabel":"string | null"},"webhook_secret_rotated_at":{"oneOf":[{"type":"string","format":"date-time","description":"Timestamp of the last webhook secret rotation","uniqueKey":"results.items.[INDEX].webhook_secret_rotated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Timestamp of the last webhook secret rotation","uniqueKey":"results.items.[INDEX].webhook_secret_rotated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].webhook_secret_rotated_at","typeLabel":"string\u003cdate-time> | null"},"webhook_secret_created_at":{"oneOf":[{"type":"string","format":"date-time","description":"Timestamp when the webhook secret was first created","uniqueKey":"results.items.[INDEX].webhook_secret_created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Timestamp when the webhook secret was first created","uniqueKey":"results.items.[INDEX].webhook_secret_created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].webhook_secret_created_at","typeLabel":"string\u003cdate-time> | null"},"ignore_company_webhooks":{"type":"boolean","description":"When true, company-level webhooks do not fire for events in this workspace","uniqueKey":"results.items.[INDEX].ignore_company_webhooks","typeLabel":"boolean"},"icon_url":{"oneOf":[{"type":"string","format":"uri","description":"Publicly accessible URL to the workspace logo image. Returns the workspace-specific logo, or null if not set (company logo is NOT included as fallback in this field).","example":"https://ielmshcswdhuacyjlpiy.supabase.co/functions/v1/logo/workspace/company-id/workspace-id","uniqueKey":"results.items.[INDEX].icon_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Publicly accessible URL to the workspace logo image. Returns the workspace-specific logo, or null if not set (company logo is NOT included as fallback in this field).","example":"https://ielmshcswdhuacyjlpiy.supabase.co/functions/v1/logo/workspace/company-id/workspace-id","uniqueKey":"results.items.[INDEX].icon_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].icon_url","typeLabel":"string\u003curi> | null"}},"required":["id","name","created_date"],"uniqueKey":"results.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"results","typeLabel":"object[]"},"pagination":{"type":"object","properties":{"current_page":{"type":"integer","isRequired":true,"uniqueKey":"pagination.current_page","typeLabel":"integer"},"page_size":{"type":"integer","isRequired":true,"uniqueKey":"pagination.page_size","typeLabel":"integer"},"total_count":{"type":"integer","isRequired":true,"uniqueKey":"pagination.total_count","typeLabel":"integer"},"total_pages":{"type":"integer","isRequired":true,"uniqueKey":"pagination.total_pages","typeLabel":"integer"}},"description":"Pagination metadata for list responses","required":["current_page","page_size","total_count","total_pages"],"isRequired":true,"uniqueKey":"pagination","typeLabel":"object"}},"required":["results","pagination"],"uniqueKey":"","typeLabel":"object"},"example":{"results":[{"id":"789e4567-e89b-12d3-a456-426614174000","name":"Sales Workspace","protected":false,"api_key":"fk_a1b2c3d4e5f6g7h8i9j0","created_date":"2024-01-20T09:00:00Z","updated_date":"2024-01-20T09:00:00Z"},{"id":"456e4567-e89b-12d3-a456-426614174000","name":"Default Workspace","protected":true,"api_key":"fk_z9y8x7w6v5u4t3s2r1q0","created_date":"2024-01-15T10:30:00Z","updated_date":"2024-01-15T10:30:00Z"}],"pagination":{"current_page":1,"page_size":20,"total_count":2,"total_pages":1}},"examples":{"Example":{"title":"Example","value":{"results":[{"id":"789e4567-e89b-12d3-a456-426614174000","name":"Sales Workspace","protected":false,"api_key":"fk_a1b2c3d4e5f6g7h8i9j0","created_date":"2024-01-20T09:00:00Z","updated_date":"2024-01-20T09:00:00Z"},{"id":"456e4567-e89b-12d3-a456-426614174000","name":"Default Workspace","protected":true,"api_key":"fk_z9y8x7w6v5u4t3s2r1q0","created_date":"2024-01-15T10:30:00Z","updated_date":"2024-01-15T10:30:00Z"}],"pagination":{"current_page":1,"page_size":20,"total_count":2,"total_pages":1}}}},"exampleType":"examples"}},"exampleType":"examples"},"db739bc7-82a7-403c-b57e-8f964f010d68":{"description":"Validation error - invalid date format or sort parameters","content":{"application/json":{"examples":{"invalidDate":{"title":"invalidDate","summary":"Invalid date format","value":{"error":"Validation failed","code":"VALIDATION_ERROR","details":[{"path":["created_after"],"message":"created_after must be a valid ISO 8601 date"}]}},"invalidSort":{"title":"invalidSort","summary":"Invalid sort parameter","value":{"error":"Validation failed","code":"VALIDATION_ERROR","details":[{"path":["sort_order"],"message":"sort_order must be either 'asc' or 'desc'"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"f70b5430-ddba-4882-b302-a9c314953d75":{"description":"Unauthorized - Invalid or missing API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code Seal-related codes: SEALS_DISABLED, SEAL_ALREADY_REVOKED, SEAL_CREATION_DISABLED_EDGE, SEAL_ERASE_NOT_ELIGIBLE, SEAL_IMAGE_INVALID, SEAL_MUTATION_NOT_ALLOWED, SEAL_NOT_FOUND, SEAL_NO_IMAGE_FIELD, SEAL_ORDER_COLLISION, SEAL_PAUSED, SEAL_SCOPE_FORBIDDEN, SEAL_UNAVAILABLE Multi-document codes: see MultiDocumentErrorCode (41 codes).","uniqueKey":"code","typeLabel":"string"},"errors":{"type":"array","description":"All validation errors when multiple failures are reported together. The top-level error repeats the first item for backward compatibility.","items":{"type":"object","required":["message"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"message":{"type":"string","description":"Detailed error description","uniqueKey":"message","typeLabel":"string"},"details":{"type":"object","description":"Additional error details","additionalProperties":true,"uniqueKey":"details","typeLabel":"object"}},"required":["error"],"description":"\n\nOrganization Seal error codes: SEALS_DISABLED, SEAL_ALREADY_REVOKED, SEAL_CREATION_DISABLED_EDGE, SEAL_ERASE_NOT_ELIGIBLE, SEAL_IMAGE_INVALID, SEAL_MUTATION_NOT_ALLOWED, SEAL_NOT_FOUND, SEAL_NO_IMAGE_FIELD, SEAL_ORDER_COLLISION, SEAL_PAUSED, SEAL_SCOPE_FORBIDDEN, SEAL_UNAVAILABLE","uniqueKey":"","typeLabel":"object"},"example":{"error":"Unauthorized","message":"Invalid API key"},"examples":{"Example":{"title":"Example","value":{"error":"Unauthorized","message":"Invalid API key"}}},"exampleType":"examples"}},"exampleType":"examples"},"a6619188-8fee-4922-bd45-f6c8e7bded1c":{"description":"Too Many Requests - Rate limit exceeded","headers":{"X-RateLimit-Limit":{"schema":{"type":"integer"},"description":"Maximum requests per minute"},"X-RateLimit-Remaining":{"schema":{"type":"integer"},"description":"Requests remaining"},"X-RateLimit-Reset":{"schema":{"type":"integer"},"description":"Unix timestamp of reset"},"Retry-After":{"schema":{"type":"integer"},"description":"Seconds until retry allowed"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code Seal-related codes: SEALS_DISABLED, SEAL_ALREADY_REVOKED, SEAL_CREATION_DISABLED_EDGE, SEAL_ERASE_NOT_ELIGIBLE, SEAL_IMAGE_INVALID, SEAL_MUTATION_NOT_ALLOWED, SEAL_NOT_FOUND, SEAL_NO_IMAGE_FIELD, SEAL_ORDER_COLLISION, SEAL_PAUSED, SEAL_SCOPE_FORBIDDEN, SEAL_UNAVAILABLE Multi-document codes: see MultiDocumentErrorCode (41 codes).","uniqueKey":"code","typeLabel":"string"},"errors":{"type":"array","description":"All validation errors when multiple failures are reported together. The top-level error repeats the first item for backward compatibility.","items":{"type":"object","required":["message"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"message":{"type":"string","description":"Detailed error description","uniqueKey":"message","typeLabel":"string"},"details":{"type":"object","description":"Additional error details","additionalProperties":true,"uniqueKey":"details","typeLabel":"object"}},"required":["error"],"description":"\n\nOrganization Seal error codes: SEALS_DISABLED, SEAL_ALREADY_REVOKED, SEAL_CREATION_DISABLED_EDGE, SEAL_ERASE_NOT_ELIGIBLE, SEAL_IMAGE_INVALID, SEAL_MUTATION_NOT_ALLOWED, SEAL_NOT_FOUND, SEAL_NO_IMAGE_FIELD, SEAL_ORDER_COLLISION, SEAL_PAUSED, SEAL_SCOPE_FORBIDDEN, SEAL_UNAVAILABLE","uniqueKey":"","typeLabel":"object"},"example":{"error":"Rate Limit Exceeded","message":"Too many requests. Please wait before retrying.","details":{"retry_after":45}},"examples":{"Example":{"title":"Example","value":{"error":"Rate Limit Exceeded","message":"Too many requests. Please wait before retrying.","details":{"retry_after":45}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"d437c6c4-c86c-4973-aa25-10a81940a414":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"2fbf9adc-9b3f-4071-ad07-d46b0b923201":{"url":"https://api.firma.dev/functions/v1/signing-request-api","description":"Production API - Recommended (Current)"},"ff5813a0-6d09-480e-bcba-6f0eb9e1dde4":{"url":"https://api.firma.dev/api/v1","description":"Production API - Planned"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"Authorization","type":"string","description":"API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"firma-2c386052","siteName":"Firma","title":"List workspaces - Firma","navMaps":{"firstHrefInVersion":{"v1.43.0 (latest)":{"href":"/api-reference/workspaces/list-workspaces","matchLevel":0},"v1.40.4":{"href":"/api-reference/v01.40.04/workspaces/list-workspaces","matchLevel":2},"v1.40.2":{"href":"/api-reference/v01.40.02/workspaces/list-workspaces","matchLevel":2},"v1.40.1":{"href":"/api-reference/v01.40.01/workspaces/list-workspaces","matchLevel":2},"v1.40.0":{"href":"/api-reference/v01.40.00/workspaces/list-workspaces","matchLevel":2},"v1.39.1":{"href":"/api-reference/v01.39.01/workspaces/list-workspaces","matchLevel":2}},"firstHrefInLanguage":{"en":{"href":"/api-reference/workspaces/list-workspaces","matchLevel":0},"es":{"href":"/es/api-reference/workspaces/list-workspaces","matchLevel":1},"fr":{"href":"/fr/api-reference/workspaces/list-workspaces","matchLevel":1}}},"lastModified":"2026-10-28T14:02:49.244Z","originalFileLocation":"api-reference/workspaces/list-workspaces.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieve a paginated list of workspaces for the authenticated company\">\u003cmeta data-mint-head name=\"application-name\" content=\"Firma\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/firma-2c386052/jG6CfhCb7WGzrNdj/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/firma-2c386052/jG6CfhCb7WGzrNdj/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/firma-2c386052/jG6CfhCb7WGzrNdj/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/firma-2c386052/jG6CfhCb7WGzrNdj/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/firma-2c386052/jG6CfhCb7WGzrNdj/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/firma-2c386052/jG6CfhCb7WGzrNdj/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/firma-2c386052/jG6CfhCb7WGzrNdj/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/firma-2c386052/jG6CfhCb7WGzrNdj/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/firma-2c386052/jG6CfhCb7WGzrNdj/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List workspaces - Firma\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve a paginated list of workspaces for the authenticated company\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Firma\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.firma.dev/api-reference/workspaces/list-workspaces\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://firma-2c386052.mintlify.site/_mintlify/api/og/v2?division=Workspaces\u0026amp;title=List+workspaces\u0026amp;description=Retrieve+a+paginated+list+of+workspaces+for+the+authenticated+company\u0026amp;theme=7da90c899f217e3fe5013973\u0026amp;signature=4c0ca4112e44899069a3a13edc610a6aa40b40a364bfdcb0e2297aa48ecbddac\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List workspaces - Firma\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve a paginated list of workspaces for the authenticated company\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://firma-2c386052.mintlify.site/_mintlify/api/og/v2?division=Workspaces\u0026amp;title=List+workspaces\u0026amp;description=Retrieve+a+paginated+list+of+workspaces+for+the+authenticated+company\u0026amp;theme=7da90c899f217e3fe5013973\u0026amp;signature=4c0ca4112e44899069a3a13edc610a6aa40b40a364bfdcb0e2297aa48ecbddac\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/firma-2c386052/jG6CfhCb7WGzrNdj/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Firma\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.firma.dev/api-reference/workspaces/list-workspaces\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/workspaces/list-workspaces.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.firma.dev/api-reference/workspaces/list-workspaces\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://docs.firma.dev/es/api-reference/workspaces/list-workspaces\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.firma.dev/fr/api-reference/workspaces/list-workspaces\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.firma.dev/api-reference/workspaces/list-workspaces\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.firma.dev/#organization\",\"name\":\"Firma\",\"url\":\"https://docs.firma.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/firma-2c386052/zZQF-ql17YHCcEFj/logo/light.svg?fit=max\u0026auto=format\u0026n=zZQF-ql17YHCcEFj\u0026q=85\u0026s=cddc3619a3422ba9f59fc78eb8b67d13\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.firma.dev#website\",\"name\":\"Firma\",\"url\":\"https://docs.firma.dev\",\"publisher\":{\"@id\":\"https://docs.firma.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.firma.dev/api-reference/workspaces/list-workspaces#webpage\",\"url\":\"https://docs.firma.dev/api-reference/workspaces/list-workspaces\",\"name\":\"List workspaces\",\"description\":\"Retrieve a paginated list of workspaces for the authenticated company\",\"dateModified\":\"2026-10-28T14:02:49.244Z\",\"isPartOf\":{\"@id\":\"https://docs.firma.dev#website\"},\"breadcrumb\":{\"@id\":\"https://docs.firma.dev/api-reference/workspaces/list-workspaces#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.firma.dev/api-reference/workspaces/list-workspaces#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Firma\",\"item\":\"https://docs.firma.dev\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List workspaces\",\"item\":\"https://docs.firma.dev/api-reference/workspaces/list-workspaces\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.firma.dev/api-reference/workspaces/list-workspaces#apireference\",\"headline\":\"List workspaces\",\"name\":\"List workspaces\",\"description\":\"Retrieve a paginated list of workspaces for the authenticated company\",\"url\":\"https://docs.firma.dev/api-reference/workspaces/list-workspaces\",\"mainEntityOfPage\":{\"@id\":\"https://docs.firma.dev/api-reference/workspaces/list-workspaces#webpage\"},\"dateModified\":\"2026-10-28T14:02:49.244Z\",\"publisher\":{\"@id\":\"https://docs.firma.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.firma.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Firma\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Firma\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/workspaces/list-workspaces.md","siteName":"Firma","nav":{"global":null,"languages":[{"language":"en","versions":[{"version":"v1.43.0 (latest)","tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/complete-setup-guide"}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/guides/typescript-sdk"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/guides/mcp"}]},{"tab":"API reference","groups":[{"group":"Endpoints","pages":[{"group":"Workspaces","pages":[{"openapi":"api-reference/openapi.json get /workspaces","title":"List workspaces","href":"/api-reference/workspaces/list-workspaces"},{"openapi":"api-reference/openapi.json post /workspaces","title":"Create a new workspace","description":"Create a new workspace for the authenticated company. All workspaces are created as non-protected by default. The protected status can only be set during company account creation.","href":"/api-reference/workspaces/create-a-new-workspace"},{"openapi":"api-reference/openapi.json get /workspaces/{id}","title":"Get a workspace","href":"/api-reference/workspaces/get-a-workspace"},{"openapi":"api-reference/openapi.json put /workspaces/{id}","title":"Update a workspace","href":"/api-reference/workspaces/update-a-workspace"},{"openapi":"api-reference/openapi.json patch /workspaces/{id}","title":"Partially update a workspace","href":"/api-reference/workspaces/partially-update-a-workspace"},{"openapi":"api-reference/openapi.json post /workspaces/{id}/api-key/regenerate","title":"Regenerate workspace API key","href":"/api-reference/workspaces/regenerate-workspace-api-key"},{"openapi":"api-reference/openapi.json post /workspaces/{id}/api-key/expire","title":"Expire pending API keys","href":"/api-reference/workspaces/expire-pending-api-keys"},{"openapi":"api-reference/openapi.json post /workspaces/{id}/logo","title":"Upload Workspace Logo","href":"/api-reference/workspaces/upload-workspace-logo"},{"openapi":"api-reference/openapi.json delete /workspaces/{id}/logo","title":"Remove Workspace Logo","href":"/api-reference/workspaces/remove-workspace-logo"}]},{"group":"Templates","pages":[{"openapi":"api-reference/openapi.json get /templates","title":"List Templates","href":"/api-reference/templates/list-templates"},{"openapi":"api-reference/openapi.json post /templates","title":"Create Template","href":"/api-reference/templates/create-template"},{"openapi":"api-reference/openapi.json get /templates/{id}","title":"Get Template","href":"/api-reference/templates/get-template"},{"openapi":"api-reference/openapi.json put /templates/{id}","title":"Comprehensive Template Update","href":"/api-reference/templates/comprehensive-template-update"},{"openapi":"api-reference/openapi.json patch /templates/{id}","title":"Partially Update Template","href":"/api-reference/templates/partially-update-template"},{"openapi":"api-reference/openapi.json post /templates/{id}/replace-document","title":"Replace template document","href":"/api-reference/templates/replace-template-document"},{"openapi":"api-reference/openapi.json post /templates/{id}/documents","title":"Add a document to a template","href":"/api-reference/templates/add-a-document-to-a-template"},{"openapi":"api-reference/openapi.json patch /templates/{id}/documents/{document_id}","title":"Replace or rename a template document","href":"/api-reference/templates/replace-or-rename-a-template-document"},{"openapi":"api-reference/openapi.json put /templates/{id}/documents/order","title":"Reorder a template's documents","href":"/api-reference/templates/reorder-a-templates-documents"},{"openapi":"api-reference/openapi.json delete /templates/{id}/documents/{document_id}","title":"Remove a document from a template","href":"/api-reference/templates/remove-a-document-from-a-template"},{"openapi":"api-reference/openapi.json delete /templates/{id}","title":"Delete a template","href":"/api-reference/templates/delete-a-template"},{"openapi":"api-reference/openapi.json post /templates/{id}/duplicate","title":"Duplicate template into signing request","href":"/api-reference/templates/duplicate-template-into-signing-request"},{"openapi":"api-reference/openapi.json post /templates/{id}/copy","title":"Copy template to another workspace","href":"/api-reference/templates/copy-template-to-workspace"},{"openapi":"api-reference/openapi.json get /templates/{id}/fields","title":"Get template fields","href":"/api-reference/templates/get-template-fields"},{"openapi":"api-reference/openapi.json get /templates/{id}/users","title":"Get template users","href":"/api-reference/templates/get-template-users"},{"openapi":"api-reference/openapi.json get /templates/{id}/reminders","title":"Get template reminders","href":"/api-reference/templates/get-template-reminders"}]},{"group":"Signing Requests","pages":[{"openapi":"api-reference/openapi.json post /documents","title":"Upload a document","href":"/api-reference/signing-requests/upload-document"},{"openapi":"api-reference/openapi.json get /signing-requests","title":"List Signing Requests","href":"/api-reference/signing-requests/list-signing-requests"},{"openapi":"api-reference/openapi.json post /signing-requests","title":"Create Signing Request","href":"/api-reference/signing-requests/create-signing-request"},{"openapi":"api-reference/openapi.json post /signing-requests/create-and-send","title":"Create and Send Signing Request (Atomic)","href":"/api-reference/signing-requests/create-and-send-signing-request-atomic"},{"openapi":"api-reference/openapi.json get /signing-requests/{id}","title":"Get Signing Request","href":"/api-reference/signing-requests/get-signing-request"},{"openapi":"api-reference/openapi.json get /signing-requests/{id}/download","title":"Download Signing Request Document","href":"/api-reference/signing-requests/download-signing-request"},{"openapi":"api-reference/openapi.json get /signing-requests/{id}/documents/{document_id}/download","title":"Download one document of a signing request","href":"/api-reference/signing-requests/download-one-document-of-a-signing-request"},{"openapi":"api-reference/openapi.json get /signing-requests/{id}/signers/{signer_id}/signature","title":"Retrieve Signer Signature Image","href":"/api-reference/signing-requests/retrieve-signer-signature"},{"openapi":"api-reference/openapi.json get /signing-requests/{id}/signers/{signer_id}/initials","title":"Retrieve Signer Initials Image","href":"/api-reference/signing-requests/retrieve-signer-initials"},{"openapi":"api-reference/openapi.json get /signing-requests/{id}/signers/{signer_id}/stamps/{field_id}","title":"Retrieve Signer Stamp Image","href":"/api-reference/signing-requests/retrieve-signer-stamp"},{"openapi":"api-reference/openapi.json get /signing-requests/{id}/signers/{signer_id}/files/{field_id}","title":"Retrieve Signer-Uploaded File","href":"/api-reference/signing-requests/retrieve-signer-file"},{"openapi":"api-reference/openapi.json put /signing-requests/{id}","title":"Comprehensive Update Signing Request","href":"/api-reference/signing-requests/comprehensive-update-signing-request"},{"openapi":"api-reference/openapi.json patch /signing-requests/{id}","title":"Partially Update Signing Request","href":"/api-reference/signing-requests/partially-update-signing-request"},{"openapi":"api-reference/openapi.json post /signing-requests/{id}/documents","title":"Add a document to a signing request","href":"/api-reference/signing-requests/add-a-document-to-a-signing-request"},{"openapi":"api-reference/openapi.json patch /signing-requests/{id}/documents/{document_id}","title":"Replace or rename a signing request document","href":"/api-reference/signing-requests/replace-or-rename-a-signing-request-document"},{"openapi":"api-reference/openapi.json put /signing-requests/{id}/documents/order","title":"Reorder a signing request's documents","href":"/api-reference/signing-requests/reorder-a-signing-requests-documents"},{"openapi":"api-reference/openapi.json delete /signing-requests/{id}/documents/{document_id}","title":"Remove a document from a signing request","href":"/api-reference/signing-requests/remove-a-document-from-a-signing-request"},{"openapi":"api-reference/openapi.json post /signing-requests/{id}/cancel","title":"Cancel a signing request","href":"/api-reference/signing-requests/cancel-a-signing-request"},{"openapi":"api-reference/openapi.json delete /signing-requests/{id}","title":"Delete a signing request","href":"/api-reference/signing-requests/delete-a-signing-request"},{"openapi":"api-reference/openapi.json post /signing-requests/{id}/send","title":"Send signing request","href":"/api-reference/signing-requests/send-signing-request"},{"openapi":"api-reference/openapi.json post /signing-requests/{id}/resend","title":"Resend signing request to specific recipients","href":"/api-reference/signing-requests/resend-signing-request-to-specific-recipients"},{"openapi":"api-reference/openapi.json get /signing-requests/{id}/fields","title":"Get signing request fields","href":"/api-reference/signing-requests/get-signing-request-fields"},{"openapi":"api-reference/openapi.json get /signing-requests/{id}/users","title":"Get signing request users","href":"/api-reference/signing-requests/get-signing-request-users"},{"openapi":"api-reference/openapi.json get /signing-requests/{id}/reminders","title":"Get signing request reminders","href":"/api-reference/signing-requests/get-signing-request-reminders"},{"openapi":"api-reference/openapi.json get /signing-requests/{id}/audit","title":"Get signing request audit trail","href":"/api-reference/signing-requests/get-signing-request-audit-trail"},{"openapi":"api-reference/openapi.json delete /signing-requests/{id}/seal-participants/{participant_id}","title":"Remove a seal participant from an unsent signing request","href":"/api-reference/signing-requests/remove-a-seal-participant"}]},{"group":"Seals","pages":[{"openapi":"api-reference/openapi.json get /seals","title":"List organization seals","href":"/api-reference/seals/list-organization-seals"},{"openapi":"api-reference/openapi.json post /seals","title":"Create an organization seal","href":"/api-reference/seals/create-an-organization-seal"},{"openapi":"api-reference/openapi.json get /seals/{id}","title":"Get an organization seal","href":"/api-reference/seals/get-an-organization-seal"},{"openapi":"api-reference/openapi.json patch /seals/{id}","title":"Update an organization seal","href":"/api-reference/seals/update-an-organization-seal"},{"openapi":"api-reference/openapi.json delete /seals/{id}","title":"Revoke an organization seal","href":"/api-reference/seals/revoke-an-organization-seal"},{"openapi":"api-reference/openapi.json get /seals/{id}/image","title":"Get seal image","href":"/api-reference/seals/get-seal-image"},{"openapi":"api-reference/openapi.json delete /seals/{id}/erase","title":"Erase a seal lineage","href":"/api-reference/seals/erase-a-seal-lineage"},{"openapi":"api-reference/openapi.json get /seals/{id}/applications","title":"List seal applications","href":"/api-reference/seals/list-seal-applications"},{"openapi":"api-reference/openapi.json get /seals/{id}/access-log","title":"List seal access log","href":"/api-reference/seals/list-seal-access-log"}]},{"group":"Custom Fields","pages":[{"openapi":"api-reference/openapi.json get /workspace/{workspace_id}/custom-fields","title":"List workspace custom fields","href":"/api-reference/custom-fields/list-workspace-custom-fields"},{"openapi":"api-reference/openapi.json post /workspace/{workspace_id}/custom-fields","title":"Create workspace custom field","href":"/api-reference/custom-fields/create-workspace-custom-field"},{"openapi":"api-reference/openapi.json put /workspace/{workspace_id}/custom-fields/{field_id}","title":"Update workspace custom field","href":"/api-reference/custom-fields/update-workspace-custom-field"},{"openapi":"api-reference/openapi.json delete /workspace/{workspace_id}/custom-fields/{field_id}","title":"Delete workspace custom field","href":"/api-reference/custom-fields/delete-workspace-custom-field"},{"openapi":"api-reference/openapi.json get /templates/{template_id}/custom-fields","title":"List template custom fields","href":"/api-reference/custom-fields/list-template-custom-fields"},{"openapi":"api-reference/openapi.json post /templates/{template_id}/custom-fields","title":"Create template custom field","href":"/api-reference/custom-fields/create-template-custom-field"},{"openapi":"api-reference/openapi.json delete /templates/{template_id}/custom-fields/{field_id}","title":"Delete template custom field","href":"/api-reference/custom-fields/delete-template-custom-field"},{"openapi":"api-reference/openapi.json get /signing-requests/{request_id}/custom-fields","title":"List signing request custom fields","href":"/api-reference/custom-fields/list-signing-request-custom-fields"},{"openapi":"api-reference/openapi.json post /signing-requests/{request_id}/custom-fields","title":"Create signing request custom field","href":"/api-reference/custom-fields/create-signing-request-custom-field"},{"openapi":"api-reference/openapi.json delete /signing-requests/{request_id}/custom-fields/{field_id}","title":"Delete signing request custom field","href":"/api-reference/custom-fields/delete-signing-request-custom-field"}]},{"group":"Signer Terms","pages":[{"openapi":"api-reference/openapi.json get /company/signer-terms","title":"List company signer terms","href":"/api-reference/signer-terms/list-company-signer-terms"},{"openapi":"api-reference/openapi.json put /company/signer-terms/{language}","title":"Create or update company signer terms","href":"/api-reference/signer-terms/update-company-signer-terms"},{"openapi":"api-reference/openapi.json delete /company/signer-terms/{language}","title":"Delete company signer terms","href":"/api-reference/signer-terms/delete-company-signer-terms"},{"openapi":"api-reference/openapi.json get /workspace/{workspace_id}/signer-terms","title":"List workspace signer terms","href":"/api-reference/signer-terms/list-workspace-signer-terms"},{"openapi":"api-reference/openapi.json put /workspace/{workspace_id}/signer-terms/{language}","title":"Create or update workspace signer terms","href":"/api-reference/signer-terms/update-workspace-signer-terms"},{"openapi":"api-reference/openapi.json delete /workspace/{workspace_id}/signer-terms/{language}","title":"Delete workspace signer terms","href":"/api-reference/signer-terms/delete-workspace-signer-terms"}]},{"group":"Account/Company","pages":[{"openapi":"api-reference/openapi.json get /company","title":"Get company information","href":"/api-reference/company/get-company-information"},{"openapi":"api-reference/openapi.json put /company","title":"Update company information","href":"/api-reference/company/update-company-information"},{"openapi":"api-reference/openapi.json patch /company","title":"Partially update company information","href":"/api-reference/company/partially-update-company-information"},{"openapi":"api-reference/openapi.json get /company/settings","title":"Get company settings","href":"/api-reference/company/get-company-settings"},{"openapi":"api-reference/openapi.json put /company/settings","title":"Update company settings","href":"/api-reference/company/update-company-settings"},{"openapi":"api-reference/openapi.json post /company/logo","title":"Upload Company Logo","href":"/api-reference/company/upload-company-logo"},{"openapi":"api-reference/openapi.json delete /company/logo","title":"Remove Company Logo","href":"/api-reference/company/remove-company-logo"}]},{"group":"Email Domains","pages":[{"openapi":"api-reference/openapi.json get /company/domains","title":"List company domains","href":"/api-reference/email-domains/list-company-domains"},{"openapi":"api-reference/openapi.json post /company/domains","title":"Add company domain","href":"/api-reference/email-domains/add-company-domain"},{"openapi":"api-reference/openapi.json get /company/domains/{id}","title":"Get company domain","href":"/api-reference/email-domains/get-company-domain"},{"openapi":"api-reference/openapi.json delete /company/domains/{id}","title":"Delete company domain","href":"/api-reference/email-domains/delete-company-domain"},{"openapi":"api-reference/openapi.json post /company/domains/{id}/verify-ownership","title":"Verify domain ownership","href":"/api-reference/email-domains/verify-domain-ownership"},{"openapi":"api-reference/openapi.json post /company/domains/{id}/finalize","title":"Finalize domain setup","href":"/api-reference/email-domains/finalize-domain-setup"},{"openapi":"api-reference/openapi.json post /company/domains/{id}/verify-dns","title":"Verify DNS records","href":"/api-reference/email-domains/verify-dns-records"},{"openapi":"api-reference/openapi.json post /company/domains/{id}/set-primary","title":"Set primary domain","href":"/api-reference/email-domains/set-primary-domain"},{"openapi":"api-reference/openapi.json get /workspace/{workspace_id}/domains","title":"List workspace domains","href":"/api-reference/email-domains/list-workspace-domains"},{"openapi":"api-reference/openapi.json post /workspace/{workspace_id}/domains","title":"Add workspace domain","href":"/api-reference/email-domains/add-workspace-domain"},{"openapi":"api-reference/openapi.json get /workspace/{workspace_id}/domains/{id}","title":"Get workspace domain","href":"/api-reference/email-domains/get-workspace-domain"},{"openapi":"api-reference/openapi.json delete /workspace/{workspace_id}/domains/{id}","title":"Delete workspace domain","href":"/api-reference/email-domains/delete-workspace-domain"},{"openapi":"api-reference/openapi.json post /workspace/{workspace_id}/domains/{id}/verify-ownership","title":"Verify workspace domain ownership","href":"/api-reference/email-domains/verify-workspace-domain-ownership"},{"openapi":"api-reference/openapi.json post /workspace/{workspace_id}/domains/{id}/finalize","title":"Finalize workspace domain setup","href":"/api-reference/email-domains/finalize-workspace-domain-setup"},{"openapi":"api-reference/openapi.json post /workspace/{workspace_id}/domains/{id}/verify-dns","title":"Verify workspace domain DNS records","href":"/api-reference/email-domains/verify-workspace-domain-dns-records"},{"openapi":"api-reference/openapi.json post /workspace/{workspace_id}/domains/{id}/set-primary","title":"Set primary workspace domain","href":"/api-reference/email-domains/set-primary-workspace-domain"}]},{"group":"Email Templates","pages":[{"openapi":"api-reference/openapi.json get /workspace/{workspace_id}/email-templates","title":"List workspace email templates","href":"/api-reference/email-templates/list-workspace-email-templates"},{"openapi":"api-reference/openapi.json get /workspace/{workspace_id}/email-templates/{email_type}","title":"Get workspace email template","href":"/api-reference/email-templates/get-workspace-email-template"},{"openapi":"api-reference/openapi.json put /workspace/{workspace_id}/email-templates/{email_type}","title":"Create or update workspace email template","href":"/api-reference/email-templates/create-or-update-workspace-email-template"},{"openapi":"api-reference/openapi.json delete /workspace/{workspace_id}/email-templates/{email_type}","title":"Delete workspace email template","href":"/api-reference/email-templates/delete-workspace-email-template"},{"openapi":"api-reference/openapi.json get /company/email-templates","title":"List company email templates","href":"/api-reference/email-templates/list-company-email-templates"},{"openapi":"api-reference/openapi.json put /company/email-templates/{email_type}","title":"Create or update company email template","href":"/api-reference/email-templates/create-or-update-company-email-template"},{"openapi":"api-reference/openapi.json delete /company/email-templates/{email_type}","title":"Delete company email template","href":"/api-reference/email-templates/delete-company-email-template"},{"openapi":"api-reference/openapi.json get /email-templates/defaults/{language}","title":"Get default email templates","href":"/api-reference/email-templates/get-default-email-templates"},{"openapi":"api-reference/openapi.json get /email-templates/placeholders","title":"Get email template placeholders","href":"/api-reference/email-templates/get-email-template-placeholders"}]},{"group":"Webhooks","pages":[{"openapi":"api-reference/openapi.json get /webhooks","title":"List Webhooks","href":"/api-reference/webhooks/list-webhooks"},{"openapi":"api-reference/openapi.json post /webhooks","title":"Create Webhook","href":"/api-reference/webhooks/create-webhook"},{"openapi":"api-reference/openapi.json get /webhooks/{id}","title":"Get Webhook","href":"/api-reference/webhooks/get-webhook"},{"openapi":"api-reference/openapi.json put /webhooks/{id}","title":"Update Webhook","href":"/api-reference/webhooks/update-webhook"},{"openapi":"api-reference/openapi.json delete /webhooks/{id}","title":"Delete a webhook","href":"/api-reference/webhooks/delete-a-webhook"},{"openapi":"api-reference/openapi.json post /webhooks/{id}/test","title":"Test a webhook","href":"/api-reference/webhooks/test-a-webhook"},{"openapi":"api-reference/openapi.json get /webhooks/secret-status","title":"Get webhook secret rotation status","href":"/api-reference/webhooks/get-webhook-secret-rotation-status"},{"openapi":"api-reference/openapi.json post /webhooks/rotate-secret","title":"Rotate webhook signing secret","href":"/api-reference/webhooks/rotate-webhook-signing-secret"},{"title":"Get Workspace Webhook Secret Status","openapi":"api-reference/openapi.json get /workspaces/{id}/webhooks/secret-status","href":"/api-reference/webhooks/get-workspace-webhook-secret-status"},{"title":"Rotate Workspace Webhook Secret","openapi":"api-reference/openapi.json post /workspaces/{id}/webhooks/rotate-secret","href":"/api-reference/webhooks/rotate-workspace-webhook-secret"}]},{"group":"JWT Management","pages":[{"openapi":"api-reference/openapi.json post /generate-template-token","title":"Generate JWT token for embedding templates","href":"/api-reference/jwt-management/generate-jwt-token-for-embedding-templates"},{"openapi":"api-reference/openapi.json post /revoke-template-token","title":"Revoke Template JWT Token","href":"/api-reference/jwt-management/revoke-template-jwt-token"},{"openapi":"api-reference/openapi.json post /jwt/generate-signing-request","title":"Generate JWT token for signing request","href":"/api-reference/jwt-management/generate-jwt-token-for-signing-request"},{"openapi":"api-reference/openapi.json post /jwt/revoke-signing-request","title":"Revoke a signing request JWT token","href":"/api-reference/jwt-management/revoke-a-signing-request-jwt-token"}]},{"group":"Workspace Settings","pages":[{"openapi":"api-reference/openapi.json get /workspace/{workspace_id}/settings","title":"Get workspace settings","href":"/api-reference/workspace-settings/get-workspace-settings"},{"openapi":"api-reference/openapi.json put /workspace/{workspace_id}/settings","title":"Update workspace settings","href":"/api-reference/workspace-settings/update-workspace-settings"}]}]}]}],"global":{"anchors":[]}},{"version":"v1.40.4","pages":[{"title":"v1.40.4","href":"/api-reference/v01.40.04/workspaces/list-workspaces"}]},{"version":"v1.40.2","pages":[{"title":"v1.40.2","href":"/api-reference/v01.40.02/workspaces/list-workspaces"}]},{"version":"v1.40.1","pages":[{"title":"v1.40.1","href":"/api-reference/v01.40.01/workspaces/list-workspaces"}]},{"version":"v1.40.0","pages":[{"title":"v1.40.0","href":"/api-reference/v01.40.00/workspaces/list-workspaces"}]},{"version":"v1.39.1","pages":[{"title":"v1.39.1","href":"/api-reference/v01.39.01/workspaces/list-workspaces"}]}]},{"language":"es","pages":[{"title":"es","href":"/es/api-reference/workspaces/list-workspaces"}]},{"language":"fr","pages":[{"title":"fr","href":"/fr/api-reference/workspaces/list-workspaces"}]}]},"basePath":"","title":"List workspaces - Firma","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CrDfRf61.js","snippetPresets-Dv-cOUrx.js","utils-BUTreAgv.js","style-to-object-BY3JEAdk.js","utils-wsznt9RM.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DEsMlaPy.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DontW4xJ.js","_Uint8Array-pP7X6_RM.js","isObject-FP1Yky1u.js","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","CodeSnippet-eoRjC4Le.js","getApiPlaygroundDisplay-CZyAPlR2.js","Page-Cr9IwkK7.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js","Markdown-CwtoSfEf.js","AssistantPageLink-CTqa3eoi.js","dist-DIfYWxfm.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}