Sign in

List custom fields

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

Lists the organization's metadata keys (the custom-field catalog). Keys are created automatically the first time a value is written for them (via Data Capture or the customer/{id}/metadata endpoint) — this endpoint is mainly for building pickers and management screens. type is a best-effort hint (text / number / date) inferred from the values seen; label is an optional friendly name set by an admin.

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.

Query parameters

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

Responses

{
    "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