---
title: "Join a team with invitation token"
method: POST
path: "/v2/join-team-by-token"
tags: ["team"]
---

# Join a team with invitation token

`POST /v2/join-team-by-token`

This endpoint enables users to join a team using a valid and unexpired invitation token. Users send a POST request that includes the invitationToken to authenticate their request to join the specified team. This ensures only those with valid and unexpired tokens can join the team.

## Request body

- V2CurrentUserJoinTeamRequest
  - `invitationToken` string, required — A valid token required to authorize the request to join the team. You can retrieve the invitation token by using the Invite a user to the team endpoint.

## Response `200`

The user has successfully joined the team using the provided invitation token.

- V2CurrentUserJoinTeamResponse
  - `userAccess` V2UserAccess
    - `id` string — The unique identifier of the user.
    - `namespace` string — The domain or namespace associated with the user's organization.
    - `systemPermissions` V2Permission[] — Permissions assigned to the user throughout the system.
      - `subject` 'SUBJECT_AD' | 'SUBJECT_BILLING_ACCOUNT' | 'SUBJECT_CAMPAIGN' | 'SUBJECT_CAMPAIGN_APPROVAL' | 'SUBJECT_CAMPAIGN_QUESTION' | 'SUBJECT_CATALOG' | 'SUBJECT_CATALOG_PRODUCT' | 'SUBJECT_CONTACT' | 'SUBJECT_CONTENT_STANDARD' | 'SUBJECT_CROSS_SELL_CATEGORY' | 'SUBJECT_CUSTOMER' | 'SUBJECT_FEED_SETTINGS' | 'SUBJECT_FILTER_MAPPING' | 'SUBJECT_LEDGER' | 'SUBJECT_LINK' | 'SUBJECT_NAMESPACE' | 'SUBJECT_ORDER' | 'SUBJECT_PARTNER_INVITE' | 'SUBJECT_PAYMENT' | 'SUBJECT_PRODUCT' | 'SUBJECT_REPORTING' | 'SUBJECT_REPORTING_UNTHROTTLED' | 'SUBJECT_ROLE' | 'SUBJECT_SUGGESTED_SEARCH_TERM' | 'SUBJECT_SUPPLIER_INFO' | 'SUBJECT_SYSTEM_PERMISSION' | 'SUBJECT_TEAM_ACCOUNT' | 'SUBJECT_TEAM_INVITE' | 'SUBJECT_TEAM_PERMISSION' | 'SUBJECT_USER_ACCOUNT' | 'SUBJECT_SYSTEM_USER_PERMISSION' | 'SUBJECT_SEGMENTS'
      - `action` 'ACTION_READ' | 'ACTION_READ_WRITE'
    - `consumedPermissions` object — Permissions the user has engaged with or utilized.
    - `isAdmin` boolean — Denotes administrative privileges for the user.
    - `clientIp` string — The client's IP address.

## Other responses

- `400` — There was a problem with input.
- `401` — Login failed or token not valid.
- `403` — Login failed or token not valid.
- `default` — An unexpected error response.

---

[API](https://skmtc.net/citrusad/apis/citrus-auth-api.md) · [All operations](https://skmtc.net/citrusad/apis/citrus-auth-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/citrusad/citrus-auth-api/versions/a040003c7378/schema)