Last Updated:
CCA Data API (1.0.0)
Key Terminology
| Entity | Description |
|---|---|
| IntakeData | An inbound service request from an organization's employee. Submitting an IntakeData record is the primary method for triggering CCA's internal case-management process. After submission, integration partners can look up the record to determine whether it produced a Case or an InformationCall. In rare cases (for example, a duplicate submission), the record is marked to reflect that nothing further was created from it. |
| Case | Created by CCA after evaluating an IntakeData request that requires clinical assistance or intervention. Also called a File, CaseFile, ClientFile, or EAP File. A Case is linked to a Patient and an Organization and retains a history of calls, appointments, and other touch points. Case status is not currently exposed through the API. |
| InformationCall | Created by CCA after evaluating an IntakeData request that requires a call-back from CCA to provide information to patients. |
| WorkLifeCase | Non-clinical cases that provide general work/life situation support — for example, helping a member find a caregiver for a family member. |
| SAP | Cases that are part of the Student Assistance Program. |
Important Notes
Integration partners cannot create Patient or Case records directly. Submitting an IntakeData record is the primary method for triggering workflows; CCA then evaluates eligibility and generates downstream records.
If an intake has been created for a member, do we submit one for every subsequent service request, or is there a separate flow after the first touchpoint?
- Every new request must go through the same intake submission process, even for members who have already submitted requests before.
- There are multiple ways CCA can receive a request from a member (a help line, an online form, an API, etc.). Because of this, the only reliable way to link together all of a member's requests is manually, by the CCA team during intake review. There are also medical privacy reasons for keeping individual requests from being automatically linked and tracked.
What does it mean when an IntakeData record shows no Case or InformationCall was created from it?
- Only under rare circumstances will an IntakeData record not be processed by CCA — for example, a duplicate submission.
This documentation is based on the raw API documentation located at https://cca-api-uat.eapexpert.com/index.html.
Technical Guardrails
All API integrations are subject to standard rate limiting to ensure platform stability. The Data API is limited to 5 requests per second. Invalid or missing credentials return 401 Unauthorized. Schema and request-validation failures return 400 Bad Request.
APIs for retrieving EAP case data, patient records, organization details, and work-life service records.
See Data & Reporting for a high-level overview of the entities and lifecycle before integrating.
Authentication
Basic Auth, using the username and password provided to you for the given environment.
Example Request
curl --location 'https://cca-api-uat.eapexpert.com/case?dateOpenedFrom=2025-01-01T00:00:00Z' \ --header 'Authorization: Basic XXXXX'
Security
Production API requests are limited by IP, which have to be provided to CCA prior to real data access via the API.
Rate Limits
The rate limit for these API endpoints is 5 requests per second.
Authentication
Scheme: http basic
HTTP Basic Auth credentials provided by CCA per environment.
Servers
| Environment | Base URL |
|---|---|
| Production API server | https://cca-api.eapexpert.com |
| Staging / UAT API server | https://cca-api-uat.eapexpert.com |
Authentication failure (401)
Every endpoint in this API returns HTTP 401 when the username or password is missing or incorrect, so one handler covers them all. The response body always has this shape:
| Field | Type | Details |
|---|---|---|
detail | string | Example: "Invalid or missing credentials" |
code | string | Example: "UNAUTHORIZED" |
Example
{
"detail": "Invalid or missing credentials",
"code": "UNAUTHORIZED"
}Get intake status by ID
See Main Concepts & Entities for explanation and schema.
Query parameters
| Parameter | Type | Details |
|---|---|---|
| IntakeId | string | The oid of the IntakeData record returned from POST /IntakeDataExample: "bad4b610-7678-48d9-adf9-da9085ebc49e" |
Example request
Generated from the specification, so values match the documented fields above.
curl -X GET "https://cca-api.eapexpert.com/IntakeData?IntakeId=bad4b610-7678-48d9-adf9-da9085ebc49e" \ -u "$CCA_USERNAME:$CCA_PASSWORD"
Responses
| Field | Type | Nullable | Format | Details |
|---|---|---|---|---|
Oid | string | uuid | UUID of the IntakeData record. Example: "bad4b610-7678-48d9-adf9-da9085ebc49e" | |
Organization | string or null | nullable | — | Gets or sets Organization. Example: "Acme Corporation" |
CallStart | string | date-time | Gets or sets CallStart. Example: "2025-03-15T09:00:00.000" | |
CallEnd | string | date-time | Gets or sets CallEnd. Example: "2025-03-15T09:30:00.000" | |
EmailAddress | string or null | nullable | — | Gets or sets EmailAddress. Example: "jane.doe@acme.com" |
FirstName | string or null | nullable | — | Gets or Sets FirstName. Example: "Jane" |
LastName | string or null | nullable | — | Gets or sets LastName. Example: "Doe" |
PreferredModality | string or null | nullable | — | Gets or sets PreferredModality. Values accepted: Telephonic, In-Person, Video. Example: "In-Person" |
CoverageThrough | integer | int32 | Gets or Sets value for Coverage through An Employee Assistance Program (EAP/MAP). Example: 1 | |
Gender | string or null | nullable | — | Gets or Sets Gender. Values: Male, Female, Unknown, Declined. Example: "Female" |
DateOfBirth | string | date-time | Gets or Sets DateOfBirth. Example: "1990-05-15T00:00:00.000" | |
PhoneType | string or null | nullable | — | Gets or Sets PhoneType. Values: Work, Home, Fax, Cell, Other. Example: "Cell" |
clientFileId | string or null | nullable | uuid | UUID of the Case created from this intake. Populated after CCA review. Example: "bad4b610-7678-48d9-adf9-da9085ebc49e" |
informationCallId | string or null | nullable | uuid | UUID of the InformationCall created instead of a Case, if applicable. Example: null |
status | stringenum | — | Status of the intake record. Allowed values: SuccessNo Client files / Information Call |
Example
{
"detail": "The requested resource was not found",
"code": "NOT_FOUND"
}Submit an intake (service request)
- Create an IntakeData object.
- Please review this link to better understand our case lifecycle.
- Please note that fields marked as *Free Form String* are non-validated pass-through values that do not trigger any business logic. They are for the benefit of the person handling / reviewing the case. In theory they can have any formatting. However, they are expected to be consistent through time unless there is a business / product reason requiring it to change.
- All string fields are limited to 100 characters, except for the Questions/CustomQuestion fields which have no limit.
Gender,MaritalStatus,ClientType,Question1, andCustomQuestion5must match one of the values listed on the field exactly, including capitalization, spacing, and punctuation. Any other value is rejected.Countrydecides how the address and phone number are validated.USapplies the US rules:+1plus 10 digits, a USPS state code, and a 5-digit postal code. Any other country accepts an international phone number and leavesStateandZipCodeunvalidated, so both may be null.Question1is required for every intake except work-life. Omit it on a work-life request.- Address line 2 uses the key
suite. Every other address field is PascalCase. - PHQ-9 and GAD-7 are submitted after this call.
POST /questionset/additionalinfoonce withQuestionSetNameAdditional Info - PHQ-9_Preand once withAdditional Info - GAD-7_Pre. SetIntakeIdto theoidfrom this response andQuestionSetResponsesto the answer map. - JSON Payload Parameters below:
Post body
| Field | Type | Details |
|---|---|---|
Organization | string | Patient's organization's name. This field needs to perfectly match the name of the organization in the system. We are aware this is not ideal. Example: "Acme Corporation" |
EmailAddress | string | Patient's Email Address. Example: "jane.doe@acme.com" |
FirstName | string | Patient's First Name. Example: "Jane" |
LastName | string | Patient's Last Name. Example: "Doe" |
Gender | stringenum | Patient's Gender. Maps to GenderIdentify on CCA's UI. Send the value exactly as spelled. Allowed values: AgenderBi-genderedFemaleGender FluidGender QueerIntersexMaleNon-Binary/Non-ConformingOtherPangenderTransgenderUnable to AnswerUnknown / Decline |
DateOfBirth | string | Patient's Date of Birth. Format: YYYY-MM-DD. Example: "1990-05-15" |
PhoneNumber | string | Patient phone number, sent as one value. There is no separate area code field. Concatenate the country calling code, the area or city code, and the subscriber number, with no spaces, hyphens, parentheses, or leading zeros on the area code. When Country is US, send +1 followed by exactly 10 digits, which is the 3-digit area code plus the 7-digit subscriber number. Area code 415 and number 555-1234 is sent as +14155551234.For every other country, send +, the country calling code, then the national number, up to 15 digits in total. A London number is sent as +442079460958.Maps to Phone.CellNumber on CCA's UI. Example: "+14155551234" |
LeaveMessage | boolean | True if patient approves getting voice mail messages. Maps to VoicemailPermission on CCA's UI. Example: true |
Street | string | Patient street address field. Maps to PrimaryAddress.Street on CCA's UI. Example: "123 Main St" |
suite | string or null | Address line 2, when the member has one. The key is lowercase. Every other address field is PascalCase. Example: "Apt 4B" |
City | string | Patient city address field. Example: "San Francisco" |
State | string or null | State, province, or region. When Country is US, send a USPS two-letter code. Accepted codes are the 50 states plus DC, PR, and VI. For every other country this is unvalidated free text, and may be null when the country has no equivalent. Always send the key.Example: "CA" |
ZipCode | string or null | Postal code. When Country is US, send exactly 5 digits. For every other country this is unvalidated free text, and may be null when the country has no equivalent. Always send the key. Maps to PrimaryAddress.ZipPostalCode on CCA's UI.Example: "94105" |
Country | string | ISO 3166-1 alpha-2 country code, stored as submitted. Send US for the United States. US selects US phone, state, and postal validation. Any other value uses international phone validation and does not check state or postal code.Example: "US" |
MaritalStatus | stringenum | Patient's marital status. Send the value exactly as spelled. Allowed values: Co-habitatingCommon-lawCo-ParentingDecline to AnswerDivorcedIn a relationshipMarriedPartnerSeparatedSingleUnable to AnswerWidowed |
ClientType | stringenum | Indicates the relationship the patient has with the organization. Allowed values: EmployeeSpouseFamily MemberHousehold Member |
WebSource | string | Integration partner string identifier (Human Readable). This field is chosen by the integration partner that uniquely identifies them, example: "Acme API". It should remain fixed and not change over time. It must have the word "API" at the end. Example: "Acme API" |
Question1 | stringenum | Intake Question - Reason Seeking Support. What topic were you looking to receive support with? Send the value exactly as spelled. Required on every flow except work-life, where this field is omitted. Allowed values: Self GrowthTraumaStressSuicide RiskDomestic ViolenceGrief/LossCouples CounselingWorkplace ViolenceSleep HygieneDepressionFamily/Relationship ConcernsParenting IssuesEating DisorderEmotional RegulationAnxietyAlcohol Use or AbuseMedical IssuesWorkplace ConflictOrganizational ChangeElder AbusePatient ViolenceLGBTQIA+ IssuesChild AbuseInappropriate Workplace BehaviorCare Giver SupportPregnancy issuesSubstance Use or AbuseAdjustment/ChangeAddiction ConcernsOtherExploring wellness goalsSupport for daily challengesWorkplace ConcernsGeneral Support |
CustomQuestion1 | string | Intake Question - Distance willing to travel for care. Example: "Within 10 miles" |
CustomQuestion2 | string | Provider preference, as free text. When the intake is a booking, CCA sets this to Requested Self Scheduling Provider {full name} or Requested Global Coach {full name}.Example: "No preference" |
CustomQuestion3 | string | Intake Question - Appointment date/time preferences. - The preferences must cover a window of at least 5 business days. - The end-user must be made fully aware that these are potential, not final, appointment times. - The value must be valid JSON. Beyond that there is no set format, since this field will be read by a human. The label should be descriptive. - Times are UTC. For example: {"selectedTime": "2026-07-01T10:00:00Z"} {
"selectedTime": "2026-07-01T10:00:00Z"
} |
CustomQuestion4 | string | Intake Question - Well-Being Scores. Collect responses to the following 4 questions (scale 0-10): 1. Your personal well-being on a scale of 0-10 (10 being the highest), how would you rate yourself over the last week 2. Your relationship connections on a scale of 0-10 3. Your engagement in social roles on a scale of 0-10 4. Your overall functioning on a scale from 0-10 Example: Last Week: 5. Relationships: 8. Social Engagement: 3. Overall Functioning: 5. Example: "Last Week: 5. Relationships: 8. Social Engagement: 3. Overall Functioning: 5." |
CustomQuestion5 | string | Service type, stored for CCA case review. Send one of: self-scheduling, work-life, online-intake, text-coaching, Call Center, global-coach-intake, global-coaching-self-scheduling.Example: "online-intake" |
CustomQuestion6 | string | JSON string containing optional external identifiers useful for cross system data association. externalReferenceId is deprecated.{
"externalIntakeId": 12345,
"externalUserId": "patient-00123",
"externalRequestId": "optional",
"externalReferenceId": "optional"
} |
CustomQuestion7 | string | JSON string of member fields, stored for CCA case review. On self-scheduling, online intake, telephony, and global coaching the object includes: - pronouns: He/Him, He/They, She/Her, She/They, They/Them, XE/XEM, or Other. Optional.- preferredName: optional string.- LeaveMessage: the same boolean as the top-level field.- preferredModality: Video Counseling, In-Person Counseling, or Telephonic Counseling. Global coaching always sends Video Counseling.- DateOfBirth: the same YYYY-MM-DD value as the top-level field.- preferredSpokenLanguage: the language name as free text, for example English.- preferredSpokenLanguageCode: the same language as a BCP-47 code (ISO 639-1, with an optional region or script subtag), for example en, en-US, or zh-Hans. Both needed for legacy purposes. - canSendTextMessages: whether the member consents to receive text messages. Optional boolean. Organization custom-intake answers are added on every flow except telephony. Each answer is a list, keyed by the field name configured for that organization. A work-life request is merged into this object as category, subCategory, requestName, and answers.{
"pronouns": "They/Them",
"preferredName": "Alex",
"LeaveMessage": true,
"preferredModality": "Video Counseling",
"DateOfBirth": "1990-05-15",
"preferredSpokenLanguage": "English",
"preferredSpokenLanguageCode": "en",
"canSendTextMessages": true
} |
CustomQuestion8 | string | JSON string of telephony risk-assessment answers, stored for CCA case review. PHQ-9 and GAD-7 are submitted with POST /questionset/additionalinfo after this call succeeds. |
CustomQuestion9 | string | Full address as a JSON string, stored for CCA case review. Keys: address1, address2, city, state, zipcode, country. Values match Street, suite, City, State, ZipCode, and Country.{
"address1": "123 Main St",
"address2": "Apt 4B",
"city": "San Francisco",
"state": "CA",
"zipcode": "94105",
"country": "US"
} |
CustomQuestion10 | string | Not currently in use. We can assign a purpose. |
Responses
| Field | Type | Nullable | Format | Details |
|---|---|---|---|---|
oid | string | uuid | UUID of the created IntakeData record. Store this to check status later. Example: "bad4b610-7678-48d9-adf9-da9085ebc49e" | |
clientFileId | string or null | nullable | uuid | UUID of the Case created from this intake. Populated after CCA review. Example: "bad4b610-7678-48d9-adf9-da9085ebc49e" |
informationCallId | string or null | nullable | uuid | UUID of the InformationCall created instead of a Case, if applicable. Example: null |
status | stringenum | — | Status of the intake record. - Success — processed normally.- No Client files / Information Call — intake was not processed (e.g., duplicate or withdrawn).Allowed values: SuccessNo Client files / Information Call |
Example
{
"detail": "Invalid request parameters",
"code": "INVALID_REQUEST"
}List EAP clinical cases
List cases that meet all of the given query parameters.
The API only returns clinical cases. It does not return WorkLife cases. We have requested this capability to our API vendor.
Recommended syncing strategy: - The recommended syncing strategy consists of having an initial sync job that fetches case data 24hrs (one day) per call, starting as far back as it makes sense, based on case opened date. - You might not be able to fetch cases over long periods of time, doing so might cause the request to timeout (500 Error). You may be able to get away with fetching a couple of days worth of data at a time. - Once you sync all historic cases based on dateOpenedFrom, we recommend switching to a daily job that fetches cases based on their lastModifiedFrom timestamp, and fetch cases updated within the past 24hrs.
A note about a case's lifecycle: - Inbound requests first appear in the system as IntakeData objects. Upon posting data to the /IntakeData endpoint, you may store the uuid of the IntakeData object created. This object stays "as is" and it's used as a template/source for the actual CaseFile (/case/{id}) created by the Ops team after review. See Main Concepts & Entities. - After that, the case may receive a series of updates, in particular to the serviceRequesterNotes which contains unstructured data. - Finally when the case is closed, the closeDate field will be updated.
Fields not listed in the response schema below should be ignored.
Query parameters
| Parameter | Type | Details |
|---|---|---|
| patientId | string | Filter by patient UUID |
| authorizationId | string | Filter by authorization UUID |
| organizationId | string | Filter by organization UUID |
| dateOpenedFrom | string | Filter cases opened on or after this date (ISO 8601) Example: "2025-01-01T00:00:00Z" |
| dateOpenedTo | string | Filter cases opened on or before this date (ISO 8601) Example: "2025-01-31T23:59:59Z" |
| lastModifiedFrom | string | Filter cases modified on or after this date (ISO 8601) Example: "2025-01-01T00:00:00Z" |
| lastModifiedTo | string | Filter cases modified on or before this date (ISO 8601) Example: "2025-01-31T23:59:59Z" |
| resultPage | integer | Page number for pagination (default 1) Default: 1 |
| resultLimit | integer | Number of results per page (default 100) Default: 100 |
Example request
Generated from the specification, so values match the documented fields above.
curl -X GET "https://cca-api.eapexpert.com/case?patientId=value&authorizationId=value&organizationId=value&dateOpenedFrom=2025-01-01T00%3A00%3A00Z&dateOpenedTo=2025-01-31T23%3A59%3A59Z&lastModifiedFrom=2025-01-01T00%3A00%3A00Z&lastModifiedTo=2025-01-31T23%3A59%3A59Z&resultPage=1&resultLimit=100" \ -u "$CCA_USERNAME:$CCA_PASSWORD"
Responses
Example
[
{
"id": "1a1a1a1a-1a1a-1a1a-1a1a-1a1a1a1a1a1a",
"preferredModality": "Virtual",
"orgId": "2b2b2b2b-2b2b-2b2b-2b2b-2b2b2b2b2b2b",
"patientId": "3c3c3c3c-3c3c-3c3c-3c3c-3c3c3c3c3c3c",
"clientType": "Employee",
"presentingCondition": {
"id": "4d4d4d4d-4d4d-4d4d-4d4d-4d4d4d4d4d4d",
"name": "Anxiety",
"active": true,
"sortOrder": 0
},
"dateOpened": "2025-03-15T09:00:00.000",
"lastModified": "2025-04-01T14:30:00.000",
"closeDate": null,
"surveyPermission": true,
"fileNumber": 1234567,
"fileType": "EAP File",
"caseStatusName": "P - Active Case"
}
]Get a single EAP clinical case
Same schema as the /case (search) endpoint, but only returns one case.
Path parameters
| Parameter | Type | Details |
|---|---|---|
| id | string | UUID of the case Example: "1a1a1a1a-1a1a-1a1a-1a1a-1a1a1a1a1a1a" |
Example request
Generated from the specification, so values match the documented fields above.
curl -X GET "https://cca-api.eapexpert.com/case/1a1a1a1a-1a1a-1a1a-1a1a-1a1a1a1a1a1a" \ -u "$CCA_USERNAME:$CCA_PASSWORD"
Responses
| Field | Type | Nullable | Format | Details |
|---|---|---|---|---|
id | string | uuid | Long alphanumeric ID (uuid) of the case. Example: "1a1a1a1a-1a1a-1a1a-1a1a-1a1a1a1a1a1a" | |
preferredModality | stringenum | — | The client/patient's preferred meeting/assistance modality. Allowed values: In PersonVirtualNo PreferenceTelephonicHybrid - in person / Virtual | |
orgId | string | uuid | Long alphanumeric ID of the client/patient's company. Example: "2b2b2b2b-2b2b-2b2b-2b2b-2b2b2b2b2b2b" | |
patientId | string | uuid | Long alphanumeric ID of the patient/client. Example: "3c3c3c3c-3c3c-3c3c-3c3c-3c3c3c3c3c3c" | |
clientType | stringenum | — | Indicates the relationship the patient has with the organization. Allowed values: EmployeeSpouseFamily MemberHousehold MemberDependent | |
presentingConditionobject | object | — | Patient/Client provided reason for seeking support. Value comes from Question1 (Reason for seeking support) of the intake endpoint. Only appears in Clinical Cases. | |
id | string | uuid | Example: "4d4d4d4d-4d4d-4d4d-4d4d-4d4d4d4d4d4d" | |
name | string | — | Example: "Anxiety" | |
active | boolean | — | Example: true | |
sortOrder | integer | — | Example: 0 | |
dateOpened | string | — | Date the case was opened. Format: YYYY-MM-DDTHH:MM:SS.s (ISO 8601). Example: "2025-03-15T09:00:00.000" | |
lastModified | string | — | Date the case was last modified/updated. Format: YYYY-MM-DDTHH:MM:SS.s (ISO 8601). Example: "2025-04-01T14:30:00.000" | |
closeDate | string or null | nullable | — | Date the case was closed. Format: YYYY-MM-DDTHH:MM:SS.s (ISO 8601). Example: null |
surveyPermission | boolean | — | Tells CCA's system that it is OK to send surveys to clients/patients. Example: true | |
fileNumber | integer | — | Human readable case numeric id. Reference number for billing purposes. Example: 1234567 | |
serviceRequesterNotes | string | — | > Note: This field is rather difficult to deal with. Unfortunately we have to work with this for now. The serviceRequesterNotes field displays initially unstructured plain text data as a poorly formatted HTML string. Depending on how the case originates (e.g. from the call center or from the members web portal), the field will contain plain text, or an HTML table.For reporting purposes, this field is only valuable for cases coming through the members portal. Cases coming through the call center are currently not well formatted.The following fields are relevant for reporting purposes: - Source — This is the WebSource field in the /IntakeData endpoint.- This field is chosen by the integration partner that uniquely identifies them, example: "Acme API". It should remain fixed and not change over time. It must have the word "API" at the end. - Internally CCA uses the following values, one per intake flow: "BeWell Self-Scheduling", "BeWell Online Intake", "BeWell Global Online Intake", "BeWell Text Coaching", "BeWell Global Worklife Intake", "Call Center Intake", "Global Coach Intake", "BeWell Global Coaching Self-Scheduling". - Online intake reports as "BeWell Online Intake" when Country is US, and "BeWell Global Online Intake" for every other country. The remaining values map one to one onto Custom Question 5.- Custom Question 5: string — Represents the service type. Possible values: self-scheduling, work-life, online-intake, text-coaching, Call Center, global-coach-intake, global-coaching-self-scheduling- Custom Question 6: json string — This field is mostly for CCA internal purposes, however, externalUserId will be present for users who sign up to the members portal via a link that contains the corresponding query parameter, which is used to match CCA internal users to users from existing external systems. | |
fileType | stringenum | — | Indicates the type of client file the record represents. For Clinical and Worklife files. Possible values: EAP File, Supervisor Referral File, SAP File, Onsite File, Worklife File, Life Expert File. Allowed values: EAP FileSupervisor Referral FileSAP FileOnsite FileWorklife FileLife Expert File | |
caseStatusName | string | — | Current status of the case. Possible Values: TBD. Example: "P - Active Case" | |
riskAtIntake | string or null | nullable | — | TBD. Coming Soon. |
userDefinedDropdown22 | string | — | Risk Level. Coming Soon. | |
referralSource | string | — | platform will always default to 'Luma'. | |
divisionId | string | — | TBD. Coming Soon. | |
caseClass | string | — | platform will always default to 'counseling'. | |
FileType | string | — | Client file type/name. TBD. | |
approvalRequired | boolean or null | nullable | — | Whether approval is required or not. Example: false |
sendSurveyTo | string or null | nullable | — | Email address to send survey to. Example: "jane.doe@acme.com" |
surveyToSend | string or null | nullable | — | Survey to send. Example: "CSAT & ECOMs(Post) Survey" |
sendSurveyMethod | string or null | nullable | — | How do you want to send survey. Example: "Email" |
nextAppointment | string or null | nullable | — | Gets or Sets Next Appointment Link. Example: null |
authorizationId | string or null | nullable | uuid | Gets or Sets AuthorizationId. Example: null |
providerId | string or null | nullable | uuid | Gets or Sets ProviderId. Example: null |
contractId | string or null | nullable | uuid | UUID of the contract associated with the case. Example: null |
assessedCondition | string or null | nullable | — | Assessed condition (set by CCA after review). Example: null |
openDate | string | — | Internal open date field. Example: "0001-01-01T00:00:00" | |
referralDate | string or null | nullable | — | Date the case was referred. Example: null |
depressionAtIntake | string or null | nullable | — | Depression score at intake. Coming Soon. |
preWosQues1 | integer | — | Pre Work Outcome Survey question 1 score. Example: 0 | |
preWosQues2 | integer | — | Pre Work Outcome Survey question 2 score. Example: 0 | |
preWosQues3 | integer | — | Pre Work Outcome Survey question 3 score. Example: 0 | |
preWosQues4 | integer | — | Pre Work Outcome Survey question 4 score. Example: 0 | |
preWosQues5 | integer | — | Pre Work Outcome Survey question 5 score. Example: 0 | |
postWosQues1 | integer | — | Post Work Outcome Survey question 1 score. Example: 0 | |
postWosQues2 | integer | — | Post Work Outcome Survey question 2 score. Example: 0 | |
postWosQues3 | integer | — | Post Work Outcome Survey question 3 score. Example: 0 | |
postWosQues4 | integer | — | Post Work Outcome Survey question 4 score. Example: 0 | |
postWosQues5 | integer | — | Post Work Outcome Survey question 5 score. Example: 0 | |
authorizedSessionsUsed | integer | — | Number of authorized sessions used. Example: 0 | |
sessions | object[] | — | History of sessions/appointments for this case. | |
referrals | object[] | — | Referrals associated with this case. | |
resolution | string or null | nullable | — | Case resolution. Example: null |
recommendation | string or null | nullable | — | Case recommendation. Example: null |
primaryCounselorName | string or null | nullable | — | Name of the primary counselor assigned to the case. Example: null |
fileCaseManagerName | string or null | nullable | — | Name of the case manager. Example: null |
createdOn | string | — | Date the case record was created. Example: "2001-01-01T01:01:01.011" | |
createdOnTimeZone | string | — | Timezone of the createdOn date. Example: "Central Standard Time" | |
modifiedOn | string | — | Date the case record was last modified. Example: "2025-01-01T01:01:01.011" | |
modifiedOnTimeZone | string | — | Timezone of the modifiedOn date. Example: "Eastern Standard Time" | |
userDefinedDropDown7Name | string or null | nullable | — | User defined dropdown 7. Example: "John Doe" |
userDefinedDropDown11Name | string or null | nullable | — | User defined dropdown 11. Example: "Something Here" |
userDefinedDropDown15Name | string or null | nullable | — | User defined dropdown 15. Example: "Closed" |
userDefinedDropDown22Name | string or null | nullable | — | Risk level value. Example: "Something" |
userDefinedWholeNumberField3 | integer or null | nullable | — | User defined whole number field 3. Example: 3 |
userDefinedMultiCheckDropDown6array | object[] | — | User defined multi-check dropdown 6 (e.g. service modality). | |
name | string | — | Example: "Face to Face EAP Counseling" | |
additionalInfosarray | object[] | — | Assessment responses (e.g. PHQ-9, GAD-7). Each entry has an additionalInfoName and a responses array of question/answer pairs. | |
additionalInfoName | string | — | Example: "Additional Info - PHQ-9_Pre" | |
responsesarray | object[] | — | Sub-fields are listed below. | |
questionText | string | — | ||
answerValue | string | — |
Example
{
"detail": "The requested resource was not found",
"code": "NOT_FOUND"
}Get a patient by ID
These are the most relevant fields of the patient (aka client) endpoint.
Path parameters
| Parameter | Type | Details |
|---|---|---|
| id | string | UUID of the patient Example: "3c3c3c3c-3c3c-3c3c-3c3c-3c3c3c3c3c3c" |
Example request
Generated from the specification, so values match the documented fields above.
curl -X GET "https://cca-api.eapexpert.com/patient/3c3c3c3c-3c3c-3c3c-3c3c-3c3c3c3c3c3c" \ -u "$CCA_USERNAME:$CCA_PASSWORD"
Responses
| Field | Type | Nullable | Format | Details |
|---|---|---|---|---|
id | string | uuid | Long alphanumeric ID of the patient/client. Example: "3c3c3c3c-3c3c-3c3c-3c3c-3c3c3c3c3c3c" | |
firstName | string | — | Patient/Client first name. Example: "Jane" | |
middleName | string | — | Patient/Client middle name. Example: "" | |
lastName | string | — | Patient/Client last name. Example: "Doe" | |
dateOfBirth | string | — | Patient/Client date of birth. Format: YYYY-MM-DDTHH:MM:SS.s (ISO 8601). Example: "1990-05-15T00:00:00.000" | |
email | string | Patient/Client email. Example: "jane.doe@acme.com" | ||
clientNumber | integer | — | Human readable client/patient numeric id. Example: 987654 | |
gender | string | — | Patient/Client gender. See gender field on intake endpoint documentation. Example: "Female" | |
addressesarray | object[] | — | Array of address objects. Each address is identified by its name field. | |
name | string | — | Example: "Primary" | |
street | string | — | Example: "123 Main St" | |
city | string | — | Example: "San Francisco" | |
state | string | — | Example: "CA" | |
zipCode | string | — | Example: "94105" | |
maritalStatus | string | — | Patient/Client marital status. Example: "Single" | |
employeeNumber | string or null | nullable | — | Gets or Sets EmployeeNumber. Example: "EMP-001" |
ethnicity | string or null | nullable | — | Gets or Sets Ethnicity. Example: "Hispanic or Latino" |
preferredSpokenLanguage | string or null | nullable | — | Gets or Sets Preferred spoken language. Example: "English" |
preferredWrittenLanguage | string or null | nullable | — | Gets or Sets Preferred written language. Example: "English" |
ageRange | string or null | nullable | — | Gets or Sets AgeRange. Example: "25-34" |
age | integer or null | nullable | — | Gets or Sets Age. Example: 30 |
Example
{
"detail": "The requested resource was not found",
"code": "NOT_FOUND"
}Get an organization by ID
This endpoint fields are self explanatory. Please query this endpoint with a known organization id.
Path parameters
| Parameter | Type | Details |
|---|---|---|
| id | string | UUID of the organization Example: "2b2b2b2b-2b2b-2b2b-2b2b-2b2b2b2b2b2b" |
Example request
Generated from the specification, so values match the documented fields above.
curl -X GET "https://cca-api.eapexpert.com/org/2b2b2b2b-2b2b-2b2b-2b2b-2b2b2b2b2b2b" \ -u "$CCA_USERNAME:$CCA_PASSWORD"
Responses
| Field | Type | Nullable | Format | Details |
|---|---|---|---|---|
Id | string or null | nullable | uuid | Gets or Sets Id. Example: "2b2b2b2b-2b2b-2b2b-2b2b-2b2b2b2b2b2b" |
Name | string | — | Gets or Sets Name. Example: "Acme Corporation" | |
Phone | string or null | nullable | — | Gets or Sets Phone. Example: "+1-415-555-1234" |
Email | string or null | nullable | — | Gets or Sets Email. Example: "contact@acme.com" |
Code | string or null | nullable | — | Gets or Sets Code. Example: "ACME-001" |
TimeZone | string or null | nullable | — | Gets or Sets TimeZone. Example: "America/Los_Angeles" |
ParentOrg | string or null | nullable | uuid | Identifier for the parent company/org if this org represents a branch. Example: null |
MailingAddress | object | — | Mailing address of the organization. | |
BillingAddress | object | — | Billing address of the organization. | |
Locations | object[] | — | List of organization locations. |
Example
{
"detail": "The requested resource was not found",
"code": "NOT_FOUND"
}List Work-Life Balance cases (Pt. 1)
List Work Life Balance cases (aka Life Balance cases).
For pagination, continue increasing the resultPage value until you get an empty array.
Query parameters
| Parameter | Type | Details |
|---|---|---|
| organizationId | string | Filter by organization UUID |
| dateOpenedFrom | string | Filter cases opened on or after this date (ISO 8601) Example: "2025-01-01T00:00:00Z" |
| dateOpenedTo | string | Filter cases opened on or before this date (ISO 8601) Example: "2025-01-31T23:59:59Z" |
| resultPage | integer | Page number (default 1). Increment until empty array is returned. Default: 1 |
| resultLimit | integer | Number of results per page (default 100) Default: 100 |
Example request
Generated from the specification, so values match the documented fields above.
curl -X GET "https://cca-api.eapexpert.com/searchlifebalancefile?organizationId=value&dateOpenedFrom=2025-01-01T00%3A00%3A00Z&dateOpenedTo=2025-01-31T23%3A59%3A59Z&resultPage=1&resultLimit=100" \ -u "$CCA_USERNAME:$CCA_PASSWORD"
Responses
Example
[
{
"oid": "5e5e5e5e-5e5e-5e5e-5e5e-5e5e5e5e5e5e",
"caseNumber": 112233,
"serviceName": "Child Care",
"caseStatus": "Opened",
"dateOpened": "2025-03-10T08:00:00.000",
"dateClosed": null,
"lastModified": "2025-03-15T12:00:00.000",
"organizationId": "2b2b2b2b-2b2b-2b2b-2b2b-2b2b2b2b2b2b",
"primaryClientId": "3c3c3c3c-3c3c-3c3c-3c3c-3c3c3c3c3c3c",
"primaryClientTypeName": "Employee",
"primaryClientNumber": 987654,
"fileType": "Life Expert File",
"countryName": "United States",
"stateProvinceName": "California"
}
]List Work-Life Expert cases (Pt. 2)
List additional Work Life Balance cases (aka Life Expert cases).
NOTE: Financial and Legal cases may not be tracked in EAPX and instead come from a different datasource. Daily Living should be coming from this endpoint.
For pagination, continue increasing the resultPage value until you get an empty array.
Query parameters
| Parameter | Type | Details |
|---|---|---|
| organizationId | string | Filter by organization UUID |
| dateOpenedFrom | string | Filter cases opened on or after this date (ISO 8601) Example: "2025-01-01T00:00:00Z" |
| dateOpenedTo | string | Filter cases opened on or before this date (ISO 8601) Example: "2025-01-31T23:59:59Z" |
| resultPage | integer | Page number (default 1). Increment until empty array is returned. Default: 1 |
| resultLimit | integer | Number of results per page (default 100) Default: 100 |
Example request
Generated from the specification, so values match the documented fields above.
curl -X GET "https://cca-api.eapexpert.com/searchlifeexpertfile?organizationId=value&dateOpenedFrom=2025-01-01T00%3A00%3A00Z&dateOpenedTo=2025-01-31T23%3A59%3A59Z&resultPage=1&resultLimit=100" \ -u "$CCA_USERNAME:$CCA_PASSWORD"
Responses
Example
[
{
"oid": "6f6f6f6f-6f6f-6f6f-6f6f-6f6f6f6f6f6f",
"caseNumber": 223344,
"serviceName": "Legal",
"caseStatusName": "Closed",
"dateOpened": "2025-02-01T08:00:00.000",
"dateClosed": "2025-02-28T17:00:00.000",
"lastModified": "2025-02-28T17:00:00.000",
"organizationId": "2b2b2b2b-2b2b-2b2b-2b2b-2b2b2b2b2b2b",
"primaryClientId": "3c3c3c3c-3c3c-3c3c-3c3c-3c3c3c3c3c3c",
"primaryClientTypeName": "Employee",
"primaryClientNumber": 987654,
"fileType": "Work Life File",
"countryName": "United States",
"stateProvinceName": "California"
}
]List Workplace Activity records
Lists Organizational Services (aka Workplace Activities) that meet all of the given query parameters.
For pagination, continue increasing the resultPage value until you get an empty array.
Query parameters
| Parameter | Type | Details |
|---|---|---|
| organizationId | string[] | Filter by one or more organization UUIDs |
| effectiveDateFrom | string | Filter services delivered on or after this date (ISO 8601) Example: "2025-01-01T00:00:00Z" |
| effectiveDateTo | string | Filter services delivered on or before this date (ISO 8601) Example: "2025-12-31T23:59:59Z" |
| resultPage | integer | Page number (default 1) Default: 1 |
| resultLimit | integer | Number of results per page (default 100) Default: 100 |
Example request
Generated from the specification, so values match the documented fields above.
curl -X GET "https://cca-api.eapexpert.com/searchorganizationalservice?organizationId=value&effectiveDateFrom=2025-01-01T00%3A00%3A00Z&effectiveDateTo=2025-12-31T23%3A59%3A59Z&resultPage=1&resultLimit=100" \ -u "$CCA_USERNAME:$CCA_PASSWORD"
Responses
Example
[
{
"oid": "a7b3c1d2-e4f5-6789-abcd-ef0123456789",
"organizationalServiceNumber": 334455,
"effectiveDate": "2025-05-10T10:00:00.000",
"serviceTypeName": "Clinical Consultation",
"serviceSubTypeName": "Risk Assessment",
"serviceUsers": 12,
"organizationIds": [
"2b2b2b2b-2b2b-2b2b-2b2b-2b2b2b2b2b2b"
],
"stateProvinceName": "California",
"countryName": "United States",
"cityName": "San Francisco",
"OrganizationalServiceType": "EventsSingleOrg",
"UserDefinedDropDown8": "Stress",
"UserDefinedTextField8": "Stress Management Seminar",
"BillableHours": 2,
"NumberOfEmployees": 10,
"NumberOfManagers": 2,
"ResponseType": "In Person Onsite"
}
]