Sign in

Get interface

GET https://{organization}.myguper.com/api/integration/interface/{id}

Returns a single interface by id. Implicit org filter — returns 404 if the id belongs to another org.

Try-it values populated from environment ACME (Demo)


Authentication

Signature

Server-to-server RSA signature in the signature header plus User-Agent identifying the caller service. Same scheme used by every other internal Guper API (loyalty, register, order, etc.). No user token — this service is consumed only by other services and by the admin panel through its proxy.

Headers

Name Type Description
signature * string RSA signature `account.service.token` validated against the org public key.
User-Agent * string Caller service name (e.g. `middleware`, `loyalty`).
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Responses

{"id": 41, "organization": "xpto", "slug": "ecommerce", "name": "E-commerce", "source": "vtex", "activated": "2026-01-15T10:00:00+00:00"}
Copied to clipboard