Documentation

Installation: Ubuntu and Apache; OSX and Macports; AWS EC2 using an AMI; SUSE and Apache
API FAQs: General FAQs; Authenticating with OAuth 1.0a; How photos are generated; How to get specific photo sizes
Test APIs: GET /hello.json
Action APIs: POST /action/:id/create.json; POST /action/:id/delete.json
Activity APIs: GET /activities/list.json
Photo APIs: POST /photo/:id/delete.json; POST /photo/:id/update.json; GET /photos/list.json; GET /photo/:id/view.json; GET /photo/:id/nextprevious.json; POST /photo/upload.json
Tag APIs: GET /tags/list.json; POST /tag/:id/create.json; GET /tags/:id/update.json
Group APIs: GET /group/:id/view.json; GET /groups/list.json; POST /group/:id/create.json; POST /group/:id/delete.json; GET /groups/:id/update.json
Webhook APIs: POST /webhook/subscribe; GET /webhook/:id/view.json; POST /webhook/:id/delete.json

Get Groups

Purpose
Endpoint
Parameters
Examples
- Command line
- PHP
Response
- Sample

Purpose of the Get Groups API

Use this API to get a list of the user's groups.

Endpoint

Authentication: required

GET /groups/list.json

Parameters

None

Examples

Command Line (using openphoto-php)

source secrets.sh
./openphoto -p -h current.openphoto.me -e /groups/list.json

PHP (using openphoto-php)

$client = new OpenPhotoOAuth($host, $consumerKey, $consumerSecret, $oauthToken, $oauthTokenSecret);
$response = $client->get("/groups/list.json");

Response

The response is in a standard response envelope.

message, A string describing the result. Don't use this for anything but reading.
code, 200 on success
result, An array of Group objects

Sample

{
  "message" : "A list of your groups",
  "code" : 200,
  "result" : [
    {
      "id" : "e",
      "Name" : "e",
      "name" : "Everyone else",
      "members" : [
        "rachel.mathai@yahoo.com",
        "jaisen@jmathai.com",
        "joe@joe.com"
      ],
      "appId" : "openphoto-frontend"
    },
    {
      "id" : "d",
      "Name" : "d",
      "name" : "Rachel and Jaisen",
      "members" : [
        "rachel.mathai@yahoo.com",
        "jaisen@jmathai.com"
      ],
      "appId" : "openphoto-frontend"
    },
    {
      "id" : "f",
      "Name" : "f",
      "name" : "Random",
      "members" : [
        "joe@joe.com"
      ],
      "appId" : "openphoto-frontend"
    }
  ]
}