APG PayAPG Paydocs

Operations

Get feature flag

GET/feature-flags/{featureFlagId}
Request
GEThttps://api.tst.au.apgpay.dev/feature-flags/{featureFlagId}
curl -X GET https://api.tst.au.apgpay.dev/feature-flags/{featureFlagId} \
  -H "Authorization: Bearer $API_KEY"

Return one flag by name, with who it is on for.

Permissions

Required permission
queues:query

Requires the `query` action on `queues` for the supplied runtime context

Path parameters

featureFlagIdstring
required

Responses

The response is a tagged shape: type is always "FflagViewAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.

Discriminated by type
type = "FflagViewAttributes"
featureFlagIdstringrequired

The flag's name, which is also its id. Only the flags the platform declares exist.

descriptionstringrequired

What the flag turns on.

modeFflagModerequired

Who it is on for before its lists.

OffPlatformEveryoneUnknown
tenantsarray of string

Enterprises, marketplaces, merchants and customers it is on for, by contextual id. A tenant takes every tenant beneath it with it.

usersarray of string

People it is on for, whatever tenant they sign in to: an IAM user's id (user_), or a legacy staff member's key (staff_ and the SHA-256 of their trimmed, lower-cased email address).

savedbooleanrequired

Whether a platform admin has changed it. Until one does, it is on for whom this environment's default says.

Example true

heldClosedbooleanrequired

True where what is saved cannot be read. The flag is then on for the platform alone, if its default is on for the platform, and for no tenant or person, until it is next changed.

Example true

versioninteger (int32)

How many times it has been changed. Absent until it first is.

Example 1250

updatedAtstring (date-time)

When it was last changed. Absent until it first is.

Example 2026-08-19T04:21:07Z

updatedBystring

Who last changed it, keyed as users keys a person. Absent until it first is.

Example
{
  "type": "FflagViewAttributes",
  "featureFlagId": "string",
  "description": "string",
  "mode": "Off",
  "tenants": [
    "string"
  ],
  "users": [
    "string"
  ],
  "saved": true,
  "heldClosed": true,
  "version": 1250,
  "updatedAt": "2026-08-19T04:21:07Z",
  "updatedBy": "string"
}

Error responses