List Group Contact Request REST Endpoint

Ben Tiedt — Fri, 08 Mar 2024 17:46:39 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:46:39

GET api.ashx/v2/groups/{groupid}/contactrequests.{json|xml}

LIST contact requests for a group.

Scopes

Groups › Read Contact Requests groups.contactrequests.readonly

Request Parameters

Name	Type	Description	Required
GroupId	int	Group Id	Required
PageIndex	int?	Specify the page number of paged results to return. Zero-based index. If not specified the default is 0.	Optional
PageSize	int?	Specify the number of results to return per page. If not set the default is 20. The max is 100.	Optional

Example Requests

Widget Javascript

jQuery.telligent.evolution.get({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/groups/{groupid}/contactrequests.json',
	data: { 
		'groupid': '6'
	}
}).then(function(response) {
	// use response
});

Example Responses

JSON

{
  "PageSize": 2,
  "PageIndex": 0,
  "TotalCount": 2,
  "ContactRequests": [
    {
      "Group": {
        "AvatarUrl": "avatarurl",
        "DateCreated": "2012-01-04T00:00:00",
        "Description": "description",
        "Key": "key",
        "Name": "name",
        "ParentGroupId": 6,
        "Url": "url",
        "TotalMembers": 25,
        "HasGroups": true,
        "GroupCount": 8,
        "GroupType": "grouptype",
        "EnableGroupMessages": true,
        "EnableContact": true,
        "SearchUniqueId": "searchuniqueid",
        "IsEnabled": true,
        "ExtendedAttributes": [
          {
            "Key": "key",
            "Value": "value"
          },
          {
            "Key": "key",
            "Value": "value"
          }
        ],
        "ContainerId": "49fec544-6df7-4a82-872b-f8be586d5e9e",
        "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
        "Container": {
          "ContainerId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
          "ContainerTypeId": "fe65240b-044c-4292-9946-f10e0361ecff",
          "HtmlName": "htmlname",
          "Url": "url",
          "AvatarUrl": "avatarurl"
        },
        "Id": 4
      },
      "Subject": "subject",
      "Body": "body",
      "Name": "name",
      "EmailAddress": "emailaddress",
      "DateCreated": "2012-05-02T00:00:00",
      "Id": 7
    },
    {
      "Group": {
        "AvatarUrl": "avatarurl",
        "DateCreated": "2012-06-04T00:00:00",
        "Description": "description",
        "Key": "key",
        "Name": "name",
        "ParentGroupId": 27,
        "Url": "url",
        "TotalMembers": 32,
        "HasGroups": true,
        "GroupCount": 52,
        "GroupType": "grouptype",
        "EnableGroupMessages": true,
        "EnableContact": true,
        "SearchUniqueId": "searchuniqueid",
        "IsEnabled": true,
        "ExtendedAttributes": [
          {
            "Key": "key",
            "Value": "value"
          },
          {
            "Key": "key",
            "Value": "value"
          }
        ],
        "ContainerId": "2d525bad-c4df-470d-a193-a1c6d66e5c3e",
        "ContainerTypeId": "23b05a61-c3e5-4451-90d9-bfa00453bce4",
        "Container": {
          "ContainerId": "bd519379-b61f-4e2f-b0f9-c0f28c5cceb1",
          "ContainerTypeId": "9ba1ec43-dc34-4e27-a579-4a0855144e2f",
          "HtmlName": "htmlname",
          "Url": "url",
          "AvatarUrl": "avatarurl"
        },
        "Id": 19
      },
      "Subject": "subject",
      "Body": "body",
      "Name": "name",
      "EmailAddress": "emailaddress",
      "DateCreated": "2011-05-28T00:00:00",
      "Id": 112
    }
  ],
  "Info": [
    "string",
    "string"
  ],
  "Warnings": [
    "string",
    "string"
  ],
  "Errors": [
    "string",
    "string"
  ]
}

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <Info>
    <Message>string</Message>
    <Message>string</Message>
  </Info>
  <Warnings>
    <Message>string</Message>
    <Message>string</Message>
  </Warnings>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
  <ContactRequests PageSize="2" PageIndex="0" TotalCount="2">
    <GroupContactRequest>
      <Id>7</Id>
      <Group>
        <Id>4</Id>
        <AvatarUrl>avatarurl</AvatarUrl>
        <DateCreated>2012-01-04T00:00:00</DateCreated>
        <Description>description</Description>
        <Key>key</Key>
        <Name>name</Name>
        <ParentGroupId>6</ParentGroupId>
        <Url>url</Url>
        <TotalMembers>25</TotalMembers>
        <HasGroups>true</HasGroups>
        <GroupCount>8</GroupCount>
        <GroupType>grouptype</GroupType>
        <EnableGroupMessages>true</EnableGroupMessages>
        <EnableContact>true</EnableContact>
        <SearchUniqueId>searchuniqueid</SearchUniqueId>
        <ExtendedAttributes>
          <key>value</key>
          <key>value</key>
        </ExtendedAttributes>
        <ContainerId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContainerId>
        <Container>
          <ContainerId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContainerId>
          <ContainerTypeId>fe65240b-044c-4292-9946-f10e0361ecff</ContainerTypeId>
          <HtmlName>htmlname</HtmlName>
          <Url>url</Url>
          <AvatarUrl>avatarurl</AvatarUrl>
        </Container>
      </Group>
      <Subject>subject</Subject>
      <Body>body</Body>
      <Name>name</Name>
      <EmailAddress>emailaddress</EmailAddress>
      <DateCreated>2012-05-02T00:00:00</DateCreated>
    </GroupContactRequest>
    <GroupContactRequest>
      <Id>112</Id>
      <Group>
        <Id>19</Id>
        <AvatarUrl>avatarurl</AvatarUrl>
        <DateCreated>2012-06-04T00:00:00</DateCreated>
        <Description>description</Description>
        <Key>key</Key>
        <Name>name</Name>
        <ParentGroupId>27</ParentGroupId>
        <Url>url</Url>
        <TotalMembers>32</TotalMembers>
        <HasGroups>true</HasGroups>
        <GroupCount>52</GroupCount>
        <GroupType>grouptype</GroupType>
        <EnableGroupMessages>true</EnableGroupMessages>
        <EnableContact>true</EnableContact>
        <SearchUniqueId>searchuniqueid</SearchUniqueId>
        <ExtendedAttributes>
          <key>value</key>
          <key>value</key>
        </ExtendedAttributes>
        <ContainerId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContainerId>
        <Container>
          <ContainerId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContainerId>
          <ContainerTypeId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ContainerTypeId>
          <HtmlName>htmlname</HtmlName>
          <Url>url</Url>
          <AvatarUrl>avatarurl</AvatarUrl>
        </Container>
      </Group>
      <Subject>subject</Subject>
      <Body>body</Body>
      <Name>name</Name>
      <EmailAddress>emailaddress</EmailAddress>
      <DateCreated>2011-05-28T00:00:00</DateCreated>
    </GroupContactRequest>
  </ContactRequests>
</Response>