Skip to navigation
API ReferenceGroups

Get group contacts

Authentication

X-API-Keystring
Your Esendex API key.

Path parameters

groupIdstringRequiredformat: "uuid"

Headers

AccountReferencestringRequired>=1 character
Mandatory AccountReference header

Query parameters

DestinationstringOptional
OptOutStatusenumOptional
Allowed values:
AddressTypestringOptional
MetadataKeystringOptional
MetadataValuestringOptional
SearchstringOptional
ContactOwnershipenumOptional
Allowed values:
SortByenumOptional
SortOrderenumOptional
Allowed values:
PageNointeger or stringOptional
PageSizeinteger or stringOptional

Response

OK
dataobject or nullOptional
errorslist of objects or nullOptional

Errors

400
Bad Request Error
404
Not Found Error