Account info

Account Object

Main properties of an Account object are:

Property	Type	Description
id	string	Unique identifier of the account
username	string	Username used in login
email	string	Contact email of the account
fullName	string	Full name of the account owner
avatarUrl	string	URL of the account avatar
createdAt	timestamp	UTC creation date/time of the account
subscription	Account Subscription object See below	Set of feature/limits info related to the account and its plan

Account Subscription object

Account object includes a "subscription" nested object which resumes account's plan status.

Property	Type	Description
createdAt	timestamp	UTC subscription date/time of the account's current plan
expiredAt	timestamp	UTC expiration date/time of the account's current plan, when plan's category is not free
limits	Dictionary of Account Limits objects See below	Account's resources usage and limits: how many links/domains/tags/etc created so far and which are the maximum limits

Account Limits object

Account Subscription object includes a limits dictionary indicating how many:

links
domains
workspaces
teammates
tags
scripts

there are in the account and how many can be created.
Each of the objects, having as dictionary key its own name as expressed above, has the following properties specified:

Property	Type	Description
used	numeric	How many resources of the given type used
max	numeric	How many resources of the given type the account is allowing

Account Features object

Account Subscription object includes a features dictionary of booleans indicating whether you have or not the following features:

Retargeting scripts (features.links.scripts)
Tags (features.links.tags)
Emoji on slashtag (features.links.emoji)
Notes on links (features.links.notes)
Ability to change your custom homepage and custom 404 on your domains (features.domains.whitelabeled)

If you are implementing an application for third parties, you are supposed to first check whether the Account object is allowing you a specific feature, and then you can proceed with using endpoints related to that feature.

Account management

Here are some basic operations you can perform regarding Account resources:

Operation	Details
Get account details	See Getting account details

Example Account object

{
  "id": "3aehje9d536s46d59ba5bcf49b582ear",
  "fullName": "Stanford University",
  "username": "[email protected]",
  "email": "[email protected]",
  "avatarUrl": "https://d3e7f5z1blhqw4.cloudfront.net/avatars/364381e1-963e-460a-9a6b-a16e86d196a2",
  "createdAt": "2016-07-13T10:54:12.000Z",
  "subscription": {
    "createdAt": "2016-07-13T10:54:12.000Z",
    "limits": {
      "links": {
        "used": 7504,
        "max": 10000
      },
      "domains": {
        "used": 17,
        "max": 100
      },
      "workspaces": {
        "used": 1,
        "max": 50
      },
      "teammates": {
        "used": 5,
        "max": 100
      },
      "tags": {
        "used": 0,
        "max": 50
      },
      "scripts": {
        "used": 0,
        "max": 50
      }
    }
  }
}