The response items returned in a groups.getGroups service call.
| Name | Type | Description | Possible Values |
|---|
| id | INT | The ID of the group. | INT |
| name | STRING | The name of the group. | STRING |
| description | STRING | A brief blurb about the group. History, purpose, location, ideas, awards, etc. The description is searchable. | STRING |
| note | STRING | Some text about the group. The note is not searchable. | STRING |
| logo | INT | The media ID that is used as the group logo. | INT |
| logo_height | INT | The original height of the media being used for the logo. | INT |
| logo_width | INT | The original width of the media being used for the logo. | INT |
| publicUrl | STRING | The url to access the group logo. The public url will log a hit against the media item when ever loaded. This would be best used on a group details page. | STRING |
| thumbUrl | STRING | The url to access the group logo. The thumb url will _NOT_ log a hit against the media item when loaded. This is best used in group galleries or plotting groups on a map. | STRING |
| url | STRING | The url of the group. This is used best if the group is for a company, an event with a unique url they wish to also direct traffic to. | STRING |
| created | YYYY-MM-DD HH:mm:SS | The date the group was created. | YYYY-MM-DD HH:mm:SS |
| createdBy | INT | The user ID of the user who created the group. | INT |
| memberCount | INT | The number of members in the group. | INT |
| mediaCount | INT | The number of media items in the group. | INT |
| approvedMediaCount | INT | The number of approved media items in the group. | INT |
| notDeniedMediaCount | INT | The number of not denied media items in the group. | INT |
| commentCount | INT | The number of comments in the group. | INT |
| approvedCommentCount | INT | The number of approved comments in the group. | INT |
| notDeniedCommentCount | INT | The number of not denied comments in the group. | INT |
| geo_longitude | LNG | The longitude of the group. This would be specified by the creator of the group. | NUMBER (-52.44) |
| geo_latitude | LAT | The latitude of the group. This would be specified by the creator of the group. | NUMBER (62.86) |
| moderationStatus | STRING | The moderation status of the group which has just been created. By default if this is not passed the groups moderationstatus will be unmoderated. | accepted, denied, unmoderated, moderated, notdenied, all |
| parentGroup | INT | The ID of the parent group if the current group is a child. | INT |
| address | STRING | The address of the group. | STRING |
| city | STRING | The city that the group is located in. | INT |
| country | STRING | The country that the group is located in. This will be a 2-letter country code. | STRING |
| state | STRING | This will be the state/province that the group is located in. It will be a 2-letter state/province code. | STRING |
| postalcode | STRING | A valid postal code to contact the group by. | STRING |
| newMediaEmailTemplateID | INT | This is the ID of the email template that is sent out when a user uploads media into the group. | INT |
| host | STRING | The name of the host who created the group or who is in charge of the group. | STRING |
| groupType | INT | This specifies if the group is a group or an event. 1 represents a group, 2 represents an event and 3 represents an assignment. | 1, 2, 3 |
| vhost | INT | The vhost ID that the group belongs to. | INT |
| other | ARRAY | An associated array that is used to store any additional information about the group that does not fit in any previous fields. This field is _NOT_ searchable or filterable. This is equivalent to the metadata field for media. | ARRAY |
| custom1 | STRING | A searchable and filterable field for any additional information that does not fit into any previous field. | STRING |
| treeleft | INT | Used internally for the sorting and ordering groups. | INT |
| treeright | INT | Used internally for the sorting and ordering groups. | INT |
| email | STRING | The email address to use to allow users to email content to this email address and have it uploaded and entered into the group. | STRING |
| totalCount | INT | If the includeTotalCount argument is set to true the total count of groups returned will be included in the response. | INT |