Skip to content
campaiDeveloper
campai.com

Connect · Teams

GET/connect/organizations/{organizationId}/teams/{teamId}Reads only

Get team

Returns a team for the supplied organization and team IDs. The response includes its parent, subteams, chat style, and inherited chat style. Actor details may be masked depending on the caller’s permissions.

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Who may call it

  • The caller must have organization access.
  • The caller needs team.read.
  • When organization access is not null, a non-contact actor other than the current actor is masked without user.read.
  • When organization access is not null, an API actor is masked without apiKey.read.

Request

Path parameters

  • organizationIdidrequired
  • teamIdidrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request GET 'https://cloud.campai.com/api/connect/organizations/YOUR_ORGANIZATION_ID/teams/YOUR_TEAM_ID' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

Content-Type: application/json

  • _idid
  • createdAtstring · date-timenullable
  • updatedAtstring · date-timenullable
  • removedAtstring · date-timenullable
  • createdByobjectnullable
  • updatedByobjectnullable
  • removedByobjectnullable
  • __ignoreTriggersstringnullable
  • organizationid
  • namestring

    1–80 characters

  • parentTeamidnullable
  • descriptionstring

    at most 256 characters

  • avatarobjectnullable
    4 properties
    • resourcestring

      at least 1 characters

    • fileNamestring

      at most 128 characters

    • contentTypestring

      at most 75 characters

    • fileSizeBytesinteger

      at least 0

  • membershipobject
    4 properties
    • contactTypesstring[]
      member address customer sponsor contributor employee supplier
    • segmentsstring[]

      each 1–30 characters

    • departmentsid[]
    • tagsstring[]

      at most 20 items · each 1–40 characters

  • memberRoleid
  • roleNamestring

    1–32 characters

  • contactCountinteger

    at least 0

  • joinedContactCountinteger

    at least 0

  • userCountinteger

    at least 0

  • membershipRevisioninteger

    at least 0

  • latestActivityAtstring · date-timenullable
  • synchronizationobject
    4 properties
    • statusstring
      pending failed completed
    • revisioninteger

      at least 0

    • notifyUserIdstringnullable
    • contactCursoridnullable
  • deletionCleanupobject
    1 property
    • statusstring
      pending failed completed
  • chatStyleobject
    2 properties
    • lightobjectnullable
      4 properties
      • backgroundobject
      • incomingobject
        2 properties
        • backgroundColorstring

          pattern ^#[0-9a-fA-F]{6}$

        • textColorstring

          pattern ^#[0-9a-fA-F]{6}$

      • outgoingobject
        2 properties
        • backgroundColorstring

          pattern ^#[0-9a-fA-F]{6}$

        • textColorstring

          pattern ^#[0-9a-fA-F]{6}$

      • accentobject
        3 properties
        • backgroundColorstring

          pattern ^#[0-9a-fA-F]{6}$

        • textColorstring

          pattern ^#[0-9a-fA-F]{6}$

        • foregroundColorstring

          pattern ^#[0-9a-fA-F]{6}$

    • darkobjectnullable
      4 properties
      • backgroundobject
      • incomingobject
        2 properties
        • backgroundColorstring

          pattern ^#[0-9a-fA-F]{6}$

        • textColorstring

          pattern ^#[0-9a-fA-F]{6}$

      • outgoingobject
        2 properties
        • backgroundColorstring

          pattern ^#[0-9a-fA-F]{6}$

        • textColorstring

          pattern ^#[0-9a-fA-F]{6}$

      • accentobject
        3 properties
        • backgroundColorstring

          pattern ^#[0-9a-fA-F]{6}$

        • textColorstring

          pattern ^#[0-9a-fA-F]{6}$

        • foregroundColorstring

          pattern ^#[0-9a-fA-F]{6}$

  • inheritedChatStyleobjectnullable

    inheritedChatStyle is null when the organization has no chat style.

    2 properties
    • lightobjectnullable
      4 properties
      • backgroundobject
      • incomingobject
        2 properties
        • backgroundColorstring

          pattern ^#[0-9a-fA-F]{6}$

        • textColorstring

          pattern ^#[0-9a-fA-F]{6}$

      • outgoingobject
        2 properties
        • backgroundColorstring

          pattern ^#[0-9a-fA-F]{6}$

        • textColorstring

          pattern ^#[0-9a-fA-F]{6}$

      • accentobject
        3 properties
        • backgroundColorstring

          pattern ^#[0-9a-fA-F]{6}$

        • textColorstring

          pattern ^#[0-9a-fA-F]{6}$

        • foregroundColorstring

          pattern ^#[0-9a-fA-F]{6}$

    • darkobjectnullable
      4 properties
      • backgroundobject
      • incomingobject
        2 properties
        • backgroundColorstring

          pattern ^#[0-9a-fA-F]{6}$

        • textColorstring

          pattern ^#[0-9a-fA-F]{6}$

      • outgoingobject
        2 properties
        • backgroundColorstring

          pattern ^#[0-9a-fA-F]{6}$

        • textColorstring

          pattern ^#[0-9a-fA-F]{6}$

      • accentobject
        3 properties
        • backgroundColorstring

          pattern ^#[0-9a-fA-F]{6}$

        • textColorstring

          pattern ^#[0-9a-fA-F]{6}$

        • foregroundColorstring

          pattern ^#[0-9a-fA-F]{6}$

  • parentobjectnullable

    parent is null when the team has no parent team.

    2 properties
    • _idid
    • namestring

      1–80 characters

  • subteamsobject[]

    subteams is empty when the team has a parent team.

    9 properties
    • _idid
    • namestring

      1–80 characters

    • descriptionstring

      at most 256 characters

    • avatarobjectnullable
      4 properties
      • resourcestring

        at least 1 characters

      • fileNamestring

        at most 128 characters

      • contentTypestring

        at most 75 characters

      • fileSizeBytesinteger

        at least 0

    • roleNamestring

      1–32 characters

    • contactCountinteger

      at least 0

    • joinedContactCountinteger

      at least 0

    • userCountinteger

      at least 0

    • latestActivityAtstring · date-timenullable
