Contact Group Search

URI

https://{DATACENTER}.brightpearl.com/public-api/{ACCOUNT}
/contact-service/contact-group-search

Refer to our documentation on URI syntax for more information on how to construct URIs.

Columns

Name Required Sortable Filterable Data type Reference data Description
contactGroupId INTEGER None The ID of the Contact Group. Can be used to recover all information about a contact group by issuing a Contact Group GET.
name SEARCH_STRING None The Contact Group's name.
description SEARCH_STRING None The Contact Group's description.
numberOfMembers INTEGER None The number of group members.

Sorting

Sorted by Sort Direction
name ASC

More information

Instructions for working with resources can be found in Resource search design