Get list of all insureds

📘

API Refs

• Production: Get list of all insureds
• Staging: Get list of all insureds

Request

Query params

Name	Type	Description	Required
value	string	The value that will be used to filter the email of all insured	no
take	string	Number of users returned. The value must be between 0 and 250	yes
skip	array of Users (see User table)	Number of skipped users. The value must be greater than or equal to 0	yes

Response body

Name	Type	Description	Required
total	string	The total count of all your insureds.	yes
users	array of Users (see User table)	The array of users	yes

User

Name	Type	Description	Required
email	string	The user's email address. This value will be used for all future notifications and web-app logins for this user, so choose carefully.	yes
firstName	string	The user's legal first name.	yes
lastName	string	The user's legal last name.	yes
businessName	string	The user's business name, if applicable. Providing a value here will cause this user to be created as an Unverified Business type, otherwise they will be an Unverified Personal type.	no

Example

1. Get list of all insureds Request;
2. Get list of all insureds Response:
   JSON

   {
     total: 2,
     users: [
       {
         "id": 1,
         "email": "[email protected]",
         "firstName": "John",
         "lastName": "Smith"
       },
       {
         "id": 2,
         "email": "[email protected]",
         "firstName": "Jake",
         "lastName": "Stone"
       }
     ]
   }
   

Description

❗️

You can only receive information about insureds that you created yourself through our API.

📘

To get more information about insured, go to Get insured information

This endpoint returns the insured list you created with Create insured.

The returned information contains only basic information:

• id;
• email;
• first name;
• last name;
• business name.

Returned info can be filtered by email.