Sign in

v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB
Drop-In

Get Drop-In

Get a Drop-In record given the provided Drop-In ID.

get/dropins/{dropin_id}

Path parameters

dropin_idinteger required

Unique Drop In ID.

Headers

x-api-keystring required

A valid API key. If you don't have one, please request one through the Web Integrations screen.

Response

Drop In Record

idinteger

Unique Dropin ID.

dropin_guidstring

A unique identifier (GUID) used as the fingerprint for the drop-in. This will be used for the Firebase document ID and can be utilized in other systems as needed.

namestring

The drop in's name

first_namestring

Drop In's first name.

last_namestring

DropIn's last name.

emailstring

Lead's email address.

location_idinteger

DropIn's default location ID.

locationstring

DropIn's default location.

gender_idinteger

Drop In's gender ID.

genderstring

DropIn's gender.

phone_numberstring

DropIn's phone number.

street_address1string

DropIn's street address (line 1).

street_address2string

DropIn's street address (line 2).

citystring

DropIn's city.

state_idinteger

DropIn's state ID.

statestring

DropIn's state.

provincestring

DropIn's province, if applicable.

zipcodestring

DropIn's ZIP code.

country_idinteger

DropIn's country ID.

countrystring

DropIn's country.

date_of_birthstring date

DropIn's date of birth.

ageinteger

DropIn's age

emergency_contact_namestring

DropIn's Emergency Contact

emergency_contact_phone_numberstring

DropIn's emergency contact phone number

commentsstring

DropIn's Comments

parent_guardian_full_namestring

DropIn's ParentGuardian full name - used when DropIn is a dependent

sms_toll_free_subscribedboolean

DropIn's indication if they want to subscribe to SMS Toll-Free

is_email_subscribedboolean

Indicates if the DropIn is subscribed to email communication.

dropin_sincestring date-time

Time when the drop-in was created

total_class_sign_insinteger

Total number of Classes that the Drop-In has signed into.

is_converted_to_leadboolean

Indicates if the DropIn has been converted to a Lead.

lead_idinteger

Identifies the Lead which the Drop-In was converted to

is_dependentboolean

If the drop-in is a dependent

Example response

{
  "id": 1234567891234567,
  "location_id": 1234567891234567,
  "date_of_birth": "2014-12-31",
  "dropin_since": "2014-12-31T23:59:59.938Z",
  "created": {
    "created_by_id": 1234567891234567,
    "created_on_datetime": "2014-12-31T23:59:59.938Z"
  },
  "updated": {
    "updated_by_id": 1234567891234567,
    "updated_on_datetime": "2014-12-31T23:59:59.938Z"
  }
}
All 226 operations