1. v3
  2. ContactGroups
  3. GET - 3/contactgroups/{groupid}

Definition

GET - 3/contactgroups/{GroupId}

Retrieve a contact group by id.

Required roles: Contacts (read)

This method will result in a 204 response if there is no contact group found for the requested id.

Request information

GroupId

The id of the contact group you would like to retrieve.


Type integer
Additional info
Required

Response information

Payload containing the requested contact group


Meta

The metadata such as paging parameters, status code, timestamp,... which are related to this request.


Type MetaData
Data

The actual data returned by the request.


Type Group
Links

HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic.


Type Hateoas

Sample: 
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2024-11-23T09:56:52.2012273Z",
    "IsFiltered": true
  },
  "Data": {
    "GroupId": 1,
    "ContactCount": 2,
    "LastModifiedDate": "2024-11-23T09:56:52.2012273Z",
    "ShowEmail": true,
    "ShowLastname": true,
    "ShowFirstname": true,
    "ShowLang": true,
    "ShowCustomField1": true,
    "ShowCustomField2": true,
    "ShowCustomField3": true,
    "ShowCustomField4": true,
    "ShowCustomField5": true,
    "ShowCustomField6": true,
    "ShowCustomField7": true,
    "ShowCustomField8": true,
    "ShowCustomField9": true,
    "ShowCustomField10": true,
    "ShowCustomField11": true,
    "ShowCustomField12": true,
    "ShowCustomField13": true,
    "ShowCustomField14": true,
    "ShowCustomField15": true,
    "ShowCustomField16": true,
    "ShowCustomField17": true,
    "ShowCustomField18": true,
    "ShowCustomField19": true,
    "ShowCustomField20": true,
    "ShowGender": true,
    "ShowDateOfBirth": true,
    "ShowStreet": true,
    "ShowHouseNumber": true,
    "ShowSuite": true,
    "ShowCity": true,
    "ShowPostalCode": true,
    "ShowProvince": true,
    "ShowState": true,
    "ShowCountry": true,
    "ShowPhone": true,
    "Name": "sample string 3",
    "Description": "sample string 4",
    "GroupFolderId": 1
  }
}
Sample: 
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data z:Id="i2">
    <Description>sample string 4</Description>
    <GroupFolderId>1</GroupFolderId>
    <Name>sample string 3</Name>
    <ContactCount>2</ContactCount>
    <GroupId>1</GroupId>
    <LastModifiedDate>2024-11-23T09:56:52.2012273+00:00</LastModifiedDate>
    <ShowCity>true</ShowCity>
    <ShowCountry>true</ShowCountry>
    <ShowCustomField1>true</ShowCustomField1>
    <ShowCustomField10>true</ShowCustomField10>
    <ShowCustomField11>true</ShowCustomField11>
    <ShowCustomField12>true</ShowCustomField12>
    <ShowCustomField13>true</ShowCustomField13>
    <ShowCustomField14>true</ShowCustomField14>
    <ShowCustomField15>true</ShowCustomField15>
    <ShowCustomField16>true</ShowCustomField16>
    <ShowCustomField17>true</ShowCustomField17>
    <ShowCustomField18>true</ShowCustomField18>
    <ShowCustomField19>true</ShowCustomField19>
    <ShowCustomField2>true</ShowCustomField2>
    <ShowCustomField20>true</ShowCustomField20>
    <ShowCustomField3>true</ShowCustomField3>
    <ShowCustomField4>true</ShowCustomField4>
    <ShowCustomField5>true</ShowCustomField5>
    <ShowCustomField6>true</ShowCustomField6>
    <ShowCustomField7>true</ShowCustomField7>
    <ShowCustomField8>true</ShowCustomField8>
    <ShowCustomField9>true</ShowCustomField9>
    <ShowDateOfBirth>true</ShowDateOfBirth>
    <ShowEmail>true</ShowEmail>
    <ShowFirstname>true</ShowFirstname>
    <ShowGender>true</ShowGender>
    <ShowHouseNumber>true</ShowHouseNumber>
    <ShowLang>true</ShowLang>
    <ShowLastname>true</ShowLastname>
    <ShowPhone>true</ShowPhone>
    <ShowPostalCode>true</ShowPostalCode>
    <ShowProvince>true</ShowProvince>
    <ShowState>true</ShowState>
    <ShowStreet>true</ShowStreet>
    <ShowSuite>true</ShowSuite>
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2024-11-23T09:56:52.2012273+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>