Skip to main content
Add tax firm users (preparers, staff, etc.) to their workspace by email addresses. Users are immediately added to the workspace and can sign in right away. 
mutation AddUsersToWorkspace($workspaceId: ID!, $userEmails: [String!]!) {
  addUsersToTheWorkspace(workspaceId: $workspaceId, userEmails: $userEmails) {
    id
    email
    name
    role
  }
}

​
Arguments

​
workspaceId
ID!
required
Workspace identifier (corresponds to a tax firm). Add users to the workspace that corresponds to their tax firm.
​
userEmails
[String!]!
required
Array of email addresses for the tax firm’s users. You can add multiple users in a single request.

​
Returns

​
addUsersToTheWorkspace
[User!]!
Array of user objects that were added to the workspace.

​
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 AddUsersToWorkspace($workspaceId: ID!, $userEmails: [String!]!) { addUsersToTheWorkspace(workspaceId: $workspaceId, userEmails: $userEmails) { id email name role } }",
    "variables": {
      "workspaceId": "workspace_123456",
      "userEmails": [
        "[email protected]",
        "[email protected]"
      ]
    }
  }'

{
  "data": {
    "addUsersToTheWorkspace": [
      {
        "id": "user_789",
        "email": "[email protected]",
        "name": null,
        "role": "user"
      },
      {
        "id": "user_790",
        "email": "[email protected]",
        "name": null,
        "role": "user"
      }
    ]
  }
}
Users are immediately added to the workspace - no email invitations are sent. Users can sign in using their email address right away to access the workspace. If a user already exists, they will be added to the workspace without creating a duplicate account.

​
Troubleshooting

Problem: Tax firm users unable to access workspace after being added Solutions:
  • Verify email addresses are valid and correctly formatted
  • Check that users haven’t already been added to the workspace
  • Ensure workspace ID corresponds to the correct tax firm
  • Verify you’re adding users to the correct workspace for their tax firm
  • Confirm users can sign in using their email address - no invitation email is required
  • Ensure users are using a valid deep link with the workspace slug format /w/{workspaceSlug}/ (recommended) or /w/redirect/ (convenience option)