Tag GET

URI

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

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

Description

Contact tags are a great way to organise and put customised visual reminders on your customers and suppliers. Usages can range anywhere from creating tags for each of your sales channels — e.g. tagging customers based on their purchase history — to creating tags specific to any events you may go to. You can even create customer service reminders such as 'bad payer'.

Using this message you can retrieve a list of all the tags created in your Brightpearl account, which you can then use for filtering contact data or managing tags using our Contact Tag POST and DELETE messages.

Detailed field description:

Field Name Field Description
tagId The tag ID.
tagName The tag name.
tagParentGroupId The parent tag ID (if any). If no ID exists, result will be '0'.
tagColor The tag color in Hexadecimal form.

Note: The ID set in the request URI is optional. If no ID set is given, the call will automatically return ALL Contact Tags.

Example 1

Request ALL tags. If successful, HTTP response status 200.

Request URI

/tag

Response

{
	"response": {
		"1": {
			"tagId": 1,
			"tagName": "Preferred Customer",
			"tagParentId": 0,
			"tagColor": "#99FFFF"
		},
		"2": {
			"tagId": 2,
			"tagName": "Bad Customer",
			"tagParentId": 0,
			"tagColor": "#98d698"
		},
		"3": {
			"tagId": 3,
			"tagName": "Blacklisted",
			"tagParentId": 0,
			"tagColor": "#ffd773"
		}
	}
}

Example 2

Request single or multiple tags using an ID Set. If successful, HTTP response status 200.

Request URI

/tag/1,3

Response

{
	"response": {
		"1": {
			"tagId": 1,
			"tagName": "Preferred Customer",
			"tagParentId": 0,
			"tagColor": "#99FFFF"
		},
		"3": {
			"tagId": 3,
			"tagName": "Blacklisted",
			"tagParentId": 0,
			"tagColor": "#ffd773"
		}
	}
}