curl -X GET "https://api.nonefivem.com/cloud/flags?page=1&limit=20&search=hud" \
-H "Authorization: Bearer your-api-key"
const response = await fetch(
"https://api.nonefivem.com/cloud/flags?page=1&limit=20",
{
headers: { Authorization: "Bearer your-api-key" }
}
);
const result = await response.json();
{
"results": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "new-hud",
"name": "New HUD",
"description": "Rolls out the redesigned heads-up display",
"type": "boolean",
"value": true,
"runtime": "shared",
"archived": false,
"locked": false,
"createdAt": "2026-09-01T10:00:00.000Z",
"updatedAt": "2026-09-19T12:00:00.000Z"
}
],
"quota": {
"max": 50,
"used": 12,
"subscribed": true,
"locked": 0
},
"total": 12,
"page": 1,
"totalPages": 1
}
Feature Flags
List Feature Flags
List your organization’s feature flags with pagination and search
GET
/
flags
curl -X GET "https://api.nonefivem.com/cloud/flags?page=1&limit=20&search=hud" \
-H "Authorization: Bearer your-api-key"
const response = await fetch(
"https://api.nonefivem.com/cloud/flags?page=1&limit=20",
{
headers: { Authorization: "Bearer your-api-key" }
}
);
const result = await response.json();
{
"results": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "new-hud",
"name": "New HUD",
"description": "Rolls out the redesigned heads-up display",
"type": "boolean",
"value": true,
"runtime": "shared",
"archived": false,
"locked": false,
"createdAt": "2026-09-01T10:00:00.000Z",
"updatedAt": "2026-09-19T12:00:00.000Z"
}
],
"quota": {
"max": 50,
"used": 12,
"subscribed": true,
"locked": 0
},
"total": 12,
"page": 1,
"totalPages": 1
}
Retrieve a paginated list of your organization’s flags, along with your current flag allowance.
To read flag values on a game server, use
GET /flags/config instead — it is cached
at the edge and built for polling. This endpoint is for dashboards and
management tooling.Authorization
string
required
Bearer token for authentication. Format:
Bearer <your-api-key>Required Permission
FLAGS_READ
Query Parameters
number
default:"1"
Page number (1-indexed).
number
default:"20"
Number of flags per page (1–100).
string
Case-insensitive substring match against the flag’s key and name.
boolean
default:"false"
Whether archived flags are included. Accepts
true, false, 1 or 0.Response
FeatureFlag[]
The flags on this page, newest first.
Show FeatureFlag properties
Show FeatureFlag properties
string
Unique identifier (UUID). This is what you pass to the update and delete
endpoints.
string
The immutable slug your code reads the flag by.
string
Human-readable name.
string | null
Optional description.
string
boolean, string, number, or json.JsonValue
The flag’s current value.
string
shared or server.boolean
Whether the flag is archived. Archived flags are excluded from the config
payload but keep their key reserved.
boolean
True when this flag sits beyond your current allowance. Locked flags keep
serving their published values but cannot be edited until you subscribe
again or remove enough flags. See Feature
Flags.
string
ISO 8601 timestamp.
string
ISO 8601 timestamp.
FeatureFlagQuota
Your organization’s flag allowance. Identical to the body of
GET /flags/quota.number
Total flags matching the filter.
number
Current page number.
number
Total number of pages.
curl -X GET "https://api.nonefivem.com/cloud/flags?page=1&limit=20&search=hud" \
-H "Authorization: Bearer your-api-key"
const response = await fetch(
"https://api.nonefivem.com/cloud/flags?page=1&limit=20",
{
headers: { Authorization: "Bearer your-api-key" }
}
);
const result = await response.json();
{
"results": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "new-hud",
"name": "New HUD",
"description": "Rolls out the redesigned heads-up display",
"type": "boolean",
"value": true,
"runtime": "shared",
"archived": false,
"locked": false,
"createdAt": "2026-09-01T10:00:00.000Z",
"updatedAt": "2026-09-19T12:00:00.000Z"
}
],
"quota": {
"max": 50,
"used": 12,
"subscribed": true,
"locked": 0
},
"total": 12,
"page": 1,
"totalPages": 1
}