On this page
myOrganizationGroup
query · in the family Reading your records
What it does
Your own organization group — the tenant root: its name, code, classification, status, and owners.
Your OWN organization group. SELF BY CONSTRUCTION (no target arg exists — the principal's rootId). Projects the identity + governance facts ONLY (the referral provenance and the standings are NOT projected). Requires authentication (the staff planes — user, api, and collaborator sessions).
What happens
A read of the one group record your session belongs to. Nothing here is editable from a session — the group is born at onboarding and governed by the platform.
Who may call it
Capability area: Reading your records — Looking up and listing the records of your organization.
- Owner
- System Administrator
- Manager
- Associate Manager
- Warehouse Associate
- Sales Associate
- An API key whose scope allows
api:myOrganizationGroup
Returns
OrganizationGroup OrganizationGroup! — The calling principal's OWN organization group. The identity + governance facts ONLY — the referral provenance and the standings are NOT projected.
Example request
query ExampleMyOrganizationGroup {
myOrganizationGroup {
id
sysId
type
caption
status
code
classification
owners
convertedFrom
tosAcceptedVersion
createdAt
updatedAt
revisionNum
}
}
Example response
{
"data": {
"myOrganizationGroup": {
"id": "01900000-0000-7000-8000-37386ae00000",
"sysId": "OG-EXMP-0000-000F",
"type": "OrganizationGroup",
"caption": "Blue jeans",
"status": "<status>",
"code": "BJ-001",
"classification": "<classification>",
"owners": [
"01900000-0000-7000-8000-f89daae50000"
],
"convertedFrom": "<converted from>",
"tosAcceptedVersion": "<tos accepted version>",
"createdAt": "2027-01-31T00:00:00.000Z",
"updatedAt": "2027-01-31T00:00:00.000Z",
"revisionNum": 1
}
},
"extensions": {
"at": {
"callId": "01EXAMPLE-CALL-ID",
"version": {
"requested": null,
"serviced": {
"name": "genesis",
"number": 0
}
}
}
}
}
Errors this call can answer
VALIDATION/INVALID— Something in the request is not valid. (VALIDATION)AUTHN/REQUIRED— Sign in to do this. (AUTHN)AUTHZ/FORBIDDEN— Your role does not allow this action. (AUTHZ)RATE_LIMIT/THROTTLED— Too many requests in a short time. (RATE_LIMIT)