Profile

The methods described here will allow you to manage your profile: change name description, add and remove email addresses, and manage SSH keys. You must be logged in to perform any of the operations.

Get the authenticated user

Returns the authorized user.
Required scopes: USER_INFO

Resource URL

GET
/user

Example

Request
GET
https://api.buddy.works/user
Sample Response
Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
{
  "url": "https://api.buddy.works/user",
  "html_url": "https://app.buddy.works/my-id",
  "id": 1,
  "name": "Mike Benson",
  "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png",
  "title": "Creative director",
  "workspaces_url": "https://api.buddy.works/workspaces"
}

Update the authenticated user

Updates the authorized user.
Required scopes: USER_INFO

Resource URL

PATCH
/user

POST Parameters

Name Description
name String The full name of the authenticated user.
title String The title of the authenticated user.

Example

Request
PATCH
https://api.buddy.works/user
{
  "title": "Creative director"
}
Sample Response
Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
{
  "url": "https://api.buddy.works/user",
  "html_url": "https://app.buddy.works/my-id",
  "id": 1,
  "name": "Mike Benson",
  "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png",
  "title": "Creative director",
  "workspaces_url": "https://api.buddy.works/workspaces"
}
esc

Sign up for free

No setup fees. No requirements. No obligation.

or sign up with