Help / API

group.get / Live testing

Get details about a group.

This method call does not require authentication.
This method does not require any particular permission.

URL

http://www.ipernity.com/api/group.get

Parameters

`api_key`	∗	Your api_key.
`group_id`	∗	The Group ID (or Group Alias) to get details about.
`lang`		The language code of the group title and description to fetch. If not specified, the calling user language or the browser language will be used by default.

∗ : this parameter is required.

Response

<group id="12345" title="A very cool group" lang="en-us"
       link="http://www.ipernity.com/group/acoolgroup"
       icon="http://u1.ipernity.com/p/00/01/12345.jpg">
  <description>A cool group with a cool description</description>
  
  <quota moderated="0" max="10" period="w" left="3"/>

  <can add_doc="1" add_topic="1" 
       accept_photo="1" accept_audio="0" accept_video="1" accept_other="0" />

  <visibility ispublic="1" docs="1" topics="1"/>

  <dates created_at="1218038768" 
         last_doc_at="1218048563" last_topic_at="1218048231"/>

  <count members="125" docs="2563" topics="13"/>

  <you isadmin="0" ismoderator="1" ismember="1" docs="255" 
       joined_at="123456585" visited_at="1218039770"/>
</group>

The visibility.ispublic property indicates:

ispublic="1" : the group is public and open to everyone
ispublic="2" : the group is public, invitation only
ispublic="0" : the group is private

The quota only applies on docs. New docs are moderated if quota.moderated is set to 1.
A quota.max="0" means no quota. The quota period values are:

period="d" for a day
period="w" for a week
period="m" for a month
empty for all time

The quota limitations are only applied on members.

Error codes

1	`Group not found`	The group ID is invalid or insufficient permissions to view this group.

100	`API Key is missing`	Please add the api_key parameter to this request.
101	`API Key is invalid`	This API key is invalid or disabled.
102	`Invalid format`	The requested format is invalid. Valid formats are : json, xml, php.
103	`Method not found`	The requested method is invalid or missing.
104	`Signature missing`	The query signature is missing.
105	`Signature is invalid`	The query signature is invalid.
106	`Token missing`	User is not logged. The authentication token is missing.
107	`Token invalid`	The authentication token is invalid.
108	`Account closed`	The user account is closed or suspended.
109	`Action blocked`	This action is blocked because of a member or a group blocklist restriction
110	`Insufficient permissions`	Insufficient permissions for this method.
111	`IP not allowed`	The request came from a remote address not allowed by this application.
112	`Application Quota Error`	The application has reached its requests quota.
113	`Client IP Quota Error`	The client IP has reached a limit. Limits are based on requests per seconds, minutes, hours, ...
120	`HTTP POST required`	This API method must be called using HTTP POST.
121	`Invalid SOAP envelope`	The SOAP envelope could not be parsed.
122	`Invalid XML-RPC envelope`	The XML-RPC envelope could not be parsed.
500	`Service error`	Service general error.
501	`Maintenance mode`	Service under temporarily maintenance. Thank you for your kind understanding.
503	`Service unavailable`	The service is temporarily unavailable. Please try again in a few minutes.

Changelog

2008-12-01: Method created.