Contact Group GET

URI

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

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

Description

This message allows you to get contact groups. The message takes an ID set which is not limited by size allowing you to specify contact group IDs.

Optional sections you may exclude:

  • description

Example 1

Request all contact groups in range 1000 to 1005.

Request URI

/contact-group/1000-1005

Response

{
	"response": [
		{
			"id": 1000,
			"name": "Group One",
			"description": "Contains All Admins.",
			"isReadOnly": true,
			"createdBy": 5,
			"createdOn": "2011-09-28T11:06:43.000+01:00"
		},
		{
			"id": 1001,
			"name": "Staff Members",
			"description": "Contains all staff members.",
			"isReadOnly": false,
			"createdBy": 5,
			"createdOn": "2011-09-28T11:06:47.000+01:00"
		},
		{
			"id": 1002,
			"name": "Important Customers",
			"description": "Contains all import customers.",
			"isReadOnly": false,
			"createdBy": 5,
			"createdOn": "2011-09-28T11:06:50.000+01:00"
		}
	]
}

Example 2

Request contact group 1000 and exclude the description.

Request URI

/contact-group/1000?excludeOptional=description

Response

{
	"response": [
		{
			"id": 1000,
			"name": "Group One",
			"isReadOnly": true,
			"createdBy": 5,
			"createdOn": "2011-09-28T11:06:43.000+01:00"
		}
	]
}