Response200
{
  "_id": "000000000000000000000001",
  "organization": "000000000000000000000001",
  "name": "string",
  "parentTeam": "000000000000000000000001",
  "description": "string",
  "avatar": {
    "resource": "string"
  },
  "membership": {
    "contactTypes": [
      "member"
    ],
    "segments": [
      "string"
    ],
    "departments": [
      "000000000000000000000001"
    ],
    "tags": [
      "string"
    ]
  },
  "memberRole": "000000000000000000000001",
  "roleName": "string",
  "contactCount": 0,
  "joinedContactCount": 0,
  "userCount": 0,
  "membershipRevision": 0,
  "latestActivityAt": "2026-06-15T22:30:00Z",
  "chatStyle": {
    "light": {
      "background": {
        "kind": "gradient",
        "colors": [
          "string"
        ],
        "position": 0,
        "animated": true,
        "speed": 0.25,
        "pattern": {
          "assetId": "string",
          "opacity": 0,
          "scale": 0.5,
          "mode": "overlay"
        }
      },
      "incoming": {
        "backgroundColor": "string",
        "textColor": "string"
      },
      "outgoing": {
        "backgroundColor": "string",
        "textColor": "string"
      },
      "accent": {
        "backgroundColor": "string",
        "textColor": "string",
        "foregroundColor": "string"
      }
    },
    "dark": {
      "background": {
        "kind": "gradient",
        "colors": [
          "string"
        ],
        "position": 0,
        "animated": true,
        "speed": 0.25,
        "pattern": {
          "assetId": "string",
          "opacity": 0,
          "scale": 0.5,
          "mode": "overlay"
        }
      },
      "incoming": {
        "backgroundColor": "string",
        "textColor": "string"
      },
      "outgoing": {
        "backgroundColor": "string",
        "textColor": "string"
      },
      "accent": {
        "backgroundColor": "string",
        "textColor": "string",
        "foregroundColor": "string"
      }
    }
  },
  "inheritedChatStyle": {
    "light": {
      "background": {
        "kind": "gradient",
        "colors": [
          "string"
        ],
        "position": 0,
        "animated": true,
        "speed": 0.25,
        "pattern": {
          "assetId": "string",
          "opacity": 0,
          "scale": 0.5,
          "mode": "overlay"
        }
      },
      "incoming": {
        "backgroundColor": "string",
        "textColor": "string"
      },
      "outgoing": {
        "backgroundColor": "string",
        "textColor": "string"
      },
      "accent": {
        "backgroundColor": "string",
        "textColor": "string",
        "foregroundColor": "string"
      }
    },
    "dark": {
      "background": {
        "kind": "gradient",
        "colors": [
          "string"
        ],
        "position": 0,
        "animated": true,
        "speed": 0.25,
        "pattern": {
          "assetId": "string",
          "opacity": 0,
          "scale": 0.5,
          "mode": "overlay"
        }
      },
      "incoming": {
        "backgroundColor": "string",
        "textColor": "string"
      },
      "outgoing": {
        "backgroundColor": "string",
        "textColor": "string"
      },
      "accent": {
        "backgroundColor": "string",
        "textColor": "string",
        "foregroundColor": "string"
      }
    }
  },
  "parent": {
    "_id": "000000000000000000000001",
    "name": "string"
  },
  "subteams": [
    {
      "_id": "000000000000000000000001",
      "name": "string",
      "description": "string",
      "avatar": {
        "resource": "string"
      },
      "roleName": "string",
      "contactCount": 0,
      "joinedContactCount": 0,
      "userCount": 0,
      "latestActivityAt": "2026-06-15T22:30:00Z"
    }
  ]
}

Errors

Other errors

StatusErrorWhen
404The team was not foundIf the team is not found in the organization, the endpoint returns HTTP 404 with routes.connect.teams.notFound.

Errors nearly every request can meet are listed under Errors.