Root Embedded API

Documentation
- Get v3 openapi specget
Agency
Policy
Address
- Validate addresspost
Bridge Link
- Create bridge linkpost
- Authenticate bridge linkpost
Legal Documents
Braintree Payments
- Create Braintree client tokenpost
- Get Braintree customerget
Prefill
- Create prefill reportpost
- Get prefill reportget
Quoting
YearMakeModel
- Get YearMakeModelget

Root Embedded API

Documentation
- Get v3 openapi specget
Agency
Policy
Address
- Validate addresspost
Bridge Link
- Create bridge linkpost
- Authenticate bridge linkpost
Legal Documents
Braintree Payments
- Create Braintree client tokenpost
- Get Braintree customerget
Prefill
- Create prefill reportpost
- Get prefill reportget
Quoting
YearMakeModel
- Get YearMakeModelget

Get policies for your agency

get https://app.partner-testing.joinroot.com/bind_api/v3/agency/policies

Retrieves a list of policies associated with your agency. Optionally, you can provide parameters to limit and/or filter your query.

URL Expired

The URL for this request expired after 30 days.

Query Params

active

boolean

Whether or not the found policies will be active.

agent_id

string

The agent id the found policies will have.

policyholder_email

string

The policyholder email the found policies will have.

limit

integer

The maximum number of policies to return. This defaults to unlimited.

offset

integer

The number of policies to offset before returning a number of policies up to the passed limit. This defaults to 0 and the offset is by created_at descending.

Responses

Response body

object

currentOffset

integer

The query offset passed in this request. Defaults to 0.

error

string

The error message.

policies

array of objects

A collection of policies associated with the agency, which may be filtered based on specified criteria.

policies

object

active

boolean

Boolean for whether the policy is currently active.

policyNumber

string

The policy number for this policy.

createdAt

date

The date the policy was created.

string

The unique identifier for this policy. This can be used to retrieve the policy details.

string | null

The email associated with the primary named insured of the policy.

firstName

string

The first name of the primary named insured.

lastName

string

The last name of the primary named insured.

phoneNumber

string | null

The phone number of the primary named insured.

agentId

string

The id of the agent managing the policy.

totalPolicies

integer

The total number of policies associated with the agency.

Response body

object

message

string

required

The error message.

unauthorized

Response body

object

currentOffset

integer

The query offset passed in this request. Defaults to 0.

error

string

The error message.

policies

array of objects

A collection of policies associated with the agency, which may be filtered based on specified criteria.

policies

object

active

boolean

Boolean for whether the policy is currently active.

policyNumber

string

The policy number for this policy.

createdAt

date

The date the policy was created.

string

The unique identifier for this policy. This can be used to retrieve the policy details.

string | null

The email associated with the primary named insured of the policy.

firstName

string

The first name of the primary named insured.

lastName

string

The last name of the primary named insured.

phoneNumber

string | null

The phone number of the primary named insured.

agentId

string

The id of the agent managing the policy.

totalPolicies

integer

The total number of policies associated with the agency.

Updated 3 months ago

Get quotes for your agency

Policy

Did this page help you?

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://app.partner-testing.joinroot.com/bind_api/v3/agency/policies \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 3 months ago

Get quotes for your agency

Policy

Did this page help you?

Root Embedded API
Documentation
Get v3 openapi specget
Agency
Get policies for your agencyget
Get quotes for your agencyget
Get agent quotesget
Get agent policiesget
Get agentget
Get agency agentsget
Policy
Get policy documentsget
Get policy summaryget
Get payment informationget
Address
Validate addresspost
Bridge Link
Authenticate bridge linkpost
Create bridge linkpost
Legal Documents
Affirm legal documentspost
Get all legal documentsget
Get legal documentget
Braintree Payments
Get Braintree customerget
Create Braintree client tokenpost
Prefill
Get prefill reportget
Create prefill reportpost
Quoting
Bind policypost
Finalize quotepost
Get suggested coveragesget
Get coverage rules by stateget
Get coverage rulesget
Get available coverages by stateget
Get available coveragesget
(Experimental) Patch quotepatch
Get quoteget
Update quoteput
Create quotepost
YearMakeModel
Get YearMakeModelget

Root Embedded API
Documentation
Get v3 openapi specget
Agency
Get policies for your agencyget
Get quotes for your agencyget
Get agent quotesget
Get agent policiesget
Get agentget
Get agency agentsget
Policy
Get policy documentsget
Get policy summaryget
Get payment informationget
Address
Validate addresspost
Bridge Link
Authenticate bridge linkpost
Create bridge linkpost
Legal Documents
Affirm legal documentspost
Get all legal documentsget
Get legal documentget
Braintree Payments
Get Braintree customerget
Create Braintree client tokenpost
Prefill
Get prefill reportget
Create prefill reportpost
Quoting
Bind policypost
Finalize quotepost
Get suggested coveragesget
Get coverage rules by stateget
Get coverage rulesget
Get available coverages by stateget
Get available coveragesget
(Experimental) Patch quotepatch
Get quoteget
Update quoteput
Create quotepost
YearMakeModel
Get YearMakeModelget

200successful

401unauthorized

404agency not found