Overview

Workspaces (previously called teams) function similarly to folders. A workspace groups together users, templates, themes, branding, and documents.

When interacting with the API, you may need to specify which workspace a request should apply to. This is done by providing the workspace identifier in your request.

Note: Although the UI now refers to these as workspaces, the API continues to support several parameter names for backwards compatibility:

• workspace_key
• team_key
• account_key

All three values are interchangeable and refer to the same workspace identifier.

Get Teams

This endpoint returns all the teams (workspaces) that the currently authenticated user belongs to.

GET /v1/teams
Authorization: Bearer <ACCESS_TOKEN>

The response includes a list of team objects containing:

Example Response

{
  "data": {
    "teams": [
      {
        "key": "ahFzfmFjY291bnRzLXRlYW0tcHJvZCISCxIFVGVhbRiAgICf5LqVCgw",
        "name": "Operations Team"
      },
      {
        "key": "ahFzfmFjY291bnRzLXRlYW0tc2FsZXMSCxIFVGVhbRiAgICfl9vLCgw",
        "name": "Sales Workspace"
      }
    ]
  },
  "status": {
    "status_code": 200
  }
}

How the Team Key Is Used

The team_key (or workspace_key) is used in API requests when you want to create a document within a specific workspace.

For example, when creating a document pack you may include the workspace identifier in the request body.

Example: Creating a Document Pack in a Specific Workspace

{
  "document_pack_name": "Example Document Pack",
  "team_key": "ahFzfmFjY291bnRzLXRlYW0tcHJvZCISCxIFVGVhbRiAgICf5LqVCgw",

  "documents": [
    {
      "document_creation_settings": {
        "base_64_document": "{{base_64}}",
        "extract_fields_by_tag": true,
        ...
      },
      "document_name": "ID document to be signed",
      "data_fields": [
        {
          "custom_id": "client_name",
          "data": "Joe Soap"
        }
      ]
    }
  ],
"signatories": [
    ...
  ],
  ...
}

In this example, the team_key ensures the document pack is created inside the specified workspace.

Notes

If no team_key, workspace_key, or account_key is provided, the API will default to the workspace associated with the authenticated user.