Skip to content
campaiDeveloper
campai.com

Connect · Team roles

GET/connect/organizations/{organizationId}/team-roles/{roleId}Reads only

Get team role

Returns a team role for the specified organization and role IDs. Actor details in the role 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 access to the organization and the team.read permission.

Request

Path parameters

  • organizationIdidrequired
  • roleIdidrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request GET 'https://cloud.campai.com/api/connect/organizations/YOUR_ORGANIZATION_ID/team-roles/YOUR_ROLE_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–32 characters

  • descriptionstring

    at most 256 characters

  • permissionsobject
    5 properties
    • contactobject
      10 properties
      • readobject of boolean
        Keys: one of 7 values
        member address customer sponsor contributor employee supplier
      • communicationboolean
      • personalboolean
      • departmentsboolean
      • groupsboolean
      • billingboolean
      • contractsboolean
      • notesboolean
      • proofsCertificatesboolean
      • tagsboolean
    • userobject of boolean
      Keys: one of 3 values
      list read chat
    • chatobject
      22 properties
      • createActivityboolean
      • createPollboolean
      • createAvailabilityboolean
      • createSignupboolean
      • createChecklistboolean
      • createFormboolean
      • createChallengeboolean
      • participatePollboolean
      • participateAvailabilityboolean
      • participateSignupboolean
      • participateChecklistboolean
      • participateFormboolean
      • participateChallengeboolean
      • manageActivitiesboolean
      • replyboolean
      • reactboolean
      • mentionboolean
      • mentionEveryoneboolean
      • manageboolean
      • changeAppearanceboolean
      • pinboolean
      • viewContactNameboolean
    • todoobject of boolean
      Keys: one of 2 values
      read manage
    • fileobject of boolean
      Keys: one of 4 values
      view manageFolders manageOwnFiles manageAllFiles
  • referenceRevisioninteger

    at least 0

Response200
{
  "_id": "000000000000000000000001",
  "organization": "000000000000000000000001",
  "name": "string",
  "description": "string",
  "permissions": {
    "contact": {
      "read": {
        "key": true
      },
      "communication": true,
      "personal": true
    },
    "user": {
      "key": true
    },
    "chat": {
      "createActivity": true,
      "createPoll": true,
      "createAvailability": true
    }
  }
}

Errors

Other errors

StatusErrorWhen
404The team role was not foundIf the role is not found in the specified organization, the endpoint returns HTTP 404 NOT_FOUND with message key routes.connect.teams.roles.notFound.

Errors nearly every request can meet are listed under Errors.