VoidhashDocs
DevelopersHelp centerGuidesAPI reference
Dashboard
Essentials
API overview
Authentication
Event capture
Push device API
Webhooks
Webhook delivery
Webhook events
Projects & keys
Projects
API keys
Audit log
Customers & access
Persons
Products
Perks
Sandbox
Paywalls
Paywalls
Paywall locations
Components
Component registry
Assets
Experiments & flags
Experiments
Feature flags
Analytics & events
Analytics
Analytics alerts
Cohorts
Group types
Groups
Events
Ingest policy
VoidQL
Tracking domains
Ads
Ads
Ad accounts
Meta measurement
Payments & stores
Payment providers
Payment provider products
Purchase history imports
Payment sources
Webhooks & notifications
Webhooks
Push notifications
Push configurations
Automations
Organization & team
Organizations
Members
Invitations
Billing
Your account
Profile
Session
Notices
Connected apps
Terms of Service
Developer tools
Schema
SDK
List feature flags
Create a feature flag
Evaluate flags for an end user
Retrieve a feature flag
Update a feature flag
Archive a feature flag
Unarchive a feature flag
List a flag's variants
Replace a flag's variants
Set who gets a flag in an environment
Make test follow production
List a flag's overrides
Set an override
Remove an override
List an end user's overrides

List a flag's overrides

Lists the end users the flag is fixed on or off for in an environment, whatever its rules say.

Test's are production's while test follows it.

Guide: Feature flags and A/B tests

GET
/api/v1/projects/{projectId}/feature-flags/{featureFlagId}/overrides

Authorization

AuthorizationBearer <token>

A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.

In: header

Path parameters

projectId*string

The project's id, proj_.... A secret key works only in the project it belongs to.

featureFlagId*string

The flag's id, ff_....

Query parameters

cursor?string

Where the page starts: the pageInfo.endCursor of the previous page. Omit it for the first page.

limit?integer

How many items to return, from 1 to 100. Defaults to 50.

Range1 <= value <= 100
environment?string

The environment whose overrides are meant: production, the default, or test. Setting or removing one in test gives test a configuration of its own, started from production's.

Value in

  • "production"
  • "test"

Examples

curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/feature-flags/ff_v8b3n5q0w2e7h7d2k9m4x1c6/overrides" \  -H "Authorization: Bearer vh_sk_..."
{  "data": [    {      "featureFlagId": "ff_v8b3n5q0w2e7h7d2k9m4x1c6",      "environment": "production",      "identityType": "email",      "identityValue": "ada@example.com",      "isEnabled": true,      "variantKey": null,      "note": "QA device for the new checkout"    }  ],  "pageInfo": {    "endCursor": null,    "hasNextPage": false  }}
{  "error": {    "type": "invalid_request",    "code": "invalid_query",    "message": "The request query is invalid: Expected a finite number\n  at [\"limit\"]"  }}
{  "error": {    "type": "unauthenticated",    "code": "invalid_api_key",    "message": "This secret key is not valid."  }}
{  "error": {    "type": "permission_denied",    "code": "permission_denied",    "message": "Insufficient permissions."  }}
{  "error": {    "type": "not_found",    "code": "project_not_found",    "message": "There is no project proj_tz4a98xxat96iws9zmbrgj3a, or this credential cannot use it.",    "param": "projectId"  }}
{  "error": {    "type": "internal",    "code": "internal_error",    "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing."  }}

Response body

application/json

application/json

application/json

application/json

application/json

application/json

Errors

This operation adds no error codes of its own. It can fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Feature flags

  • List feature flags GET
  • Create a feature flag POST
  • Evaluate flags for an end user POST
  • Retrieve a feature flag GET
  • Update a feature flag PATCH
  • Archive a feature flag POST
  • Unarchive a feature flag POST
  • List a flag's variants GET
  • Replace a flag's variants PUT
  • Set who gets a flag in an environment PUT
  • Make test follow production DELETE
  • Set an override PUT
  • Remove an override DELETE
  • List an end user's overrides GET

Something wrong or missing on this page? Tell us by email or on Discord.

PreviousMake test follow productionNextSet an override

On this page

AuthorizationPath parametersQuery parametersExamplesResponse bodyErrorsMore in Feature flags