Skip to main content
GET
List branches on the policy

Path Parameters

policyId
string
required

the policy id

Query Parameters

whenAt
string

Optional: the whenAt datetime

simulatedAt
string

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