GET api/Groups
Get Group records. Supported Headers: Filter, Sort, SortDesc, SelectField
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of MutableEntityExtended| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| ParentId |
This field will only include data when working with Group records. |
globally unique identifier |
None. |
| Fields | Dictionary of string [key] and Object [value] |
None. |
|
| LinkedEntities | LinkedEntities |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Id": "92abb3f3-78c0-4251-8fe9-72b6db2209cc",
"ParentId": "aa65b2d7-dd7a-462d-94d5-3cfbc00a52b4",
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"LinkedEntities": {
"Contacts": [
"3453d6fd-bdfe-4afa-aa19-26da8de35424",
"1a3fb947-ca2e-42b3-9918-498753fbd2e6"
],
"Companies": [
"a396cf0d-9252-4e2c-b449-8bb5c1f88511",
"b853214d-8b61-46a7-b852-1d3b649c1069"
],
"Groups": [
"03e8ff0b-6a05-4a85-90ae-f7bc0df8da9f",
"df5f4f7c-499c-4b42-81eb-536d351122ff"
],
"Opportunities": [
"173ee2b0-d158-433b-b504-b1db02e4c1df",
"233a2fd6-14d6-449b-865b-d1e740839be3"
]
}
},
{
"Id": "92abb3f3-78c0-4251-8fe9-72b6db2209cc",
"ParentId": "aa65b2d7-dd7a-462d-94d5-3cfbc00a52b4",
"Fields": {
"sample string 1": {},
"sample string 3": {}
},
"LinkedEntities": {
"Contacts": [
"3453d6fd-bdfe-4afa-aa19-26da8de35424",
"1a3fb947-ca2e-42b3-9918-498753fbd2e6"
],
"Companies": [
"a396cf0d-9252-4e2c-b449-8bb5c1f88511",
"b853214d-8b61-46a7-b852-1d3b649c1069"
],
"Groups": [
"03e8ff0b-6a05-4a85-90ae-f7bc0df8da9f",
"df5f4f7c-499c-4b42-81eb-536d351122ff"
],
"Opportunities": [
"173ee2b0-d158-433b-b504-b1db02e4c1df",
"233a2fd6-14d6-449b-865b-d1e740839be3"
]
}
}
]