younifyd
Menu

/api/users/getGroupById/{groupId} (Get ChatGroupDto by groupId)

Get ChatGroupDto by groupId

GET/api/users/getGroupById/{groupId}

Use it in a workflow

  1. Add a step and choose the TradeBeyond connector.
  2. Pick the /api/users/getGroupById/{groupId} (Get ChatGroupDto by groupId) action (under CbxUserController).
  3. Fill in the fields below, then reference the result from later steps as {{apiUsersGetgroupbyidGroupidGetChatgroupdtoByGroupid.response.data}}.

Request

Path parameters

groupIdstringrequired

Response

Returns 200 with an object. Read it in later steps with {{apiUsersGetgroupbyidGroupidGetChatgroupdtoByGroupid.response.data.<field>}}.

idstring
namestring
domainIdstring
usersarray<object>
idstring
fromImportboolean
deleteCommentFieldInfoListarray<object>3 fields
get_overrideCreateUserstring
get_overrideCreateUserNamestring
get_overrideUpdateUserstring
get_overrideUpdateUserNamestring
get_overrideCreatedOnstring (date-time)
get_overrideUpdatedOnstring (date-time)
get_overrideStatusstring
userNamestring
firstNamestring
lastNamestring
photoIdobject15 fields
domainIdstring
defaultWorkingDomainIdstring
companyNamestring
docStatusstring
json
{
  "id": "string",
  "name": "string",
  "domainId": "string",
  "users": [
    {
      "id": "string",
      "fromImport": false,
      "deleteCommentFieldInfoList": [
        {
          "uiId": "string",
          "businessKey": "string",
          "internalSeqNo": 0
        }
      ],
      "get_overrideCreateUser": "string",
      "get_overrideCreateUserName": "string",
      "get_overrideUpdateUser": "string",
      "get_overrideUpdateUserName": "string",
      "get_overrideCreatedOn": "2025-01-01T00:00:00Z",
      "get_overrideUpdatedOn": "2025-01-01T00:00:00Z",
      "get_overrideStatus": "string",
      "userName": "string",
      "firstName": "string"
    }
  ]
}

Need more? See the TradeBeyond guide for connection setup and behaviour shared by every action.