Tech Partner

Documentation

Last Updated:

Intake and Scheduling API (0.4.0)

Introduction

This API allows your app to search providers, show availability, and submit In-App Scheduling or Stand-Alone Intake requests. For authentication setup please visit the Developer Guide page.

For authentication setup, onboarding, and sample code see the Developer Guide.

Technical Guardrails

All API integrations are subject to standard rate limiting to ensure platform stability. Invalid or missing credentials return 401 Unauthorized. Schema and request-validation failures return 400 Bad Request. Endpoint-specific codes (for example 403 and 409) are documented with each operation and on the authentication pages.

Authentication

Scheme: http bearer

Long-lived, CCA-minted Bearer token. Unlike Token-Based Authentication's short-lived partner-minted tokens, this token is issued once by CCA and reused on every request until rotated/revoked. See the Developer Guide.

Servers

EnvironmentBase URL
Production API serverhttps://api.ccaplatform.com
Sandbox / demo Members Portal API serverhttps://members-api.ccaplatformdemo.com

Authentication failure (401)

Every endpoint in this API returns HTTP 401 when the bearer token is missing, malformed, or fails validation, so one handler covers them all. The response body always has this shape:

FieldTypeDetails
code
stringenum
Allowed values:token_invalidmissing_claimpartner_not_foundpartner_inactive
message
string
Example: "Invalid bearer token."

Example

{
  "code": "token_invalid",
  "message": "Invalid bearer token."
}
GET/partners/v1/service-regions/

List service provider regions for a country

Returns the active state/province/region rows for the given country, used to populate the region selector before searching provider availability. Paginated.

Query parameters

ParameterTypeDetails
countryCodestringISO 3166-1 alpha-2 country code. Case-insensitive.
Example: "US"
pageintegerPage number.
Default: 1
pageSizeintegerResults per page, up to 100.
Default: 20
Maximum: 100

Example request

Generated from the specification, so values match the documented fields above.

curl -X GET "https://api.ccaplatform.com/partners/v1/service-regions/?countryCode=US&page=1&pageSize=20" \
  -H "Authorization: Bearer $CCA_TOKEN"

Responses

200Successfully listed the country's active regions.
FieldTypeNullableFormatDetails
count
integer—
Example: 1
next
string or nullnullableuri
previous
string or nullnullableuri
resultsarray
PartnerBearerRegion[]—Sub-fields are listed below.
id
integer—
Example: 1
countryCode
string—
Example: "US"
countryNameEnglish
string—
Example: "United States"
countryNameLocal
string—
Example: "United States"
stateProvinceCode
string—
Example: "US-NY"
stateProvinceNameLocal
string—
Example: "New York"
stateProvinceLabel
string—"State" for US, "Province" for CA, "Region" for all other countries.
Example: "State"
400Missing or invalid countryCode.

Example

{
  "message": "Invalid Data",
  "status": 400
}
403Partner's organization is deactivated.

Example

{
  "message": "User's organization is deactivated. Please contact support.",
  "status": 403
}
409Partner has no organization configured.

Example

{
  "message": "Partner is not configured with an organization.",
  "status": 409
}
GET/partners/v1/providers/

Search provider availability by region

Returns providers licensed in the given region (or country) with an active license, along with their available booking slots for the next 30 days. Your organization is resolved automatically from your Bearer token — you never send it. Paginated.

Query parameters

ParameterTypeDetails
regionIdintegerA region id, discovered via GET /partners/v1/service-regions/. Required for a country if that endpoint returns more than one region for it (state/province-level regions, not just a single country-wide entry) — countryCode alone returns 400 for those countries. At least one of regionId or countryCode is required. Where regionId is required, both may be sent together only if regionId actually belongs to countryCode (e.g. a New York regionId with countryCode=US); otherwise returns 400.
Example: 1
countryCodestringISO 3166-1 alpha-2 country code. Matches providers licensed in the region covering that whole country. Use this alone for a country whose regions endpoint returns only a single country-wide region. For a country with state/province-level regions, it's optional but only valid alongside a matching regionId — it cannot be sent alone. At least one of regionId or countryCode is required.
Example: "US"
modalitystringenumOptional filter by session modality. in-person requires regionId (not just countryCode) — it needs one specific region to check onsite locations against.
Allowed values:in-persontelephonicin-video
languagestringOptional filter by spoken language (BCP-47 code, matched against languagesSpoken).
Example: "en"
pageintegerPage number.
Default: 1
pageSizeintegerResults per page, up to 100.
Default: 20
Maximum: 100

Example request

Generated from the specification, so values match the documented fields above.

curl -X GET "https://api.ccaplatform.com/partners/v1/providers/?regionId=1&countryCode=US&modality=in-person&language=en&page=1&pageSize=20" \
  -H "Authorization: Bearer $CCA_TOKEN"

Responses

200Successfully listed matching providers and their availability.
FieldTypeNullableFormatDetails
count
integer—
Example: 6
next
string or nullnullableuri
previous
string or nullnullableuri
resultsarray
PartnerBearerProviderSearchResult[]—Sub-fields are listed below.
providerId
integer—
Example: 789
details
object—Mirrors the internal serialize_provider_data shape, minus email and organizationId, which are internal-only and stripped before integration partners ever see this.
availabilityarray
PartnerBearerAvailabilitySlot[]—Sub-fields are listed below.
utcStartTime
stringdatetime
Example: "2026-08-02T14:00:00Z"
utcEndTime
stringdatetime
Example: "2026-08-02T14:45:00Z"
400Missing regionId and countryCode, regionId given with a mismatched countryCode, invalid regionId/countryCode/modality/language, or in-person modality without regionId.

