Sign in

List person refs (by role)

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

Lists every external person ref for the given {role} (cashier/salesperson/manager/client) under the {interface}. Returns each ref's personId, name and _ref metadata (including role).

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"}},{"id":620980,"name":"Bob","_ref":{"source":"vtex","refId":"100","role":"cashier"}}]
Copied to clipboard