PlanSource API

The PlanSource API Developer Hub

Welcome to the PlanSource API developer hub. You'll find comprehensive guides and documentation to help you start working with PlanSource API as quickly as possible, as well as support if you get stuck. Let us help you jump right in!

Administrators Fields

Administrators

Listed below are the data fields that can be accessed for Administrators data using PlanSource's API. Each field is described as being "optional". That is because developers are not required to fill out every data field in order to make the API call. Although that is the case, PlanSource does require certain data fields to be entered in order to POST/PUT/GET Administrators data. What is required can be changed manually within the PlanSource Benefits Admin site by utilizing the Data Field Security configuration.

NOTE: Some of these fields are list validated fields. To learn what that means, visit the Guide on List Validated Fields.

Administrators Fields
Data Types
Field Descriptions

user

role object

User role object. Define fields and their values within this role object

administrator

role object

Administrator role object. Define fields and their values within this role object

id

integer

Administrator unique ID retrieved when making a GET call.

type

string

Administrator Type

user_type

string

The administrator user type - organization administrator (org_admin) or master administrator (master_admin)

first_name

string

First Name

middle_name

string

Middle Name

last_name

string

Last Name

user_id

integer

User ID

phone

string

Phone

master_org_id

integer

Master Org ID

organization_id

integer

Organization ID

organization_codes

array

Organization codes. List of one or more organization codes the administrator has access or belongs to

is_agent

boolean

Is Agent

carrier_id

integer

Carrier ID

general_agency_id

integer

General Agency ID

fax

string

Fax

tax_id

integer

Tax ID

is_primary_administrator

boolean

Is Primary Administrator

is_data_discrepancy_contact

boolean

Is Data Discrepancy Contact

receive_system_downtime_notifications

boolean

Receive System Downtime Notifications

receive_system_release_notes

boolean

Receive System Release Notes

receive_renewal_notifications

boolean

Receive Renewal Notifications

receive_ticket_notifications

boolean

Receive Ticket Notifications

far_lookup_code

string

Data field security lookup code. Default value is update_all

account_initialized

boolean

Account Initialized. Either true or false

populations

array

Populations

(within array populations) id

integer

ID of population.

(within array populations) name

string

Name of population

org_populations

array

Organization populations. List of one or more population codes is required if creating organization administrator

roles

array

Roles

(within array roles) ID

integer

ID of roles.

(within array roles) name

string

Name of roles

user_name

string

User Name

email

string

Email

email2

string

Email 2

name

string

Name

override_sso

boolean

Override SSO

time_zone

string

Time zone

Administrators Fields


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.