Apollo API Documentation

Account API calls


Get account

GET /account

Returns info about the current Apollo account, its subscription, the default post and attachment categories, the time entry categories and the project categories. Includes:

  • account login, name, email, culture, timezone, creation timestamp, whether the account imeage is a gravatar or not, referral code, avatar url
  • workspace name, third level domain and main domain
  • default message to use when another user is invited (administrator only)
  • default culture to set to newly created users (administrator only)
  • whether to display tasks assigned to anyone in My tasks page (account owner only)
  • whether to display tasks assigned to my company in My tasks page (account owner only)
  • whether to hide the remember me checkbox in the login page (account owner only)
  • whether to prepend the project name in Apollo email subjects (account owner only)
  • primary company's id and name (account owner only)
  • subscription: plan name, maximum number of projects, crm-users, contacts and deals, maximum storage in MegaBytes
  • usage: active projects, internal users, external users, crm users, contacts, cases, deals and storage in MegaBytes

Response

{
	"account":{
		"login":"john",
		"first-name":"John",
		"last-name":"Smith",
		"email":"jsmith@gmail.com",
		"culture":"en_US",
		"timezone":"America/New_York",
		"created-at":"2010-03-16 01:15:33",
		"use-gravatar":"0",
		"referral-code":"hgdue",
		"avatar-url":"account.apollohq.com/avatar/hgdue",
		"default-message-categories":[
			{
				"id":"9584760",
				"name":"Code",
				"type":"messages-category"
			},
			{
				"id":"1284011",
				"name":"Design",
				"type":"messages-category"
			}
		],
		"default-file-categories":[
			{
				"id":"6378498",
				"name":"Documents",
				"type":"files-category"
			},
			{
				"id":"5378982",
				"name":"Pictures",
				"type":"files-category"
			}
		],
		"time-categories":[
			{
				"id":"1257840",
				"name":"Example 1"
			},
			{
				"id":"5672048",
				"name":"Example 2"
			}
		],
		"default-invite-message":"Welcome",
		"project-categories":[
			{
				"id":"5793562",
				"name":"Design",
				"color":"#228b22"
			},
			{
				"id":"8489991",
				"name":"Programming",
				"color":"#696969"
			}
		],
		"third-level-domain":"smith",
		"main-domain":"apollohq.com",
		"domain-name":"Smith",
		"show-tasks-assigned-to-anyone":"1",
		"show-tasks-assigned-to-my-company":"1",
		"disable-remember-me":"0",
		"prepend-project-name-in-mail-subject":"1",
		"main-company-name":"Smith's",
		"subscription":{
			"name":"Max",
			"storage":"76800",
			"projects":"infinity",
			"project-users":"infinity",
			"crm-users":"infinity",
			"contacts":"50000",
			"deals":"infinity",
			"time-tracking":"yes"
		},
		"usage":{
			"active-projects":5,
			"storage":22.15,
			"internal-users":11,
			"external-users":78,
			"crm-users":2,
			"contacts":10131,
			"deals":2,
			"cases":3
		}
	}
}