View the Contacts of a specified group

View the contacts that a group is consisted of.

QUERY PARAMETERS

KEY

OPTIONAL

DESCRIPTION

EXAMPLE

page

Yes

The page number to retrieve, default value is 0 (meaning the first page).

1

size

Yes

The number of items to retrieve, default value is 10.

1

sort

Yes

The label name that will be used to sort the results.

firstName

RESPONSE PARAMETERS

KEY

DESCRIPTION

totalPages

The number of total pages.

last

Whether the current page is the last one.

totalElements

The total amount of elements for the current search.

first

Whether the current page is the first one.

numberOfElements

The number of elements currently on this page.

number

The requested page number.

size

The requested page size.

content

Contains the search results.

content.blacklistedServices

Defines all the services for which the contact has been blacklisted.

content.country

The country information of the contact.

content.labels

Contains the contact's labels with their respective values.

content.email

The e-mail address of the contact.

content.firstName

The first name of the contact.

content.id

The identification of the contact.

content.lastName

The last name of the contact.

content.groups

All contact groups (tags) that this contact belongs to.

content.mobile

The mobile number of the contact.

content.vip

Indicates whether the contact is treated as vip or not.

content.labels.name

The name of the label.

content.labels.type

The type of the label. Supported types are: Text or Number.

content.labels.value

The value of the label.

ERROR CODES

STATUS

CODE

DESCRIPTION

404

404001001

Account not found

404

404002003

The contact group is not found

Language