Retrieve all contactgroups which match the passed criteria
Name | Description | Type | Additional information |
---|---|---|---|
top
Select only the first N contact groups of the list. read more
Type
string
Additional info
Optional, Default value is 25
|
|||
top |
Select only the first N contact groups of the list. read more |
string |
Optional, Default value is 25 |
skip |
Skip the first N contact groups of the list. read more |
string |
Optional |
select
Define the properties which you want in the result. If empty all not-empty properties are returned. read more
Type
string
Additional info
Optional
|
|||
select |
Define the properties which you want in the result. If empty all not-empty properties are returned. read more |
string |
Optional |
filter
Select only the contact groups that satisfy the predicate expression. read more
Type
string
Additional info
Optional
|
|||
filter |
Select only the contact groups that satisfy the predicate expression. read more |
string |
Optional |
orderby
Define the properties which are used to order the list of contact groups. read more
Type
string
Additional info
Optional
|
|||
orderby |
Define the properties which are used to order the list of contact groups. read more |
string |
Optional |
Payload containing a list of contact groups.
Name | Description | Type | Additional information |
---|---|---|---|
Meta
The metadata such as paging parameters, status code, timestamp,... which are related to this request.
Type
MetaData
|
|||
Meta |
The metadata such as paging parameters, status code, timestamp,... which are related to this request. |
MetaData | |
Data |
The actual data returned by the request. |
Collection of 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. |
Hateoas |
{ "Meta": { "Status": 1, "TotalRowCount": 1, "Limit": 1, "Offset": 1, "TotalPageCount": 1, "StartRec": 1, "StopRec": 1, "Timestamp": "2024-12-12T21:10:59.6342398Z", "IsFiltered": true }, "Data": [ { "GroupId": 1, "ContactCount": 2, "LastModifiedDate": "2024-12-12T21:10:59.6342398Z", "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 }, { "GroupId": 1, "ContactCount": 2, "LastModifiedDate": "2024-12-12T21:10:59.6342398Z", "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 } ] }
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/"> <Data> <Group z:Id="i2"> <Description>sample string 4</Description> <GroupFolderId>1</GroupFolderId> <Name>sample string 3</Name> <ContactCount>2</ContactCount> <GroupId>1</GroupId> <LastModifiedDate>2024-12-12T21:10:59.6342398+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> </Group> <Group z:Ref="i2" /> </Data> <Meta> <IsFiltered>true</IsFiltered> <Limit>1</Limit> <Offset>1</Offset> <StartRec>1</StartRec> <Status>1</Status> <StopRec>1</StopRec> <Timestamp>2024-12-12T21:10:59.6342398+00:00</Timestamp> <TotalPageCount>1</TotalPageCount> <TotalRowCount>1</TotalRowCount> </Meta> </Payload>