Skip to content

API Doc: Author's Profile

Carson McLean edited this page Nov 30, 2016 · 3 revisions

GET /api/author/{AUTHOR_ID}

Used to get the profile of the author. Used with HTTP GET, {AUTHOR_ID} is the UUID of the author, which is required.

It returns a JSON object and contains the UUID of the author, the host, display name, the author url, a list of their friends, and optional attributes like bio.

Here is an example:
GET /api/author/9de17f29c12e8f97bcbbd34cc908f1baba40658e HTTP/1.1
Header: Value

200 Ok ...

{
  "id":"9de17f29c12e8f97bcbbd34cc908f1baba40658e",
  "host":"http://127.0.0.1:5454/",
  "displayName":"Lara",
  "url":"http://127.0.0.1:5454/author/9de17f29c12e8f97bcbbd34cc908f1baba40658e",
  "friends": [
    {
      "id":"8d919f29c12e8f97bcbbd34cc908f19ab9496989",
      "host":"http://127.0.0.1:5454/",
      "displayName":"Greg",
      "url": "http://127.0.0.1:5454/author/8d919f29c12e8f97bcbbd34cc908f19ab9496989"
    }
  ],

  # Optional attributes
  "github_username": "lara",
  "first_name": "Lara",
  "last_name": "Smith",
  "email": "[email protected]",
  "bio": "Hi, I'm Lara"
}

Clone this wiki locally