Skip to main content
GET
List branches on the policy

Authorizations

Authorization
string
header
required

Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.

Headers

tenant
string
required

Your tenant identifier. Requests without it are rejected.

Path Parameters

policyId
string
required

the policy id

Pattern: ^policy(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$

Query Parameters

whenAt
string<date-time>

Optional: the whenAt datetime

simulatedAt
string<date-time>

Optional: the simulatedAt datetime

branchType
enum<string>

the branch type

Available options:
BASE,
NEW_BUSINESS,
MTA,
RENEWAL,
REPRICING
branchStatus
enum<string>

the branch status

Available options:
BRANCH_OPEN,
BRANCH_MERGED,
BRANCH_CLOSED

Response

total
number
required

Total number of policies

offset
number
required

Offset used for pagination

limit
number
required

Page size used for pagination

data
object[]
required

List of policies