Users

Get CRB users

get/crbs/{crb_id}/users

Request

Path parameters

crb_idstring required

CRB Id

Query parameters

include_archivedboolean

Include archived users

Response

Ok

idstring uuid required
first_namestring required

First Name

middle_initialstring nullable required

Middle Initial

last_namestring required

Last Name

emailstring required

Email

phonestring required

Phone Number - (###) ####-####

role'account_owner' | 'admin' | 'standard' required

User's role within the CRB

status'pending' | 'confirmed' | 'confirmed_verified' | 'archived' required

User's account status. Pending users have not accepted their invitation, confirmed users have, and confirmed_verified users have also uploaded their identity information.

created_onstring date-time required
last_loginstring date-time nullable required
addressstring nullable required

Street Address

citystring required

City

state'AL' | 'AK' | 'AZ' | 'AR' | 'AS' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FM' | 'FL' | 'GA' | 'GU' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MH' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'MP' | 'OH' | 'OK' | 'OR' | 'PW' | 'PA' | 'PR' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UM' | 'UT' | 'VT' | 'VA' | 'VI' | 'WA' | 'WV' | 'WI' | 'WY' | 'AA' | 'AE' | 'AP' required

Enumeration of all of the United States

zipstring required

Postal Code

date_of_birthstring nullable required

Date of Birth

ssnstring nullable required

Social Security Number

Changes

No recorded changes to this operation across all 1 revision of this API.