Table of Contents

API Audience Endpoints

Get All Audiences

This Endpoint is used to get all Audiences in your Sentori Account.

Endpoint

URI https://api.sentoriapp.com/v2.0/audiences/
Method GET

Response

Field TypeDescription
ExternalID string ID of the Audience.
Namestring Name of the Audience.
Description string Description of the Audience.
Example
[
	{
		"ExternalID": "1234ABCD",
		"Name": "Staff",
		"Description": "Any contacts with an @mycompany.com address."
	},
	{
		"ExternalID": "ABCD1234",
		"Name": "Our Suppliers",
		"Description": "Contacts with the Suppliers field ticked."
	}
]

Get Audience Contacts

This Endpoint is used to get all the Contacts that match an Audience's criteria and are Emailable (those that are Unsubscribed or marked as having a Bad Email Address are excluded).

You can find the Audience External IDs on the Audience page in Sentori or by calling the Get All Audiences API Endpoint.

Endpoint

URI https://api.sentoriapp.com/v2.0/audiences/contacts/{AudienceExternalID}
Method GET

Response

Field TypeDescription
SystemIDinteger The SystemID of a Contact.
EmailAddressstring The email address of a Contact.
Example
[
	{
		"SystemID": "1",
		"EmailAddress": "contact1@sentori.co.uk"
	},
	{
		"SystemID": "2",
		"EmailAddress": "contact2@sentori.co.uk"
	},
]