GET api/contacts/{id}/contacttags?offset={offset}&limit={limit}&returnTotal={returnTotal}
Get all ContactTag children that are related to the supplied Contact id.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The primary key of the Contact record. |
integer |
Required |
| offset |
The position in the collection of ContactTags from which to start returning data from. |
integer |
Default value is 0 |
| limit |
The maximum amount of ContactTags that can be returned in any one call. Maximum allowed is 500. |
integer |
Default value is 100 |
| returnTotal |
Whether to include the total amount of ContactTags in the database that match the filter specified. |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
ContactTagDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The primary key of the record in the Hobsons database. Ignored for POST requests sent to the API. |
integer |
None. |
| CrmNumber |
A reference to the primary key of the Contact record that is associated with this record. |
integer |
Required Range: inclusive between 1 and 2147483647 |
| TagId |
A reference to the primary key of the Tag record that is associated with this record. |
integer |
Required Range: inclusive between 1 and 99999999 |
| TagName |
The name of the Tag record that is associated with this record. Ignored for POST requests sent to the API. |
string |
None. |
| TagTypeId |
A reference to the primary key of the TagType record that is associated with the Tag record. Ignored for POST requests sent to the API. |
integer |
None. |
| TagTypeName |
The name of the TagType record that is associated with the Tag record. Ignored for POST requests sent to the API. |
string |
None. |
| DateCreated |
The date that the ContactTag record was created, i.e. the date that a Tag record was associated with a Contact record. Ignored for POST requests sent to the API. |
date |
None. |
| TagDate |
If not provided for POST requests, defaults to current date time. |
date |
Range: inclusive between 1 Jan 1900 and 31 Dec 2099 |
Response Formats
application/json, text/json
{
"Id": 1,
"CrmNumber": 2,
"TagId": 3,
"TagName": "sample string 4",
"TagTypeId": 5,
"TagTypeName": "sample string 6",
"DateCreated": "2024-05-20T07:56:55.288597+10:00",
"TagDate": "2024-05-20T07:56:55.288597+10:00"
}