Member applications
The member applications resource is used to track member applications.
Member application object
{
"id": "0198c930-d9a2-7343-8780-58a8bdbbb92a",
"tenant": "01988bb8-1cfb-7c87-9326-93op0349288e",
"contact": "0198c815-d2c0-7b64-b9e2-djaaqgzap5r3",
"application_identifier": null,
"status": "01988bb8-2071-7da1-aac5-0c313a9d2025",
"applied_at": "2025-08-12 20:22:00",
"veteran": false,
"national_id": "999-99-9999",
"gender_identity": "other",
"race": "white",
"sexual_orientation": "undisclosed",
"language": "english",
"housing_type": "family",
"housing_minors": false,
"housing_minors_acs": false,
"housing_homeless": false,
"housing_homeless_12mo": false,
"housing_homeless_details": null,
"clubhouse_transportation": "vehicle_friend",
"clubhouse_tour": true,
"clubhouse_goal": "employment",
"clubhouse_why": null,
"clubhouse_challenges": null,
"benefits_ssi_id": null,
"benefits_ssi_amount": 0,
"benefits_ssi_date_start": null,
"benefits_ssi_payee": null,
"benefits_ssdi_id": null,
"benefits_ssdi_amount": 0,
"benefits_ssdi_date_start": null,
"benefits_ssdi_payee": null,
"benefits_snap_amount": 0,
"benefits_public_amount": 0,
"benefits_retirement_amount": 0,
"benefits_veteran_amount": 0,
"insurance_medicaid_id": null,
"insurance_medicaid_provider": null,
"insurance_medicaid_date_effective": null,
"insurance_medicaid_company": null,
"insurance_medicare_id": null,
"insurance_medicare_provider": null,
"insurance_medicare_date_effective": null,
"insurance_private_id": null,
"insurance_private_provider": null,
"insurance_private_date_effective": null,
"education": "some_college",
"employment_current": false,
"employment_12mo": false,
"employment_history": false,
"medical_accessibility_needs": null,
"medical_allergies": null,
"medical_conditions": [
"mobility"
],
"medical_conditions_other": null,
"medical_diagnosis_primary": "bipolar",
"medical_diagnosis_secondary": "ptsd",
"medical_diagnosis_other": null,
"medical_medications": null,
"substance_tobacco_current": false,
"substance_tobacco_12mo": false,
"substance_tobacco_history": false,
"substance_alcohol_current": false,
"substance_alcohol_12mo": false,
"substance_alcohol_history": false,
"substance_drug_current": false,
"substance_drug_12mo": false,
"substance_drug_history": false,
"substance_notes": null,
"legal_jail": false,
"legal_prison": false,
"legal_misdemeanor": false,
"legal_felony": false,
"legal_injured": false,
"legal_violence": false,
"legal_12mo": false,
"legal_details": null,
"contact_referrer": null,
"contact_psychiatrist": null,
"contact_psychiatrist_date_start": null,
"contact_primary_care": null,
"contact_primary_care_date_start": null,
"contact_therapist": null,
"contact_therapist_date_start": null,
"notes": null,
"meta": null,
"archived_at": null,
"created_at": "2025-08-20 20:34:38",
"updated_at": "2025-12-19 15:49:31"
}
Fields
- idrequired readonly stringUnique ID of the record.
- tenantrequired readonly stringUnique ID of the tenant.
- contactrequired stringUnique ID of the contact.
- application_identifiernullable stringUnique identifier for the application within the tenant.
- statusnullable stringUnique ID of the application status.
- applied_atrequired stringUTC timestamp of when the application was submitted.
- veteranbooleanWhether the applicant is a veteran. The default value is
false. - national_idnullable stringNational ID (i.e.: Social Security number) of the applicant.
- gender_identityrequired stringGender identity of the applicant. One of:
manwomantransgender_mangransgender_womannon_binaryother
- racerequired stringRace of the applicant. One of:
alaskan_indianlatinohawaiian_islanderasianblackwhiteother
- sexual_orientationrequired stringSexual orientation of the applicant. One of:
heterosexualbisexuallesbiangayotherundisclosed
- languagerequired stringPrimary language of the applicant. One of:
afrikaansakanalbanianamharicarabicarmenianassameseazerbaijanibasquebelarusianbengalibosnianbulgarianburmesecatalancebuanochichewachinese_cantonesechinese_mandarincorsicancroatianczechdanishdaridutchdzongkhaenglishesperantoestonianewefilipino_tagalogfinnishfrenchfrisiangaliciangeorgiangermangreekguaranigujaratihaitian_creolehausahawaiianhebrewhindihmonghungarianicelandicigboindonesianirishitalianjapanesejavanesekannadakazakhkhmerkinyarwandakoreankurdish_kurmanjikurdish_soranikyrgyzlaolatinlatvianlingalalithuanianluxembourgishmacedonianmalagasymalaymalayalammaltesemaorimarathimongoliannepalinorwegiannyanjaodia_oriyaoromopashtopersian_farsipolishportuguesepunjabiquechuaromanianrussiansamoanscots_gaelicserbiansesothoshonasign_languagesindhisinhalaslovaksloveniansomalispanish
- housing_typerequired stringHousing type of the applicant. One of:
alf(Assisted Living Facility)ownfamilyfriendgroup(Group home)sro(Single Room Occupancy)subsidizedsupervisedsupportivenursingshelterhomelessunknown
- housing_minorsbooleanWhether the applicant lives with minors. The default value is
false. - housing_minors_acsbooleanWhether the applicant has had an open ACS (Administration for Children's Services) case. The default value is
false. - housing_homelessbooleanWhether the applicant has a history of homelessness. The default value is
false. - housing_homeless_12mobooleanWhether the applicant has been homeless in the last 12 months. The default value is
false. - housing_homeless_detailsnullable stringDetails about the applicant's history of homelessness.
- clubhouse_transportationrequired stringTransportation method used by the applicant to get to the Clubhouse. One of:
bicycleclubhousepublictaxivehicle_friendvehicle_selfwalkother
- clubhouse_tourbooleanWhether the applicant has taken a tour of the Clubhouse. The default values is
false. - clubhouse_goalrequired stringApplicant's main goal for joining the Clubhouse. One of:
communityeducationemploymenthealthbenefitshousingother
- clubhouse_whynullable stringApplicant's response to why they feel the Clubhouse would be a good place for them.
- clubhouse_challengesnullable stringApplicant's response to what challenges or barriers are keeping them from achieving their goals.
- benefits_ssi_idnullable stringApplicant's Supplemental Security Income (SSI) ID.
- benefits_ssi_amountnullable integerApplicant's Supplemental Security Income (SSI) amount (monthly).
- benefits_ssi_date_startnullable stringUTC date of when the applicant's Supplemental Security Income (SSI) started.
- benefits_ssi_payeenullable stringApplicant's Supplemental Security Income (SSI) payee.
- benefits_ssdi_idnullable stringApplicant's Social Security Disability Insurance (SSDI) ID.
- benefits_ssdi_amountnullable integerApplicant's Social Security Disability Insurance (SSDI)
- benefits_ssdi_date_startnullable stringUTC date of when the applicant's Social Security Disability Insurance (SSDI) started.
- benefits_ssdi_payeenullable stringApplicant's Social Security Disability Insurance (SSDI) payee.
- benefits_snap_amountnullable integerApplicant's Supplemental Nutrition Assistance Program (SNAP) amount (monthly).
- benefits_public_amountnullable integerApplicant's public assistance amount (monthly).
- benefits_retirement_amountnullable integerApplicant's retirement benefits amount (monthly).
- benefits_veteran_amountnullable integerApplicant's veteran benefits amount (monthly).
- insurance_medicaid_idnullable stringApplicant's Medicaid ID.
- insurance_medicaid_providernullable stringApplicant's Medicaid provider.
- insurance_medicaid_date_effectivenullable stringUTC date of when the applicant's Medicaid coverage started.
- insurance_medicaid_companynullable stringApplicant's Medicaid company.
- insurance_medicare_idnullable stringApplicant's Medicare ID.
- insurance_medicare_providernullable stringApplicant's Medicare provider.
- insurance_medicare_date_effectivenullable stringUTC date of when the applicant's Medicare coverage started.
- insurance_private_idnullable stringApplicant's private insurance ID.
- insurance_private_providernullable stringApplicant's private insurance provider.
- insurance_private_date_effectivenullable stringUTC date of when the applicant's private insurance coverage started.
- educationrequired stringApplicant's highest level of education. One of:
nonesome_high_schoolgedhigh_schooltrade_schoolsome_collegeassociatesbachelorssome_graduatemastersadvanced
- employment_currentbooleanWhether the applicant is currently employed. The default value is
false. - employment_12mobooleanWhether the applicant has been employed in the last 12 months. The default value is
false. - employment_historybooleanWhether the applicant has a history of employment. The default value is
false. - medical_accessibility_needsnullable stringApplicant's accessibility needs.
- medical_allergiesnullable stringApplicant's allergies.
- medical_conditionsnullable arrayList of applicant's medical conditions. One or more of:
mobilityasthmavisualemphysemaseizureallergynew_psychiatric_medicationhearingdiabeteshypertensionother
- medical_conditions_othernullable stringApplicant's other medical conditions.
- medical_diagnosis_primarynullable stringApplicant's primary psychiatric diagnosis. One of:
adhdanxietyasd(Autism Spectrum Disorder)bipolargad(Generalized Anxiety Disorder)major_depressive_disorderocd(Obsessive Compulsive Disorder)panic(Panic Disorder)ptsd(Post-Traumatic Stress Disorder)schizoaffectiveschizophreniaother
- medical_diagnosis_secondarynullable stringApplicant's secondary psychiatric diagnosis. One of:
adhdanxietyasd(Autism Spectrum Disorder)bipolargad(Generalized Anxiety Disorder)major_depressive_disorderocd(Obsessive Compulsive Disorder)panic(Panic Disorder)ptsd(Post-Traumatic Stress Disorder)schizoaffectiveschizophreniaother
- medical_diagnosis_othernullable stringApplicant's other psychiatric diagnosis.
- medical_medicationsnullable stringApplicant's medications.
- substance_tobacco_currentbooleanWhether the applicant currently uses tobacco. The default value is
false. - substance_tobacco_12mobooleanWhether the applicant has used tobacco in the last 12 months. The default value is
false. - substance_tobacco_historybooleanWhether the applicant has a history of tobacco use. The default value is
false. - substance_alcohol_currentbooleanWhether the applicant currently abuses alcohol. The default value is
false. - substance_alcohol_12mobooleanWhether the applicant has abused alcohol in the last 12 months. The default value is
false. - substance_alcohol_historybooleanWhether the applicant has a history of alcohol abuse. The default value is
false. - substance_drug_currentbooleanWhether the applicant currently abuses drugs. The default value is
false. - substance_drug_12mobooleanWhether the applicant has abused drugs in the last 12 months. The default value is
false. - substance_drug_historybooleanWhether the applicant has a history of drug abuse. The default value is
false. - substance_notesnullable stringNotes about the applicant's substance use.
- legal_jailbooleanWhether the applicant has been in jail. The default value is
false. - legal_prisonbooleanWhether the applicant has been in prison. The default value is
false. - legal_misdemeanorbooleanWhether the applicant has a misdemeanor conviction. The default value is
false. - legal_felonybooleanWhether the applicant has a felony conviction. The default value is
false. - legal_injuredbooleanWhether the applicant has ever physically injured another person. The default value is
false. - legal_violencebooleanWhether the applicant has a history of violent behavior. The default value is
false. - legal_12mobooleanWhether the applicant has had any legal issues in the last 12 months. The default value is
false. - legal_detailsnullable stringDetails about the applicant's legal history.
- contact_referrernullable stringContact ID of the applicant's referrer.
- contact_psychiatristnullable stringContact ID of the applicant's Psychiatrist.
- contact_psychiatrist_date_startnullable stringUTC date of when the applicant started seeing their psychiatrist.
- contact_primary_carenullable stringContact ID of the applicant's Primary Care Physician.
- contact_primary_care_date_startnullable stringUTC date of when the applicant started seeing their primary care physician.
- contact_therapistnullable stringContact ID of the applicant's therapist.
- contact_therapist_date_startnullable stringUTC date of when the applicant started seeing their therapist.
- notesnullable stringApplication notes.
- metanullable objectAdditional metadata about the application.
- archived_atnullable stringUTC timestamp of when the record was archived.
- created_atrequired readonly stringUTC timestamp of when the record was created.
- updated_atnullable readonly stringUTC timestamp of when the record was last updated.
Create a member application
POST /tenants/{tenantId}/member-applications
The request body must include a member application object.
Required permissions
member_applications:create contacts:read options:read
Response
| HTTP status | Title | Description | Schema |
|---|---|---|---|
| 201 | Created | Successfully created | Member application object |
| 400 | Bad Request | Invalid or missing field(s) | Error object |
| 404 | Not Found | Tenant not found | Error object |
List member applications
GET /tenants/{tenantId}/member-applications
Required permissions
member_applications:read contacts:read options:read
Response
| HTTP status | Title | Description | Schema |
|---|---|---|---|
| 200 | OK | An associative array of member application objects | |
| 400 | Bad Request | Invalid parameters in the request query | Error object |
| 404 | Not Found | Tenant not found | Error object |
Read a member application
GET /tenants/{tenantId}/member-applications/{id}
Required permissions
member_applications:read contacts:read options:read
Response
| HTTP status | Title | Description | Schema |
|---|---|---|---|
| 200 | OK | Member application object | |
| 400 | Bad Request | Invalid parameters in the request query | Error object |
| 404 | Not Found | Tenant or application ID not found | Error object |
Update a member application
PATCH /tenants/{tenantId}/member-applications/{id}
The request body must include parts of a member application object.
Required permissions
member_applications:update contacts:read options:read
Response
| HTTP status | Title | Description | Schema |
|---|---|---|---|
| 200 | OK | Updated member application record | Member application object |
| 400 | Bad Request | Invalid or missing field(s) | Error object |
| 404 | Not Found | Tenant or application ID not found | Error object |
Delete a member application
DELETE /tenants/{tenantId}/member-applications/{id}
Required permissions
member_applications:delete
Response
| HTTP status | Title | Description | Schema |
|---|---|---|---|
| 204 | No content | Successfully deleted | |
| 404 | Not Found | Tenant ID not found | Error object |
Was this page helpful?