API Documentation

List Change Requests

get
https://api.split.io/internal/api/v2/changeRequests

Retrieves change requests scoped to a specific workspace and environment. GET endpoints like List Change Requests do not accept a JSON body—all inputs are provided using query parameters.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Access requirements

The Authorization Bearer (Admin API Key authorizing the request) must have one of the following roles and scopes:

Admin API Key roles accepted

  • API_ALL_GRANTED
  • API_FEATURE_FLAG_VIEWER*
  • API_FEATURE_FLAG_EDITOR*
  • API_SEGMENT_VIEWER**
  • API_SEGMENT_EDITOR**

Admin API Key scopes accepted

  • GLOBAL
  • WORKSPACE
  • ENVIRONMENT



To learn more about Admin API Key roles and scopes, see API keys overview.

  • workspaceId is required for all requests that don't specify an environment ID or use a migrated Split API key.
  • environmentId must belong to the specified project (or workspace) if both workspaceId and environmentId are specified.

If the request is authorized using a migrated Split API key, the API returns change requests across all projects (workspaces) and environments, even if workspaceId or environmentId is not provided.

Query Params
string
Defaults to REQUESTED

These are valid statuses: REQUESTED, SCHEDULE_REQUESTED, APPROVED, REJECTED, WITHDRAWN, PUBLISHED. By default, the API returns REQUESTED change requests.

string

1-100 are the potential values. The default limit is 20 per page.

string

Value of "previousMarker" in response

string

Value of "nextMarker" in response

string
required

Limits the change requests to those for a particular environment within the specified project (or workspace).

Only required if workspaceId is not set.

string
Defaults to Split | Segment
string
required

Limits the change requests to those for a particular project (or workspace).

Only required if environmentId is not set.

Responses

Updated 7 months ago

Language
LoadingLoading…
Response
Choose an example:
application/json

Updated 7 months ago