- API reference
- Workspaces
- Return a workspace
GET
https://api.us.nylas.com/v3/workspaces/{workspace_id}Return a workspace
Returns the specified workspace.
NYLAS API KEY
Example:
"ad410018-d306-43f9-8361-fa5d7b2172e0"auto_groupbooleanWhen true, specifies that newly created grants in the application are automatically assigned
to the workspace if their email address' domain matches the domain.
Example:
trueExample:
1756379932defaultbooleanWhen true, the workspace is the application's default workspace, which Nylas creates and
manages. Nylas includes this field when you retrieve workspaces. For more information, see
the Workspaces overview.
Example:
falsedomainstringnullableThe email domain associated with the workspace. This is null if the workspace was created
without a domain.
Example:
"nylas.com"policy_idstringThe ID of the policy attached to the workspace. The policy applies to Agent Accounts in the workspace.
Example:
"6dcc5d92-8a55-4ce8-85a8-2f4275f8f0a0"rule_idsarray<string>The IDs of any rules attached to the workspace. The rules apply to Agent Accounts in the workspace.
Example:
["3f2504e0-4f89-41d3-9a0c-0305e82c3301"]