Person
Details of a Person Drop
A Person object is used to represent a bookable staff member within the platform. A staff member can belong to multiple locations and offers bookable services to customers
| Field | Usage / Description | Additional Information |
|---|---|---|
| id | {{person.id}} | Example: 254543 |
| administrator | {{person.administrator}} | |
| attendance_status | {{person.attendance_status}} | |
| attendance_estimate | {{person.attendance_estimate}} | |
| attendance_started | {{person.attendance_started}} | |
| created_at | {{person.created_at}} | |
| company_id | {{person.company_id}} | Example: 37000 |
| company_ids | {{person.company_ids}} | |
| description | {{person.description}} | Example: A little bit about them |
| deleted | {{person.deleted}} | |
| disabled | {{person.disabled}} | |
| {{person.email}} | ||
| ews_email | {{person.ews_email}} | |
| extra | {{person.extra}} | Example: {"question_one"=>"Answer to question_one", "question_two"=>"Answer to question two"} |
| group_id | {{person.group_id}} | Example: 58459 |
| group_name | {{person.group_n\ame}} | Example: Group |
| ical_link | {{person.ical_link}} | |
| image | {{person.image}} | URL of the default Image |
| images | {{person.images['name']}} | Link to image URL by it's name |
| live_status | {{person.live_status}} | |
| mobile | {{person.mobile}} | |
| name | {person.name}} | |
| never_booked | {{person.never_booked}} | |
| order | {{person.order}} | |
| origin | {{person.origin}} | Where the object came from e.g. importer, manually |
| queuing_disabled | {{person.queuing_disabled}} | |
| person_companies | {{person.person_companies}} | |
| phone | {{person.phone}} | Example: 0208 123 456 |
| phone_prefix | {{person.phone_prefix}} | Example: +44 |
| reference | {{person.reference}} | |
| resource_ids | {{person.resource_ids}} | |
| schedule_id | {{person.schedule_id}} | |
| service_ids | {{person.service_ids}} | |
| type | {{person.type}} | Example: person |
| updated_at | {{person.updated_at}} | |
| app | {{person.app. | Link to a Custom Object belonging to an app |
| extras | {{person.extras. | Link to the extra values |
| company | {{person.company. | Link to the company object if they belong to an old style single location |
| companies | {% for company in person.companies %} | Loop around all of the locations this staff member works at |
Updated over 2 years ago
What’s Next
