Skip to main content
GET
/
workspace
/
{workspace_id}
/
domains
List workspace domains
curl --request GET \
  --url https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains \
  --header 'Authorization: <api-key>'
{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "domain": "sales.acme.com",
      "verification_status": 2,
      "domain_status": 1,
      "is_primary": true,
      "date_created": "2024-01-15T10:30:00Z",
      "date_changed": "2024-01-16T14:00:00Z"
    }
  ],
  "workspace_id": "456e4567-e89b-12d3-a456-426614174000"
}

Documentation Index

Fetch the complete documentation index at: https://docs.firma.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.

Path Parameters

workspace_id
string<uuid>
required

Workspace ID

Response

Workspace domains retrieved successfully

results
object[]
workspace_id
string<uuid>

ID of the workspace