Section ID: DOC-API-MODEL-schema-okk1bp39s4#overview

SubscriberSummary

Contact and presence information returned in a subscriber listing.

Meaning and usage

Section ID: DOC-API-MODEL-schema-okk1bp39s4#meaning

See the definition above.

Usage profiles

Section ID: DOC-API-MODEL-schema-okk1bp39s4#fields

Usage	Fields and validation
In responses	View fields

In responses

Section ID: DOC-API-MODEL-schema-okk1bp39s4#response

API JSON uses JSON field names (camelCase).

Field	Type	Presence	Meaning
Section ID: DOC-API-MODEL-schema-okk1bp39s4#field-subscriberidSection ID: DOC-API-MODEL-schema-okk1bp39s4#response-field-subscriberidsubscriberId	string	Optional	Identifier of the notification subscriber.
Section ID: DOC-API-MODEL-schema-okk1bp39s4#field-emailSection ID: DOC-API-MODEL-schema-okk1bp39s4#response-field-emailemail	string	Optional	Email address used for subscriber contact and delivery.
Section ID: DOC-API-MODEL-schema-okk1bp39s4#field-firstnameSection ID: DOC-API-MODEL-schema-okk1bp39s4#response-field-firstnamefirstName	string	Optional	Subscriber’s given name.
Section ID: DOC-API-MODEL-schema-okk1bp39s4#field-lastnameSection ID: DOC-API-MODEL-schema-okk1bp39s4#response-field-lastnamelastName	string	Optional	Subscriber’s family name.
Section ID: DOC-API-MODEL-schema-okk1bp39s4#field-isonlineSection ID: DOC-API-MODEL-schema-okk1bp39s4#response-field-isonlineisOnline	boolean	Optional	Whether the provider reports the subscriber currently online.
Section ID: DOC-API-MODEL-schema-okk1bp39s4#field-lastonlineatSection ID: DOC-API-MODEL-schema-okk1bp39s4#response-field-lastonlineatlastOnlineAt	string (date-time)	Optional	Time when the provider last observed the subscriber online.

Where used

Section ID: DOC-API-MODEL-schema-okk1bp39s4#where-used

Reference	Relationship
List all subscribers	POST /api/v1/notifications/manage/list-subscribers

Download the public reference contract.

• notifications OpenAPI

Document ID: DOC-API-MODEL-schema-okk1bp39s4