Skip to content
Okta Admin Management API
/
Access Controls
/
/
List all policy branches

List all policy branches

Request

Early AccessIdentity Engine
OAuth 2.0 scope:
  • okta.policies.read

Lists all branches for a policy. All branches, including LIVE and STAGED or DRAFT branches, are returned in the response.

Only applicable to ACCESS_POLICY type policies.

Path
policyIdstringrequired

id of the ACCESS_POLICY

Example:rst1d7xus97faIAgmti0
GET
/api/v1/policies/{policyId}/branches
curl -i -X GET \
  https://subdomain.okta.com/api/v1/policies/rst1d7xus97faIAgmti0/branches

Responses

Success

Bodyapplication/json
Array [
branchInformationobject(PolicyBranchInformation)

Information about the branch of the policy object, including its status

conditionsstring or null

Policy conditions aren't supported for ACCESS_POLICY. Conditions are applied at the rule level.

Default:null
createdstring, (date-time)read-only

Timestamp when the policy branch was created

descriptionstring

Description of the policy

idstringread-only

Identifier of the policy

lastUpdatedstring, (date-time)read-only

Timestamp when the policy branch was last modified

namestringrequired

Name of the policy

priorityinteger

Specifies the order in which this policy is evaluated in relation to the other policies

statusstring(LifecycleStatus)

Whether or not the policy is active. Use the activate query parameter to set the status of a policy.

Enum:"ACTIVE""INACTIVE"
systemboolean

Specifies whether Okta created the policy

Default:false
typestringrequired

Policy type. Branching is only supported for ACCESS_POLICY policies.

Value:"ACCESS_POLICY"
_embeddedobjectread-only
]
Response
[
  {
    "id": "rst1d7xus97faIAgmti0",
    "status": "ACTIVE",
    "name": "Production Branch",
    "description": "Current live production configuration",
    "priority": 1,
    "system": false,
    "type": "ACCESS_POLICY",
    "conditions": null,
    "created": "2026-01-15T08:30:00.000Z",
    "lastUpdated": "2026-04-01T10:15:30.000Z",
    "branchInformation": { … },
    "_links": { … }
  },
  {
    "id": "rst2k8pqr14hbJCnzuj0",
    "status": "ACTIVE",
    "name": "Q2 Security Updates",
    "description": "Testing stricter authentication requirements for Q2 2026",
    "priority": 1,
    "system": false,
    "type": "ACCESS_POLICY",
    "conditions": null,
    "created": "2026-04-01T10:15:30.000Z",
    "lastUpdated": "2026-04-15T14:22:45.000Z",
    "branchInformation": { … },
    "_links": { … }
  },
  {
    "id": "rst3m9wxy25icKDo0vk1",
    "status": "ACTIVE",
    "name": "MFA Pilot Test",
    "description": "Testing enhanced MFA requirements for pilot users",
    "priority": 1,
    "system": false,
    "type": "ACCESS_POLICY",
    "conditions": null,
    "created": "2026-03-10T09:00:00.000Z",
    "lastUpdated": "2026-03-25T16:45:00.000Z",
    "branchInformation": { … },
    "_links": { … }
  }
]