operation get api v1 apply sessions.md
List all sessions
GET /api/v1/apply/sessions
Returns a list of insurance application Sessions.
Servers
- Production server: https://api.1099policy.com (Production server)
Parameters
Query parameters
limit (integer)
A limit on the number of objects to be returned. Limit can range between1and100, and the default is10.starting_after (string)
A cursor for use in pagination.starting_afteris an application session ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withias_fOo123, your subsequent call can includestarting_after=ias_fOo123in order to fetch the next page of the list.ending_before (string)
A cursor for use in pagination.ending_beforeis an application session ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withias_bAr123, your subsequent call can includeending_before=ias_bAr123in order to fetch the previous page of the list.contractor (string)
Filter sessions by contractor ID (e.g.,cn_Ehb3bYa).is_general_opt_in (boolean)
Filter sessions by general opt-in flag. Set totrueto return only general opt-in sessions,falseto return only standard sessions, or omit to return all sessions.
Responses
200
Returns an array of session objects. If no more sessions are available, the resulting array will be empty.
Body: application/json (array[object])
cancel_url (string)
The URL the contractor will be directed to if they are ineligible or decide to abandon the insurance application and return to your website.created (integer(int64))
expired (boolean)
Indicates whether the insurance application session has expired. If true, the contractor will be redirected to the cancel_url.id (string)
quote (string)
The ID of the quote associated with the insurance application session.step (string)
The step in the insurance application process that the contractor is currently on. The contractor will be redirected to this step when they return to the insurance application. One ofverify_info,application_questions,esignature_document,add_card_details,final_review, orapplication_complete.success_url (string)
The URL to which 1099Policy should direct independent contractors when a contractor successfully procures insurance coverage.url (string)
The URL to the insurance application Session. Redirect customers to this URL to take them to their insurance application. The domain will use apply.1099policy.com.