API Documentation

Emails

List your emails

Returns the emails of the authorized user.

Required scopes: USER_EMAIL

Resource URL
GET /user/emails
Example
Request
GET https://api.buddy.works/user/emails
Sample Response
Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
{
  "url": "https://api.buddy.works",
  "html_url": "https://app.buddy.works/my-id",
  "emails": [
    {
      "email": "mike@buddy.works",
      "confirmed": false
    }
  ]
}

Add email

Adds a new email address to the authorized user.

Required scopes: MANAGE_EMAILS

Resource URL
POST /user/emails
POST Parameters
Name Description
email Required String The user’s email.
Example
Request
POST https://api.buddy.works/user/emails
{
  "email": "mike.benson@buddy.works"
}
Sample Response
Status: 200 OK
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
{
  "email": "mike.benson@buddy.works",
  "confirmed": false
}

Delete email

Deletes the email of the authorized user.

Required scopes: MANAGE_EMAILS

Resource URL
DELETE /user/emails/:email
Example
Request
DELETE https://api.buddy.works/user/emails/mike.benson@buddy.works
Sample Response
Status: 204 NoContent
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

Get started now

14 days of unlimited trial. No credit card required.