Sign in

Get person ref (by role)

GET https://{organization}.myguper.com/api/register/{interface}/person/{role}/{refId}

Reads the person linked to this refId for the given {role} under the {interface}. Returns 404 if no ref exists for that combination. Roles are independent: the same refId can resolve to different persons in different roles.

Try-it values populated from environment ACME (Demo)


Authentication

Token

Send your user token in the x-guper-authorization header.

Headers

Name Type Description
x-guper-authorization * string User token issued by Guper.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Responses

{"id":620977,"name":"Alice","_ref":{"source":"vtex","refId":"99","role":"cashier"}}
Copied to clipboard