Sign in

v1

latestOpenAPI 3.0.32026-07-26120117318.1 KB
Remote Configurations

Get a remote configuration

Returns a single remote configuration by ID, including its read-only inline payload values ({} when unset).

get/remote-configurations/{config_id}

Path parameters

config_idstring required

Remote configuration identifier.

Response

Remote configuration details

objectstring required
idstring required

Remote configuration identifier (UUID).

urlstring required

Canonical API path.

namestring required

Display name.

statusstring required

Lifecycle status. Only active configurations are served to the SDK. archived is terminal. Change via PATCH /remote-configurations/{config_id}/status.

context_keystring nullable

Optional stable key the SDK uses to look up this configuration.

segment_percentnumber required

Percentage (0–100) of the targeted audience that receives this configuration. 100 targets the whole audience.

priorityinteger nullable required

Resolution priority when a user matches multiple configurations (read-only). null until the configuration is first activated.

started_atstring date-time nullable

When the configuration was activated. null while in draft.

finished_atstring date-time nullable

When the configuration was archived. null while not archived.

last_applied_atstring date-time nullable

When the configuration was last served to a user.

created_atstring date-time required

ISO 8601 creation timestamp.

updated_atstring date-time required

ISO 8601 last update timestamp.

payloadobject

Read-only copy of the JSON payload values delivered to the SDK ({} when unset). Edit via the payload endpoint, not this field.

Example response

{
  "object": "remote_configuration",
  "id": "82a42dc2-76f6-46c2-b883-846acaf2070a",
  "url": "/v4/remote-configurations/82a42dc2-76f6-46c2-b883-846acaf2070a",
  "name": "Onboarding copy",
  "status": "active",
  "context_key": "onboarding_copy_v1",
  "segment_percent": 100,
  "segmentation_conditions": [
    {
      "code": "platform",
      "comparator": "in",
      "type": "string",
      "values": [
        "ios",
        "android"
      ]
    }
  ],
  "priority": 1,
  "started_at": "2025-11-03T10:26:40Z",
  "created_at": "2025-09-15T12:30:00Z",
  "updated_at": "2025-11-03T10:26:40Z",
  "payload": {
    "button_color": "#FF0000",
    "max_items": 5
  }
}