Create workspace

curl -X POST https://gateway.filed.com/graphql \ -H "Content-Type: application/json" \ -H "Authorization: Bearer <accessToken>" \ -H "source-platform: my-sample-platform" \ -d '{ "query": "mutation CreateWorkspace($input: CreateWorkspaceInput!) { createWorkspace(input: $input) { id slug displayName status workspaceType } }", "variables": { "input": { "displayName": "Smith & Associates Tax Firm", "metadata": { "customerId": "customer-123", "partnerId": "acme-partner-001", "integrationVersion": "1.0" }, "firmSize": "md" } } }'

{ "data": { "createWorkspace": { "id": "workspace_123456", "slug": "smith-associates-tax-firm", "displayName": "Smith & Associates Tax Firm", "status": "active", "workspaceType": "partner" } } }

Arguments

input

CreateWorkspaceInput!

required

Input object for creating a workspace.

Show CreateWorkspaceInput

input.displayName

String!

required

Tax firm’s display name.

input.metadata

JSON

Additional metadata (e.g., customer ID, partner info).

input.firmSize

String

Tax firm size classification. Valid values: “xs”, “sm”, “md”, “lg”, “xl”.

Returns

ID!

Workspace identifier. Save this for adding users and other operations.

slug

String!

URL-friendly workspace identifier. Essential for creating reliable deep links that route customers to the correct workspace.

displayName

String!

Workspace display name.

status

String!

Workspace status (e.g., “active”).

workspaceType

WorkspaceType!

Type of workspace. Will be automatically set to “partner” for partner accounts.

Example

curl -X POST https://gateway.filed.com/graphql \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <accessToken>" \
  -H "source-platform: my-sample-platform" \
  -d '{
    "query": "mutation CreateWorkspace($input: CreateWorkspaceInput!) { createWorkspace(input: $input) { id slug displayName status workspaceType } }",
    "variables": {
      "input": {
        "displayName": "Smith & Associates Tax Firm",
        "metadata": {
          "customerId": "customer-123",
          "partnerId": "acme-partner-001",
          "integrationVersion": "1.0"
        },
        "firmSize": "md"
      }
    }
  }'

{
  "data": {
    "createWorkspace": {
      "id": "workspace_123456",
      "slug": "smith-associates-tax-firm",
      "displayName": "Smith & Associates Tax Firm",
      "status": "active",
      "workspaceType": "partner"
    }
  }
}

Create one workspace per tax firm customer. If you manage 10 tax firms, create 10 workspaces. Save both the workspaceId and slug for each workspace - you’ll need the workspace ID for adding users and the slug for generating deep links.

APIs

Guides

API Reference

Arguments

Returns

Example

Troubleshooting

​Arguments

​Returns

​Example

​Troubleshooting

Arguments

Returns

Example

Troubleshooting