GET
/
v1
/
organizations
/
{organizationId}
/
groups
/
{groupId}
curl --request GET \
  --url https://live.copilot.fabric.inc/data-customer/v1/organizations/{organizationId}/groups/{groupId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-site-context: <x-site-context>'
{
  "_id": "61604a30fdfacd0009816e44",
  "parentUserId": "61604a30fdfacd0019816e44",
  "userId": "61604a30fdfacd0029816e44",
  "parentPartyId": "61604a30fdfacd0039816e44",
  "partyId": "61604a30fdfacd0049816e44",
  "parentGroupId": "61604a30fdfacd0049816e55",
  "groupType": "Department",
  "name": "name of the group",
  "email": "group3@example.com",
  "primaryPhone": 134343433,
  "additionalAttributes": {},
  "isDeleted": false,
  "createdAt": "2021-08-30T23:20:42.822Z",
  "updatedAt": "2021-08-30T23:20:42.822Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Path Parameters

​
organizationId
string
required

Fabric internal id of the record.

Example:

"619fbb95969ceb49d19cd5a8"

​
groupId
string
required

Fabric internal id of the record.

Example:

"619fbb95969ceb49d19cd5a8"

Response

200
application/json
OK
​
_id
string

Fabric internal id of the record

Example:

"61604a30fdfacd0009816e44"

​
parentUserId
string

Fabric internal id of the parent user record

Example:

"61604a30fdfacd0019816e44"

​
userId
string

Fabric internal id of the user record

Example:

"61604a30fdfacd0029816e44"

​
parentPartyId
string

Fabric internal id of the parent party record

Example:

"61604a30fdfacd0039816e44"

​
partyId
string

Fabric internal id of the party record

Example:

"61604a30fdfacd0049816e44"

​
parentGroupId
string

Fabric internal id of the group parent record

Example:

"61604a30fdfacd0049816e55"

​
groupType
enum<string>

group type

Available options:
Department,
Subsidiary,
Business Unit,
Team,
User,
Customer
Example:

"Department"

​
name
string

group3

Example:

"name of the group"

​
email
string

email of the group

Example:

"group3@example.com"

​
primaryPhone
string

primary phone of the group

Example:

134343433

​
additionalAttributes
object

Contains all additional attributes not captured in the schema.

​
isDeleted
boolean

flag that indicates if the record is deleted

Example:

false

​
createdAt
string

date of creation of the record

Example:

"2021-08-30T23:20:42.822Z"

​
updatedAt
string

laste date of update of the record

Example:

"2021-08-30T23:20:42.822Z"

Was this page helpful?