> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get your team

> Get the team you own, its members and seat allowance, plus your active membership when you work in another account’s team.

Get the team you own, its members and seat allowance, plus your active membership when you work in another account’s team.

```http theme={null}
POST https://api.voicecheap.ai/v1/actions/team_get
```

## Authentication and permissions

<ParamField header="x-api-key" type="string" required>
  Send a VoiceCheap API key in this header. Authorization: Bearer with the same API key is also supported. OAuth access tokens are accepted only by
  MCP, not by this REST endpoint.
</ParamField>

Required permissions: `team:read`.

An active paid subscription is required. Permissions do not change team roles, resource ownership, media credits, or plan limits.

## Parameters

Send an empty JSON object. This action has no input fields.

<Accordion title="Complete input schema">
  The JSON Schema below preserves the exact field names, nested types, defaults, bounds, and accepted values exposed by discovery. Additional cross-field rules are listed in the operation notes.

  ```json theme={null}
  {
    "type": "object",
    "properties": {},
    "additionalProperties": false
  }
  ```
</Accordion>

## Request examples

Replace example resource identifiers and media keys with values returned for your account. Keep the request identifier stable when retrying the same mutation.

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST 'https://api.voicecheap.ai/v1/actions/team_get' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{}'
  ```

  ```javascript JavaScript theme={null}
  const input = {};
  const response = await fetch('https://api.voicecheap.ai/v1/actions/team_get', {
    method: 'POST',
    headers: {
      'x-api-key': process.env.VOICECHEAP_API_KEY,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify(input),
  });
  const body = await response.json();
  if (!response.ok) throw new Error(body.code + ': ' + body.message);
  console.log(body);
  ```

  ```python Python theme={null}
  import os
  import requests

  response = requests.post(
      "https://api.voicecheap.ai/v1/actions/team_get",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={},
      timeout=120,
  )
  body = response.json()
  if not response.ok:
      raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
  print(body)
  ```
</RequestExample>

## Response

A successful first execution returns HTTP 200 with the operation result under data. A replay may return saved request state instead. The example shows one supported response, not every optional field.

Returns the team the account owns and its active membership in another account’s team, where applicable.

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "ownedTeam": {
        "teamId": "f79512aa-cdbc-4f11-92e1-7a3af204bf45",
        "teamName": "Studio team",
        "members": [
          {
            "userId": "user_456",
            "email": "member@example.com",
            "name": "Studio member",
            "status": "valid"
          }
        ],
        "seats": {
          "limit": 5,
          "used": 1
        }
      },
      "membership": null
    }
  }
  ```
</ResponseExample>

## Result fields

| Field | Description |
| - | - |
| `data.ownedTeam` | Team owned by the caller, or null. |
| `data.ownedTeam.teamId` | Owned team identifier. |
| `data.ownedTeam.teamName` | Owned team name. |
| `data.ownedTeam.members` | Current members of the owned team. |
| `data.ownedTeam.members[].userId` | Member account identifier. |
| `data.ownedTeam.members[].email` | Member email address. |
| `data.ownedTeam.members[].name` | Member display name. |
| `data.ownedTeam.members[].status` | Current member status; valid for an active membership. |
| `data.ownedTeam.seats.limit` | Maximum guests allowed by the caller’s personal plan. |
| `data.ownedTeam.seats.used` | Current number of guests. |
| `data.membership` | Active membership in another account’s team, or null. |
| `data.membership.teamId` | Team identifier for the active membership. |
| `data.membership.teamName` | Team name for the active membership. |
| `data.membership.role` | member for an active guest membership. |
| `data.membership.owner` | Public owner identity containing userId, displayName, and email. |

## Operation notes

* The owned team seat limit uses the caller’s personal plan. It does not use a plan inherited from a team membership.

## Usage

Each successful invocation consumes one monthly API/MCP call. Media credits and the operation's own generation allowances also apply.

## Errors

| HTTP status | Code | Meaning or recovery |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | Credentials were supplied in an access\_token or api\_key query parameter. Send credentials in headers. |
| 400 | `VALIDATION_ERROR` | The JSON object contains an unsupported field, an invalid value, or a missing required argument. |
| 401 | `API_KEY_EXPIRED` | The API key has expired. |
| 401 | `INVALID_API_KEY` | Provide a valid, unexpired API key. |
| 401 | `INVALID_CREDENTIAL` | The Authorization header is malformed or conflicts with x-api-key. |
| 401 | `MISSING_CREDENTIAL` | No usable header credential was supplied, or it exceeded 4096 characters. |
| 401 | `USER_NOT_FOUND` | The credential's account no longer exists. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | The credential's user belongs to more than one team, so the billing context is ambiguous. |
| 403 | `INSUFFICIENT_SCOPE` | Grant every required permission or choose another credential. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | The account's integration limits could not be verified. |
| 403 | `SUBSCRIPTION_REQUIRED` | Use an active paid subscription. |
| 403 | `TEAM_MEMBERSHIP_INVALID` | The account’s current team membership does not match this connection’s workspace. Refresh the membership and reconnect. |
| 403 | `TEAM_OWNER_NOT_FOUND` | The effective team owner account could not be found. |
| 404 | `ACCOUNT_NOT_FOUND` | The account or active workspace account could not be found. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Wait for the monthly reset or change plan. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Wait for Retry-After when present and use backoff. |
| 500 | `INTERNAL_ERROR` | Check saved request state and resource history before deciding to retry a mutation. |
| 503 | `SERVER_RESTARTING` | The server is restarting. Retry shortly and keep the same request identifier for a mutation. |

```json theme={null}
{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["team:read"]
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.