---
title: People
slug: docs/e0A1-people
createdAt: 2026-07-08T06:07:08.593Z
---

The **People** endpoint sends People out of your event: their identifiers, contact details, Custom Fields, Categories, and Program membership. Its endpoint is served at `/updates/api/{endpoint-uuid}/event-people`.

## How it works

The template is the shape of the payload you want out. Each key is yours to name; the merge tag on the right supplies the value for each Person at send time. Two keys carry JSON values rather than text, so their tags sit **without quotes**: custom\_fields and categories. Everything else is plain text and stays quoted.

`cancelled` and `checked_in` use the `<<TAG|true:true,false:false>>` form. They render as the strings `"true"` and `"false"`.

Custom Fields and Categories can each be sent two ways, and you can use both at once:

- **The whole set.** `custom_fields` and `categories` return every one, as a JSON value.
- **One named field of your own.** `<<CUSTOM_FIELD|key:...>>` and `<<HAS_CATEGORY|id:...>>` each return a single value as plain text, so you can promote the one field your system cares about to a top-level key. The example below does this with `dietary_requirements` and `is_speaker`.

The two single-field tags read different things. `<<CUSTOM_FIELD|key:...>>` returns the value stored against that key, or an empty string when the Person has no value for it. `<<HAS_CATEGORY|id:...>>` returns a boolean - it reports whether the Category is applied, using the two strings you set with `true:` and `false:`. Set both of those options every time: without them the tag falls back to a raw boolean, which renders as `"1"` and `""` rather than anything readable. Both tags return text, so `is_speaker` below is the string `"no"`, not `false`.

Single-field tags need the Custom Field key or Category ID written into the template, so they are specific to your event. Change the identifier in the examples below to your own before using them. Category IDs in particular are specific to your Jomablue instance.

## Sample mapping

:::BlockQuote
\{
&#x20;   "event\_id": "\<\<EVENT\_ID>>",
&#x20;   "resource\_id": "\<\<RESOURCE\_ID>>",
&#x20;   "organisation\_uid": "\<\<ORGANISATION\_UID>>",
&#x20;   "first\_name": "\<\<FIRST\_NAME>>",
&#x20;   "last\_name": "\<\<LAST\_NAME>>",
&#x20;   "email": "\<\<EMAIL>>",
&#x20;   "phone": "\<\<MOBILE>>",
&#x20;   "company": "\<\<COMPANY>>",
&#x20;   "job\_title": "\<\<JOB\_TITLE>>",
&#x20;   "cancelled": "\<\<CANCELLED|true\:true,false\:false>>",
&#x20;   "checked\_in": "\<\<BADGE\_PRINTED|true\:true,false\:false>>",
&#x20;   "import\_type": "\<\<IMPORT\_TYPE>>",
&#x20;   "updated\_at": "\<\<UPDATED\_AT>>",
&#x20;   "created\_at": "\<\<CREATED\_AT>>",
&#x20;   "custom\_fields": \<\<CUSTOM\_FIELDS\_LIST|format\:json>>,
&#x20;   "dietary\_requirements": "\<\<CUSTOM\_FIELD|key\:dietary>>",
&#x20;   "categories": \<\<CATEGORIES\_LIST|format\:json,category\_id\_label\:id,category\_name\_label\:name,has\_category\_label\:status,true\:applied,false\:not\_applied>>,
&#x20;   "is\_speaker": "\<\<HAS\_CATEGORY|id:2,true\:yes,false\:no>>"
}
:::

## Sample output

One rendered Person from the array the endpoint returns:

:::BlockQuote
\{
&#x20; "event\_id": "your-instance/event/3365",
&#x20; "resource\_id": "your-instance/event\_person/4676",
&#x20; "organisation\_uid": "15f04804-9781-35b7-b3f8-cf063c1da67a",
&#x20; "first\_name": "Ada",
&#x20; "last\_name": "Lovelace",
&#x20; "email": "ada\@example.com",
&#x20; "phone": "+61400000000",
&#x20; "company": "Analytical Engines",
&#x20; "job\_title": "Mathematician",
&#x20; "cancelled": "false",
&#x20; "checked\_in": "true",
&#x20; "import\_type": "import",
&#x20; "updated\_at": "2026-05-15T08:40:35.000000Z",
&#x20; "created\_at": "2026-04-10T07:43:13.000000Z",
&#x20; "custom\_fields": \{
&#x20;   "dietary": "Vegetarian",
&#x20;   "t\_shirt\_size": "M"
&#x20; },
&#x20; "dietary\_requirements": "Vegetarian",
&#x20; "categories": \[
&#x20;   \{ "id": "your-instance/category/1", "name": "Delegate", "status": "applied" },
&#x20;   \{ "id": "your-instance/category/2", "name": "Speaker", "status": "not\_applied" }
&#x20; ],
&#x20; "is\_speaker": "no"
}
:::

`dietary_requirements` repeats the `dietary` value out of `custom_fields`, and `is_speaker` reports the same Category 2 that appears in `categories`. This is to illustrate how each approach works - typically you would only use one approach (although using both is also allowed).

## Field reference