Example

{
  "message": "Invalid value for regionId: abc",
  "status": 400
}
403Partner's organization is deactivated.

Example

{
  "message": "User's organization is deactivated. Please contact support.",
  "status": 403
}
409Partner has no organization configured.

Example

{
  "message": "Partner is not configured with an organization.",
  "status": 409
}
POST/partners/v1/intake/

Create a booking request, or a general intake if no slot is picked yet

Finds or creates the member (matched by user.external_user_id, namespaced to your partner identity) using the fields in memberData, then submits a booking request for the given provider and time slot. Calling this again with the same external_user_id updates the same member record rather than creating a duplicate.

Send the slot's utcStartTime/utcEndTime (from the availability-search response) straight through, unchanged — no timezone conversion needed.

If bookingData is omitted entirely, this submits a general intake instead of a booking — no provider/time is attached, and our operations team assigns a provider manually afterward. Only memberData and phq9Data are required in that case.

Post body

FieldTypeDetails
userobject
objectSub-fields are listed below.
external_user_id
stringYour own stable id for this patient. Used to find-or-create the member.
Example: "patient-00123"
bookingDataobject
objectOptional. If omitted entirely, this becomes a general intake submission instead of a booking — no provider/time picked, our operations team assigns a provider afterward.
selfSchedulingProviderId
integer
Example: 789
utcStartTime
stringUTC time, taken directly from the availability-search response. No timezone
conversion needed. A trailing "Z" is required, to state the timezone explicitly.
Example: "2026-08-02T14:00:00Z"
utcEndTime
stringMust be exactly 45 minutes after utcStartTime. A trailing "Z" is required.
Example: "2026-08-02T14:45:00Z"
memberDataobject
objectSub-fields are listed below.
email
stringThe patient's real email. Upserted onto the member record on every call.
Example: "jane.doe@example.com"
firstName
string
Example: "Jane"
lastName
string
Example: "Doe"
country
string
Example: "US"
preferredName
string
preferredPronouns
string
Example: "She/Her"
dob
string
Example: "1990-01-01"
gender
string
Example: "Female"
maritalStatus
string
Example: "Single"
clientType
string
Example: "Employee"
leaveVoicemail
stringenum
Allowed values:YesNo
phoneNumber
string
Example: "+15551234567"
streetAddress
string
suite
stringOptional, can be an empty string.
city
string
state
string
Example: "CA"
zipCode
string
Example: "94105"
reasonForSeekingSupport
string
Example: "Anxiety"
preferredModality
string
Example: "Video Counseling"
preferredSpokenLanguage
stringA BCP-47 language code.
Example: "en"
phq9Dataarray
object[]Sub-fields are listed below.
question
string
Example: "PHQ-9 1.Little interest or pleasure in doing things."
answer
string
Example: "0 Not at all"

Responses

201Success
FieldTypeNullableFormatDetails
id
integer—
Example: 456
status
stringenum—Default: pending. An appointment starts pending and moves to confirmed once the chosen provider accepts it, or cancelled if it is declined.
Allowed values:pendingconfirmedcancelled
Default: pending
400Validation failure (missing/invalid fields, slot no longer available, etc.).

Example

{
  "message": "The requested time is not available for the provider.",
  "status": 400
}
GET/partners/v1/user/

Look up a member by external id

Looks up a member previously created via by the externalUserId passed to the POSTintake/ endpoint.

Query parameters

ParameterTypeDetails
externalUserIdstringThe external id you assigned this member when you created them.
Example: "patient-00123"

Example request

Generated from the specification, so values match the documented fields above.

curl -X GET "https://api.ccaplatform.com/partners/v1/user/?externalUserId=patient-00123" \
  -H "Authorization: Bearer $CCA_TOKEN"

Responses

200Success
FieldTypeNullableFormatDetails
externalUserId
string—
Example: "patient-00123"
firstName
string—
Example: "Jane"
lastName
string—
Example: "Doe"
email
stringemail
Example: "jane.doe@example.com"
phoneNumber
stringphone
Example: "+1 (787) 555-0123"
country
string—
Example: "US"
preferredSpokenLanguageCode
string or nullnullable—A BCP-47 language code.
Example: "en"
appointmentsarray
AppointmentSummary[]—The user's appointments.
id
integer—Unique identifier for the appointment.
Example: 456
status
stringenum—
Allowed values:pendingconfirmedcancelled
type
stringenum—
Allowed values:videoin-person
datetime
stringdatetimeAppointment start time in ISO 8601 UTC.
Example: "2026-08-02T14:00:00Z"
providerobject
object or nullnullable—The provider for this booking, when one has been assigned.
name
string—
Example: "Dr. Jane Smith"
email
stringemail
Example: "jane.smith@ccaplatform.com"
phone
stringphone
Example: "+1 (787) 555-0142"
picture
stringuriURL of the provider's profile picture.
Example: "https://example.com/providers/jane-smith.jpg"
bio
string—
Example: "Licensed clinical psychologist with 12 years of experience."
videoLocation
string or nullnullableuriVideo session join URL. Present for video bookings.
Example: "https://video.example.com/session/abc123"
inPersonLocationobject
object or nullnullable—Physical appointment location. Present for in-person bookings.
street1
string—
Example: "123 Main St"
street2
string or nullnullable—
Example: "Suite 400"
city
string—
Example: "San Francisco"
state
string—
Example: "CA"
zipCode
string—
Example: "94105"
country
string—
Example: "US"
400Missing externalUserId, or no member exists for that externalUserId under your integration partner identity.

Example

{
  "message": "Invalid externalUserId query parameter.",
  "status": 400
}