Entrar

Listar campos personalizados

GET https://{organization}.myguper.com/api/register/custom-field

Lista as chaves de metadado da organização (o catálogo custom-field). As chaves são criadas automaticamente na primeira vez que um valor é gravado para elas (via Data Capture ou o endpoint customer/{id}/metadata) — este endpoint serve principalmente para montar seletores e telas de gestão. type é uma dica best-effort (text / number / date) inferida dos valores; label é um nome amigável opcional definido por um admin.

Try-it values populated from environment ACME (Demo)


Autenticação

Token

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

Cabeçalhos

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.

Parâmetros de query

Name Type Description
q object Listing filters (see the List query parameters guide).
p integer Page number.
e integer Entries per page.

Respostas

{
    "list": [
        { "id": 1, "metaKey": "kid_birthday", "label": "Kid's birthday", "type": "date" },
        { "id": 2, "metaKey": "shirt_size",   "label": null,             "type": "text" }
    ],
    "page": 1,
    "pages": 1
}
Copied to clipboard