AddAppointmentRequestModel

HealthcareABAPractice ManagementSoftwareCompany

Properties

Name Type Description
appointmentTypeId object
scheduledStartDateTime string scheduled start time - UTC datetime
scheduledEndDateTime string scheduled end time - UTC datetime
staffId integer staff ID
clientId integernull client ID
payCodeId integernull hcStaffPaycodes (hcStaffMemberPayroll.hcStaffPaycodeId)
tagId integernull hcAppointmentCustomTags (hcAppointments.ActivityTagId)
locationCodeId integernull hcLocationCodes (hcAppointments.LocationId)
locationId integernull hcProviderLocation (hcAppointments.ToLocationId)
scheduledLocationAddress stringnull single line address
authorizationBillingCodeId integernull hcChildProfileAuthorizationBillingCode (hcAppointments.ProcedureCodeId)
funderBillingCodeId integernull hcProviderBillingCode (hcChildProfileAuthorizationBillingCode.hcProviderBillingCodeId)
cancellationTypeId object
cancellationSubtypeId integernull hcAppointmentCustomTags (hcAppointments.CancellationTagId), hcAppointmentCustomTagTypeId 1=Cancellation
actualStartDateTime stringnull actual start time - UTC datetime
actualEndDateTime stringnull actual end time - UTC datetime
staffVerificationDateTime stringnull staff verification timestamp (UTC)
parentVerificationDateTime stringnull parent verification timestamp (UTC)
scheduledLocation object
actualStartLocation object
actualEndLocation object
parentSignature stringnull parent signature - base64 encoded image
billingCodeCredentialId integernull hcProviderBillingCodeCredentials
overrideFunderServiceLimits boolean When true, persist despite Funder Service Limit Blocks if the staff member's role has Override Funder Service Limits. Default false. Does not bypass authorization or other failures.
seriesAppointmentId integernull
travelDetail object
notes stringnull
View JSON Schema on GitHub

JSON Schema

rethink-behavioral-health-add-appointment-request-model-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/rethink-behavioral-health/json-schema/rethink-behavioral-health-add-appointment-request-model-schema.json",
  "title": "AddAppointmentRequestModel",
  "x-generated": "2026-11-15",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/rethink-behavioral-health-openapi.json#/components/schemas/AddAppointmentRequestModel",
  "required": [
    "appointmentTypeId",
    "scheduledEndDateTime",
    "scheduledStartDateTime",
    "staffId"
  ],
  "type": "object",
  "properties": {
    "appointmentTypeId": {
      "$ref": "#/$defs/AppointmentTypes"
    },
    "scheduledStartDateTime": {
      "type": "string",
      "description": "scheduled start time - UTC datetime",
      "format": "date-time"
    },
    "scheduledEndDateTime": {
      "type": "string",
      "description": "scheduled end time - UTC datetime",
      "format": "date-time"
    },
    "staffId": {
      "type": "integer",
      "description": "staff ID",
      "format": "int32"
    },
    "clientId": {
      "type": [
        "integer",
        "null"
      ],
      "description": "client ID",
      "format": "int32"
    },
    "payCodeId": {
      "type": [
        "integer",
        "null"
      ],
      "description": "hcStaffPaycodes (hcStaffMemberPayroll.hcStaffPaycodeId)",
      "format": "int32"
    },
    "tagId": {
      "type": [
        "integer",
        "null"
      ],
      "description": "hcAppointmentCustomTags (hcAppointments.ActivityTagId)",
      "format": "int32"
    },
    "locationCodeId": {
      "type": [
        "integer",
        "null"
      ],
      "description": "hcLocationCodes (hcAppointments.LocationId)",
      "format": "int32"
    },
    "locationId": {
      "type": [
        "integer",
        "null"
      ],
      "description": "hcProviderLocation (hcAppointments.ToLocationId)",
      "format": "int32"
    },
    "scheduledLocationAddress": {
      "type": [
        "string",
        "null"
      ],
      "description": "single line address"
    },
    "authorizationBillingCodeId": {
      "type": [
        "integer",
        "null"
      ],
      "description": "hcChildProfileAuthorizationBillingCode (hcAppointments.ProcedureCodeId)",
      "format": "int32"
    },
    "funderBillingCodeId": {
      "type": [
        "integer",
        "null"
      ],
      "description": "hcProviderBillingCode (hcChildProfileAuthorizationBillingCode.hcProviderBillingCodeId)",
      "format": "int32"
    },
    "cancellationTypeId": {
      "$ref": "#/$defs/AppointmentCancellationTypes"
    },
    "cancellationSubtypeId": {
      "type": [
        "integer",
        "null"
      ],
      "description": "hcAppointmentCustomTags (hcAppointments.CancellationTagId), hcAppointmentCustomTagTypeId 1=Cancellation",
      "format": "int32"
    },
    "actualStartDateTime": {
      "type": [
        "string",
        "null"
      ],
      "description": "actual start time - UTC datetime"
    },
    "actualEndDateTime": {
      "type": [
        "string",
        "null"
      ],
      "description": "actual end time - UTC datetime"
    },
    "staffVerificationDateTime": {
      "type": [
        "string",
        "null"
      ],
      "description": "staff verification timestamp (UTC)"
    },
    "parentVerificationDateTime": {
      "type": [
        "string",
        "null"
      ],
      "description": "parent verification timestamp (UTC)"
    },
    "scheduledLocation": {
      "$ref": "#/$defs/AddAppointmentLocationModel"
    },
    "actualStartLocation": {
      "$ref": "#/$defs/AddAppointmentLocationModel"
    },
    "actualEndLocation": {
      "$ref": "#/$defs/AddAppointmentLocationModel"
    },
    "parentSignature": {
      "type": [
        "string",
        "null"
      ],
      "description": "parent signature - base64 encoded image"
    },
    "billingCodeCredentialId": {
      "type": [
        "integer",
        "null"
      ],
      "description": "hcProviderBillingCodeCredentials",
      "format": "int32"
    },
    "overrideFunderServiceLimits": {
      "type": "boolean",
      "description": "When true, persist despite Funder Service Limit Blocks if the staff member's role has\r\nOverride Funder Service Limits. Default false. Does not bypass authorization or other failures."
    },
    "seriesAppointmentId": {
      "type": [
        "integer",
        "null"
      ],
      "format": "int32"
    },
    "travelDetail": {
      "$ref": "#/$defs/TravelDetail"
    },
    "notes": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "additionalProperties": false,
  "$defs": {
    "AddAppointmentLocationModel": {
      "type": "object",
      "properties": {
        "latitude": {
          "type": [
            "number",
            "null"
          ],
          "description": "latitude",
          "format": "double"
        },
        "longitude": {
          "type": [
            "number",
            "null"
          ],
          "description": "longitude",
          "format": "double"
        }
      },
      "additionalProperties": false
    },
    "AppointmentCancellationTypes": {
      "enum": [
        0,
        1,
        2,
        3
      ],
      "type": "integer",
      "format": "int32"
    },
    "AppointmentTypes": {
      "enum": [
        1,
        2,
        3
      ],
      "type": "integer",
      "format": "int32"
    },
    "TravelDetail": {
      "type": "object",
      "properties": {
        "mileage": {
          "type": [
            "number",
            "null"
          ],
          "format": "double"
        }
      },
      "additionalProperties": false
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/rethink-behavioral-health-add-appointment-request-model"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.