JRNI Developer Documentation

The JRNI Developer Hub

Welcome to the JRNI developer hub.

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

id

{{person.id}}
Example: 254543

name

{{person.name}}
Example: John Bull

description

{{person.description}}
Example: A little bit about them

type

{{person.type}}
Example: person

extra

{{person.extra}}
Example: {"question_one"=>"Answer to question_one", "question_two"=>"Answer to question two"}

group_id

{{person.group_id}}
Example: 58459

deleted

{{person.deleted}}

disabled

{{person.disabled}}

company_id

{{person.company_id}}
Example: 37000

order

{{person.order}}
Example: 1

group_name

{{person.group_name}}
Example: Group

created_at

{{person.created_at}}

updated_at

{{person.updated_at}}

administrator

{{person.administrator}}

email

{{person.email}}

ews_email

{{person.ews_email}}

mobile

{{person.mobile}}

queuing_disabled

{{person.queuing_disabled}}

attendance_status

{{person.attendance_status}}

attendance_estimate

{{person.attendance_estimate}}

attendance_started

{{person.attendance_started}}

reference

{{person.reference}}

company_ids

{{person.company_ids}}

schedule_id

{{person.schedule_id}}

person_companies

{{person.person_companies}}

phone

{{person.phone}}
Example: 0208 123 456

phone_prefix

{{person.phone_prefix}}
Example: +44

ical_link

{{person.ical_link}}

never_booked

{{person.never_booked}}

resource_ids

{{person.resource_ids}}

service_ids

{{person.service_ids}}

live_status

{{person.live_status}}

origin

{{person.origin}}
Where the object came from e.g. importer, manually

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

extras

{{person.extras.
Link to the extra values

app

{{person.app.
Link to a Custom Object belonging to an app

image

{{person.image}}
URL of the default Image

images

{{person.images['name']}}
Link to image URL by it's name

Updated 11 months ago

Person


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.