API Documentation

Users /api/users

The Users API is available for you to get details about a specific user.

List users

GET /users

See GET /api/me/connections in the Me API

Get a single user

GET user/:id

Example output

{ "user_since" : "2013-12-05T10:02:29Z",
  "email" : "info@organisedminds.com",
  "avatar" : {
    "thumb_url" : "https://app.organisedminds.com/assets/app/no-profile.jpg",
    "url" : "https://app.organisedminds.com/assets/app/no-profile.jpg"
  },
  "id" : "0e831e95cc54",
  "name_or_email" : "Tester The Great",
  "last_name" : "The Great",
  "first_name" : "Tester"
}

Invite a user to collaborate

PUT /user/:id/collaborate

Invite the given users to collaborate. Returns the invitation.

Example output

{ "invitation" : {
  "id" : 6,
  "declined?" : false,
  "pending?" : true,
  "accepted?" : false,
  "created_at" : "2013-12-05T18:52:34Z",
  "to" : {
     "user" : {
        "user_since" : "2013-12-05T10:02:29Z",
        "email" : "info@organisedminds.com",
        "avatar" : {
           "thumb_url" : "https://app.organisedminds.com/assets/app/no-profile.jpg",
           "url" : "https://app.organisedminds.com/assets/app/no-profile.jpg"
        },
        "id" : "0e831e95cc54",
        "name_or_email" : "Tester The Great",
        "last_name" : "The Great",
        "first_name" : "Tester"
     }
  },
  "user" : {
     "user_since" : "2013-12-05T10:02:29Z",
     "email" : "john@example.com",
     "avatar" : {
        "thumb_url" : "https://app.organisedminds.com/assets/app/no-profile.jpg",
        "url" : "https://app.organisedminds.com/assets/app/no-profile.jpg"
     },
     "id" : "4e861e35ab45",
     "name_or_email" : "John Doe",
     "last_name" : "Doe",
     "first_name" : "John"
  },
  "from_user" : {
     "user_since" : "2013-12-05T10:02:29Z",
     "email" : "info@organisedminds.com",
     "avatar" : {
        "thumb_url" : "https://app.organisedminds.com/assets/app/no-profile.jpg",
        "url" : "https://app.organisedminds.com/assets/app/no-profile.jpg"
     },
     "id" : "0e831e95cc54",
     "name_or_email" : "Tester The Great",
     "last_name" : "The Great",
     "first_name" : "Tester"
  }
} }
comments powered by Disqus