Contact Group Member GET

URI

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

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

Description

This message allows you to get the membership of a contact group.

You may optionally specify to include the contact IDs as an ID set. If you include the contact IDs as an ID set you may optionally exclude the contact ID list. To use this functionality simply use the optional sections.

Field Included By Default Can Be Excluded
contactMemberIds True True
contactMemberIdSet False N/A

Example 1

Get the members of contact group 1000.

Request URI

/contact-group/1000/member

Request body

{
}

Response

{
	"response": {
		"contactMemberIds": [
			22,
			23,
			34,
			35,
			36,
			37,
			202,
			204
		]
	}
}

Example 2

Get the members of contact group 1000 including optional ID set and excluding ID list.

Request URI

/contact-group/1000/member?includeOptional=contactMemberIdSet&excludeOptional=contactMemberIds

Request body

{
}

Response

{
	"response": {
		"contactMemberIdSet": "22-23,34-37,202,204"
	}
}