On this page
orgPlugin
query · in the family Org plugin
What it does
Look up one record — a per-organization plugin enablement — which registered extensions run at this organization.
A OrgPlugin by id, within the caller's OWN org-group family; requires authentication. A cross-tenant id reads as null (not-found) AND trips the rootId tripwire server-side.
What happens
Reads only — changes nothing.
Who may call it
Capability area: System and integration setup — Registers, connections and the settings your systems run on.
- Owner
- System Administrator
- An API key whose scope allows
api:orgPlugin
Arguments
| Name | Type | Required | Notes |
|---|---|---|---|
id | ID ID! | yes | The id of the record. |
Returns
OrgPlugin — An OrgPlugin selection — the per-org ENABLEMENT of a group Plugin. Parent = the ORGANIZATION (not the family root). Freely deactivatable/doomable; a NON-doomed selection blocks the master Plugin doom only. CONFLICT/UNSELECTED is reserved for future org-scoped plugin references (none exist v1 — the enablement itself is the v1 product).
Example request
query ExampleOrgPlugin($id: ID!) {
orgPlugin(id: $id) {
id
sysId
type
caption
status
parentId
rootId
createdAt
updatedAt
revisionNum
revision
pluginId
code
}
}
Variables:
{
"id": "01900000-0000-7000-8000-37386ae00000"
}
Example response
{
"data": {
"orgPlugin": {
"id": "01900000-0000-7000-8000-37386ae00000",
"sysId": "EP-EXMP-0000-000F",
"type": "OrgPlugin",
"caption": "Blue jeans",
"status": "active",
"parentId": "01900000-0000-7000-8000-065235280000",
"rootId": "01900000-0000-7000-8000-a093dd800000",
"createdAt": "2027-01-31T00:00:00.000Z",
"updatedAt": "2027-01-31T00:00:00.000Z",
"revisionNum": 1,
"revision": "01900000-0000-7000-8000-b7960e180000",
"pluginId": "01900000-0000-7000-8000-bf0997d70000",
"code": "BJ-001"
}
},
"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)NOT_FOUND/*— That record could not be found. (NOT_FOUND)