API

Users

Overview

  1. Get current user
  2. Update current user
  3. List contacts
  4. Get email availability
  5. Get username availability

Get current user

Endpoint

GET https://api.dropmark.com/v1/users/me

Input

Name Type Desc
include Array Additional attributes available to be returned: emails, teams, teams_total_count

Response

Status: 200 OK

{
  "id": 1,
  "name": "Jane Doe",
  "email": "jane@example.com",
  "username": "demo",
  "avatar": "https://gravatar.com/avatar/db450747b81669f6cea",
  "status": "active",
  "plan": "free"
}

Update current user

Endpoint

PUT https://api.dropmark.com/v1/users/me

Input

Name Type Desc
custom_domain* String Custom domain name
email String User’s primary email
labels* Boolean Set to false to hide collection labels
name String User’s full name
sort_by* String Collection’s sort: name, type, created_at, updated_at, last_accessed_at
sort_order* String Collection’s sort direction: asc, desc
username String  
view_mode* String Collection’s view mode: tile (default), shelf

* Available for accounts on a paid plan only

Example

{
  "email": "jane@example.com"
}

Response

Status: 200 OK

{
  "id": 1,
  "name": "Jane Doe",
  "email": "jane@example.com",
  "username": "demo",
  "avatar": "https://gravatar.com/avatar/db450747b81669f6cea",
  "status": "active",
  "plan": "free"
}

List contacts

“Contacts” are team members or users who the current user shares collections with.

Endpoint

GET https://api.dropmark.com/v1/users/contacts

Response

Status: 200 OK

[
  {
    "id": 1,
    "name": "Jane Doe",
    "email": "jane@example.com",
    "username": "demo",
    "avatar": "https://gravatar.com/avatar/db450747b81669f6cea",
    "status": "active",
    "plan": "free"
  }
]

Get email availability

Endpoint

GET https://api.dropmark.com/v1/users/email

Input

Name Type Desc
email String Email to check

Response

Status: 200 OK

{
  "code": "email_available",
  "message": "E-mail address available"
}

Get username availability

Endpoint

GET https://api.dropmark.com/v1/users/username

Input

Name Type Desc
username String Username to check

Response

Status: 200 OK

{
  "code": "username_available",
  "message": "Username address available"
}