| Key                   | Merge tag                                     | Emits                                                                                                       |
| --------------------- | --------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| event\_id             | \<\<EVENT\_ID>>                               | Text. The event's resource ID.                                                                              |
| resource\_id          | \<\<RESOURCE\_ID>>                            | Text. The Person's resource ID.                                                                             |
| organisation\_uid     | \<\<ORGANISATION\_UID>>                       | Text. Your own identifier for the Person.                                                                   |
| first\_name           | \<\<FIRST\_NAME>>                             | Text.                                                                                                       |
| last\_name            | \<\<LAST\_NAME>>                              | Text.                                                                                                       |
| email                 | \<\<EMAIL>>                                   | Text.                                                                                                       |
| phone                 | \<\<MOBILE>>                                  | Text. Mobile number.                                                                                        |
| company               | \<\<COMPANY>>                                 | Text.                                                                                                       |
| job\_title            | \<\<JOB\_TITLE>>                              | Text.                                                                                                       |
| cancelled             | \<\<CANCELLED\|...>>                          | Text "true" or "false".                                                                                     |
| checked\_in           | \<\<BADGE\_PRINTED\|...>>                     | Text "true" or "false".                                                                                     |
| import\_type          | \<\<IMPORT\_TYPE>>                            | Text. How the Person entered the event.                                                                     |
| updated\_at           | \<\<UPDATED\_AT>>                             | Text. ISO 8601 timestamp.                                                                                   |
| created\_at           | \<\<CREATED\_AT>>                             | Text. ISO 8601 timestamp.                                                                                   |
| custom\_fields        | \<\<CUSTOM\_FIELDS\_LIST\|format\:json>>      | JSON object of the Person's Custom Fields. Unquoted in the template.                                        |
| dietary\_requirements | \<\<CUSTOM\_FIELD\|key\:dietary>>             | Text. One named Custom Field. Empty string if the Person has no value for that key.                         |
| categories            | \<\<CATEGORIES\_LIST\|...>>                   | JSON array of the event's Categories, each with an applied / not\_applied status. Unquoted in the template. |
| is\_speaker           | \<\<HAS\_CATEGORY\|id:2,true\:yes,false\:no>> | Text. Whether one named Category is applied. The true and false options set the two strings returned.       |

The key names `dietary_requirements` and `is_speaker` are examples. Name them whatever suits your system.

## Programs

Programs group People across an event, and each membership carries its own identifier and status. Program membership is sent the same two ways as Custom Fields and Categories: the whole set as a JSON array, or one named Program as flat text.

### The whole set

Add a programs key. The tag returns a JSON value, so it sits **without quotes**:

:::BlockQuote
\{
&#x20;   "programs": \<\<PROGRAMS\_LIST|format\:json,program\_uid\_label\:uid,program\_name\_label\:name,program\_member\_uid\_label\:member\_uid,program\_member\_status\_label\:member\_status>>
}
:::

The four `*_label` options name the keys inside each Program object. Set them to whatever your system expects. In the example above they produce `uid`, `name`, `member_uid` and `member_status`:

:::BlockQuote
"programs": \[
&#x20; \{
&#x20;   "uid": "8162fa36-ab03-44d0-aa9b-d305791e211b",
&#x20;   "name": "Autumn Roadshow",
&#x20;   "member\_uid": "ead63b6b-198e-4bde-8ba8-c929fea9a376",
&#x20;   "member\_status": "registered"
&#x20; },
&#x20; \{
&#x20;   "uid": "ca7969ae-840d-4624-a15d-03fe41b699e2",
&#x20;   "name": "VIP Hosted Buyers",
&#x20;   "member\_uid": "b3bf0fa1-63ac-4136-8f0a-22e09a7d80a6",
&#x20;   "member\_status": "attended"
&#x20; }
]
:::

Unlike categories, this key lists only the Programs the Person is a member of. A Person in no Programs returns an empty array. `member_uid` and `member_status` return an empty string when the membership does not carry one.

### One named Program

Three tags return a single Program's detail as plain text, so each one stays quoted. Each takes the `program_uid` of the Program you want. Use them instead of programs, or alongside it:

:::BlockQuote
\{
&#x20;   "roadshow\_name": "\<\<PROGRAM\_NAME|program\_uid:8162fa36-ab03-44d0-aa9b-d305791e211b>>",
&#x20;   "roadshow\_member\_uid": "\<\<PROGRAM\_MEMBER\_UID|program\_uid:8162fa36-ab03-44d0-aa9b-d305791e211b>>",
&#x20;   "roadshow\_member\_status": "\<\<PROGRAM\_MEMBER\_STATUS|program\_uid:8162fa36-ab03-44d0-aa9b-d305791e211b>>"
}
:::

Rendered:

:::BlockQuote
\{
&#x20; "roadshow\_name": "Autumn Roadshow",
&#x20; "roadshow\_member\_uid": "ead63b6b-198e-4bde-8ba8-c929fea9a376",
&#x20; "roadshow\_member\_status": "registered"
}
:::

Each returns an empty string if the Program does not exist on the event, or if the Person is not a member of it. `roadshow_name` returns the Program's name whether or not the Person is a member, so pair it with `roadshow_member_status` to tell membership from a plain name lookup.

Because the `program_uid` is fixed in the template, this form is tied to one event's Programs. Use programs when the same mapping has to work across events.

### Field reference

| Key                      | Merge tag                                       | Emits                                                                                                                                                      |
| ------------------------ | ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| programs                 | \<\<PROGRAMS\_LIST\|...>>                       | JSON array of the Programs the Person belongs to, each with the Program UID, Program name, membership UID and membership status. Unquoted in the template. |
| roadshow\_name           | \<\<PROGRAM\_NAME\|program\_uid:...>>           | Text. The named Program's name.                                                                                                                            |
| roadshow\_member\_uid    | \<\<PROGRAM\_MEMBER\_UID\|program\_uid:...>>    | Text. The Person's membership UID for the named Program.                                                                                                   |
| roadshow\_member\_status | \<\<PROGRAM\_MEMBER\_STATUS\|program\_uid:...>> | Text. The Person's membership status for the named Program.                                                                                                |

The key names starting roadshow\_ are examples. Name them after the Program they point at.
