Get a person
This page needs your own installation with an Embed license.
GET/
Returns one person, with every workspace they have a role in.
Needs a partner key: Authorization: Bearer gre_…, from Platform › Partner keys. Call it from your server only.
Parameters
Path
userIdRequired · stringYour ID for the person: 1 to 255 bytes, case-sensitive.
Responses
- 200OK
The person.
The person’s ID isn’t allowed as written.
details.fieldnames it.- 404
NOT_FOUNDYou have no person with this ID.
Something failed on the installation’s side. Try again.
Any call can also answer: 401 UNAUTHORIZED · 403 EMBED_NOT_LICENSED · 403 IP_NOT_ALLOWED · 429 RATE_LIMITED · 503 BUSY. See Errors.
Request
GORUNNER="https://automations.example.com"
GORUNNER_EMBED_KEY="YOUR_PARTNER_KEY" # gre_…
USER_ID="ada-123"
curl "$GORUNNER/api/embed/v1/users/$USER_ID" \
-H "Authorization: Bearer $GORUNNER_EMBED_KEY"const GORUNNER = "https://automations.example.com";
const KEY = process.env.GORUNNER_EMBED_KEY; // gre_…
const USER_ID = encodeURIComponent("ada-123");
const res = await fetch(
`${GORUNNER}/api/embed/v1/users/${USER_ID}`,
{
headers: { Authorization: `Bearer ${KEY}` },
},
);
const { data } = await res.json();import os, requests
from urllib.parse import quote
GORUNNER = "https://automations.example.com"
KEY = os.environ["GORUNNER_EMBED_KEY"] # gre_…
USER_ID = quote("ada-123", safe="")
res = requests.get(
f"{GORUNNER}/api/embed/v1/users/{USER_ID}",
headers={"Authorization": f"Bearer {KEY}"},
)
data = res.json()["data"]Response · 200 OK
{
"data": {
"id": "ada-123",
"name": "Ada Lovelace",
"email": "ada@bakery.example",
"memberships": [
{
"account": {
"id": "acct-bakery",
"name": "Bakery Ltd"
},
"workspace": {
"id": null,
"default": true
},
"role": "editor"
}
],
"createdAt": "2026-10-20T08:00:00Z",
"updatedAt": "2026-10-25T09:00:00Z"
}
}Every field
It takes no body.
Response · 200 OK
dataobjectidstringnamestringemailstring or nullmembershipsarray of objectsaccountobjectidstringnamestringworkspaceobjectidstring or nullThe partner’s workspace id; null for the default workspace.
defaultbooleanrolestringOne of
viewer,operator,editor.createdAttimeupdatedAttime