Apollo API Documentation

Data reference

The following sections describe the different data types used by Apollo API. Note that timestamps are always in UTC timezone.


Account

{
	"account":{
		"login":"john",
		"first-name":"John",
		"last-name":"Smith",
		"email":"jsmith@gmail.com",
		// The language is coded in two lowercase characters, according to the ISO 639-1
		// standard (for instance, en for English). The country is coded in two
		// uppercase characters, according to the ISO 3166-1 standard (for instance,
		// GB for Great Britain).
		"culture":"en_US",
		// A list of supported timezones can be found at
		// http://www.php.net/manual/en/timezones.php
		"timezone":"America/New_York",
		"created-at":"2010-03-16 01:15:33",
		"use-gravatar":"0", // 0 = don't use gravatar, 1 = use gravatar
		"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":"applicom",
		"main-domain":"apollohq.com",
		"domain-name":"Applicom",
		// 0 = show tasks, 1 = don't show them
		"show-tasks-assigned-to-anyone":"1",
		// 0 = show tasks, 1 = don't show them
		"show-tasks-assigned-to-my-company":"1",
		// 1 = disable remember me checkbox in the login page, 1 = don't disable it
		"disable-remember-me":"0",
		// 0 = don't prepend project name, 1 = prepend it
		"prepend-project-name-in-mail-subject":"1",
		"main-company-name":"Applicom",
		"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
		}
	}
}

Case

{
	"case":{
		"id":"7839378",
		"type":"case",
		// UTC timestamp
		"created-at":"2012-05-24 15:30:34",
		"updated-at":"2012-05-24 15:30:34",
		"created-by":"3562893",
		"updated-by":"2354847",
		"name":"A case",
		// possible values: open or closed
		"case-status":"open",
		// possible values are: public, only-me, group or selected-people
		"visibility":"selected-people",
		// only if you chose the "selected-people" value for the field "visibility"
		"allowed-users":["6186683","75362114"],
		"involved-people":["35275477","93550509"],
		// only if you chose the "group" value for the field "visibility"
		"workgroup":{
			"id":"52396960",
			"name":"My group",
			...
		},
		"attachment":["25306353"]
	}
}

Category

{
	"category":{
		"id":"341428",
		"name":"Assets",
		"type":"messages-category",
		"project-id":"252790"
	}
}

Calendar

{
	"calendar":{
		"id":"30563313",
		"creator-id":"25859382",
		"name":"A calendar",
		"color":"#8b4513"
	}
}

Calendar (legacy)

{
	"calendar":{
		"id":"30563313",
		"creator-id":"25859382",
		"name":"A calendar",
		"color":"#8b4513",
		// Possible values: public or personal
		"calendar-type":"public",
		// Possible values: 'read-only', 'read-add', 'read-add-edit-delete'
		"permissions":"read-add-edit-delete"
	}
}

Comment

{
	"comment":{
		"id":"91514865",
		"project-id":"27879753",
		"contact-id":null,
		"message-id":"456955",
		"task-id":null,
		"milestone-id":null,
		"note-id":null,
		"writeboard-id":null,
		"writeboard-revision-number":null,
		"body":"This is a comment",
		"created-at":"2012-05-07 15:15:26",
		"created-by":"42831026",
		// 0 = is not private, 1 = is private
		"is-private":"1",
		"attachments":[
			{
				"id":"427316",
				"byte-size":"28521",
				"name":"Blue hills",
				...
			},
			...
		]
	}
}

Company

{
	"company":{
		"id":"19875038",
		"name":"Applicom",
		"created-at":"2010-03-16 01:15:34"
	}
}

Contact

{
	"contact":{
		"id":"12926409",
		// possible values: person or company
		"type":"person",
		// UTC timestamp
		"created-at":"2012-05-24 15:30:34",
		"updated-at":"2012-05-24 15:30:34",
		"created-by":"40273530",
		"updated-by":"40273530",
		"info":"",
		"background-info":"",
		// visible only for persons
		"name":"John",
		// visible only for persons
		"last-name":"Smith",
		// visible only for companies
		"company-name":"Acme",
		// possible values are: public, only-me, group or selected-people
		"visibility":"selected-people",
		// only if you chose the "selected-people" value for the field "visibility"
		"allowed-users":["85075895","65473058"],
		// only if you chose the "group" value for the field "visibility"
		"workgroup":{
			"id":"95448215",
			"name":"My group",
			...
		},
		"contact-data":[
			{
				"id":"61012953",
				"entity-type":"phone",
				"entity-value":"3476787XXX",
				// possible values: work, mobile, fax, pager, home, skype or
				// other
				"kind":"work"
			},
			{
				"id":"98033086",
				"entity-type":"e-mail",
				"entity-value":"mail@testmail.com",
				// possible values: work, personal or other
				"kind":"work"
			},
			{
				"id":"92559134",
				"entity-type":"im",
				"entity-value":"testIM",
				// possible values: aim, msn, icq, jabber, yahoo, skype, qq,
				// sametime, gadu-gadu, google-talk or other
				"kind":"other",
				// possible values: work, personal or other
				"detail":"work"
			},
			{
				"id":"93512962",
				"entity-type":"website",
				"entity-value":"website.com",
				// possible values: work, personal or other
				"kind":"work"
			},
			{
				"id":"83909335",
				"entity-type":"twitter",
				"entity-value":"testtweet",
				// possible values: work, personal or other
				"kind":"work"
			}
		],
		"important-dates":[
			{
				"id":"77238337",
				// possible values: birthday, anniversary, first-met, hired,
				// fired or custom
				"type":"birthday",
				// 0 = the event occurs only once,
				// 1 = the event occurs every year
				"is-every-year":"1",
				"date":"2012-06-06",
				// this field is visible only if you choose the value custom
				// in the type field
				"custom-type":"You custom date"
			}
		],
		"addresses":[
			{
				"id":"95236531",
				"address":"101 Santa Monica Boulevard",
				"city":""Santa Monica",
				"state":"California",
				"country":"United States",
				"zip-code":"90401",
				// possible values: work, home, billing or other
				"kind":"other"
			}
		],
		// visible only for companies
		"people-in-this-company:["39022587","75363686"],
		"attachment":["88614208"],
		// visible only for persons
		"company":{
			"id":"4346421",
			"type":"company",
			...
		}
	}
}

Deal

{
	"deal":{
		"id":"72933251",
		"type":"deal",
		// UTC timestamp
		"created-at":"2012-05-24 15:30:34",
		"updated-at":"2012-05-24 15:30:34",
		"created-by":"62411061",
		"updated-by":"62411061",
		"name":"A deal",
		"description":"A deal description",
		"currency":"USD",
		"price":"650.00",
		// possible values: fixed-bid, per-hour, per-month or per-year
		"price-type":"fixed-bid",
		"duration":"0",
		// possible values: pending, won and lost
		"deal-status":"pending",
		// possible values are: public, only-me, group or selected-people
		"visibility":"selected-people",
		// only if you chose the "selected-people" value for the field "visibility"
		"allowed-users":["92812494","31451574"],
		"involved-people":["80098790"],
		"deal-with":"63006132",
		"deal-responsible-id":"78205553",
		// only if you chose the "group" value for the field "visibility"
		"workgroup":{
			"id":"9087057",
			"name":"My group",
			...
		},
		"category":{
			"id":"81039490",
			"name":"A category",
			"color":"#FFFFF0"
		}
	}
}

Deal category

{
	"category":{
		"id":"85388124",
		"name":"A category",
		"color":"#FFFFF0"
	}
}

Event

{
	"event":{
		"id": "8143",
	    "title": "Vacation",
	    "location": "Hawaii",
	    "start-date": "2016-07-03 00:00:00",
	    "end-date": "2016-07-20 00:00:00",
	    // 0 = the event does not last all day, 1 = the event lasts all day
	    "all-day": "1",
	    "notes": "Note",
	    "created-at": "2016-05-23 14:22:20",
	    "updated-at": "2016-05-25 00:39:47",
	    // Possible values: public, for me, people in my company, members of a project
	    "privacy": "people in my company",
	    // Used only when privacy is "for me". 0 = other people cannot see thi event at all, 1 = other people can see that I'm busy
	    "show-as-busy": "0",
	    // Used only when privacy is "people in my company" or "members of a project". 1 = Whoever can see this event can edit it
	    "viewers-can-edit": "0",
	    // Not used when privacy is "for me". 1 = Whoever is invited at this event can edit it
	    "attendees-can-edit": "1",
	    "is-meeting": "1",
	    "created-by": "256346363",
	    "updated-by": "256346363",
	    // Used only if privacy is "members of a project"
	    "project": [],
	    "contact": [],
	    "category": {
	      "id": "1",
	      "name": "A category",
	      "created-by": "256346363"
	    },
	    "calendar": {
	      "id": "1563577",
	      "name": "A calendar",
	      "color": "#d2691e",
	      "created-by": "256346363"
	    },
	    "recurrence": {
	      "id": "12",
	      // Possible values: daily, weekly, monthly, yearly
	      "rec-type": "weekly",
	      "rec-start": "2016-07-03",
	      "rec-end": "",
	      "rec-interval": "2",
	      "rec-days-of-week": "monday,friday,saturday",
	      // It's the day number in the month
	      "rec-day": "",
	      // Possible values: first, second, third, fourth, last
	      "rec-ordinal": "",
	      // Possible values: monday, tuesday, wednesday, thursday, friday, saturday, sunday
	      "rec-day-of-week": "",
	      "rec-timezone": "UTC"
	    }
	  },
	  "attendees": [
	    {
	      "user-id": "56345346",
	      "user-name": "John Smith",
	      "answer": "no answer"
	    }
	  ]
	}
}

Event (legacy)

{
	"event":{
		"id":"50502902",
		"subject":"An event",
		"location":"Somewhere",
		"start":"2012-05-11 12:30:00",
		"end":"2012-05-11 15:30:00",
		// 0 = the event does not last all day, 1 = the event lasts all day
		"allday-flag":"0",
		"calendar-id":"1",
		// Possible values: public or private
		"privacy-type":"public",
		"updated-by":"89251402",
		// Possible values: yes or no
		"recur":"yes",
		// Possible values: daily, weekly, monthly, yearly
		"recur-type":"weekly",
		"recur-start":"2012-05-11",
		"recur-end":"",
		"recur-interval":"2",
		"recur-days-of-week":"monday,friday,saturday",
		// It's the day number in the month
		"recur-day":"",
		// Possible values: first, second, third, fourth, last
		"recur-ordinal":"",
		// Possible values: monday, tuesday, wednesday, thursday, friday, saturday, sunday
		"recur-day-of-week":"",
		"created-by":"89251402"
	}
}

Event category

{
	"category":{
		"id":"30563313",
		"creator-id":"25859382",
		"name":"A category"
	}
}

File

{
	"file": {
		"id":"427306",
		// Size in bytes
		"byte-size":"18473",
		"name":"landscape",
		"description":"",
		"extension":"jpg",
		"uploaded-by":"2",
		"created-at":"2012-05-07 10:27:15",
		"owner-id":"252790",
		// Possible values are: user, project, contact, comment, message or note
		"owner-type":"project",
		// 0 = doesn't have a thumbnail, 1 = has a thumbnail
		"has-thumbnail":"1",
		"download-url":"/download/427306",
		"project-id":"252790",
		"category-id":null,
		// for attachments with multiple versions, file-group-id specifies the id of
		// the collection (all the different versions of a file have the same
		// file-group-id)
		"file-group-id":"369374",
		"version":"0",
		// 1 = is private, 0 = is not private
		"is-private":"0"
	}
}

Link

{
	"link":{
		"id":"456955",
		"project-id":"252790",
		"title":"This is a new link",
		"description":"Integrated project and contact management done right",
		"code":"http://www.apollohq.com/",
		"created-at":"2012-01-26 16:10:23",
		// 0 = is not private, 1 = is private
		"is-private":"1",
		"subscribers":["94684338","89243734","60314878","34812170"],
		"author":{
			"id":"62544178",
			"name":"Charlie Price",
			...
		},
		"category":{
			"id":"73682223",
			"name":"Articles",
			...
		}
	}
}

Message

{
	"message":{
		"id":"456955",
		"project-id":"252790",
		"title":"This is a new message",
		"body":"<b>Important:</b><br /><br /><i>read this message</i>",
		"created-at":"2012-01-26 16:10:23",
		// 0 = is not private, 1 = is private
		"is-private":"1",
		// 0 = is not pinned, 1 = is pinned
		"pinned":"0",
		"commented-on":"2012-05-07 15:15:26",
		"subscribers":["94684338","89243734","60314878","34812170"],
		"attachments":[
			{
				"id":"31399822",
				"byte-size":"18473",
				...
			},
			...
		],
		"author":{
			"id":"62544178",
			"name":"Charlie Price",
			...
		},
		"category":{
			"id":"73682223",
			"name":"Assets",
			...
		},
		"milestone":{
			"id":"88281001",
			"project-id":"252790",
			"title":"A milestone",
			...
		}
	}
}

Milestone

{
	"milestone":{
		"id":"330053",
		"project-id":"252790",
		"title":"A milestone",
		"deadline":"2012-12-07",
		"start-date":"2012-11-16",
		// “null” if the milestone is still not completed
		"completed-at":null,
		"created-at":"2011-11-27 16:23:17",
		"last-modified-at":"2012-05-07 17:39:57",
		"created-by":"49443547",
		"last-modified-by":"49443547",
		"subscribers":["79030687","49443547","68614759","80432967"],
		"responsible":{
			"id":"49443547",
			"name":"Christopher Everette",
			...
		}
	}
}

Note

{
	"note":{
		"id":"84678316",
		"body":"A note",
		// UTC timestamp
		"date":"2012-05-24 15:30:34",
		"created-by":"59586526",
		// possible values are: public, only-me, group or selected-people
		"visibility":"selected-people",
		// only if you chose the "selected-people" value for the field "visibility"
		"allowed-users":["59586526","96830692"],
		"attachments":["20705958"],
		// only if the note is attached to a contact
		"contact":{
			"id":"34992114",
			"type":"person",
			...
		},
		// only if the note is attached to a case
		"case":{
			"id":"96883924",
			"type":"case",
			...
		},
		// only if the note is attached to e deal
		"deal":{
			"id":"57396692",
			"type":"deal",
			...
		},
		// only if you chose the "group" value for the field "visibility"
		"workgroup":{
			"id":"7503744",
			"name":"My group",
			...
		}
	}
}

Project

{
	"project":{
		"id":"252790",
		"name":"This is a project",
		"description":"This is the description of a project",
		"created-at":"2011-07-14 13:53:13",
		// Possible status are: active, silent, archived and template
		"status":"active",
		"overview-page-announcement":"",
		// Possible values are: activity, messages, task-lists, milestones,
		// files, time, people-and-permissions, project-settings and writeboards
		"start-page":"activity",
		// 1 = don't send email notifications for this project,
		// 0 = send notifications as usual
		"no-email-notifications":"0",
		// 1 = display project overview page announcement,
		// 0 = don't display it
		"display-announcement":"0",
		// 1 = allow html, 0 = don't allow it
		"allow-html-in-announcement":"1",
		// 1 = new items in this project will be created private by default,
		// 0 = new items will be created not private by default
		"default-to-private":"0",
		// If this project is for a certain person or company
		"contact":[],
		"category":[],
		// If you want to create a project from a template
		"template-id":"643747",
		"due-date":"2012-12-07"
	}
}

Task

{
	"task":{
		"id":"1446425",
		"subject":"This is a task",
		"notes":"Notes on task",
		"due-date":"2011-12-04",
		"start-date":"2011-11-24",
		"date-started":"",
		"end-date":"",
		// Possible values are: not started, started, done
		"state":"not started",
		"project-id":"252790",
		"position":"2",
		"priority":"low",
		// Number of seconds (integer)
		"estimated-time":"600",
		"subscribers":["7503744","68614759"],
		"responsibles":[
			"68614759",
			"7503744",
			...
		],
		"created_by":"20705958",
		"task-list":{
			"id":"34992114",
			"project-id":"252790",
			...
		},
		"attachments":[
			{
				"id":"31399822",
				"byte-size":"18473",
				...
			},
			...
		]
	}
}

Task list

{
	"task-list":{
		"id":"96883924",
		"name":"This is a task list",
		"description":"",
		"position":"2147483647",
		// 0 = is not private, 1 = is private
		"is-private":"0",
		"created-at":"2011-09-27 15:53:28",
		"updated-at":"2012-05-04 15:27:05",
		"created-by":"57396692",
		"updated-by":"57396692",
		// 1 = is hidden, 0 = is not hidden
		"hidden":"0",
		"completed-tasks":"2",
		"started-tasks":"1",
		"not-started-tasks":"11",
		"milestone":[],
		"project-id":"573966922333"
	}
}

Time entry

{
	"time-entry":{
		"id":"13124967",
		"category-id":"53336970",
		"user-id":"45831863",
		"task-id":"5214406",
		"task-list-id":null,
		"notes":"Some notes",
		"date":"2011-08-09",
		"contact-id":null,
		"project-id":"252790",
		// possible values are: unset, not billable, billable, billed
		"billable":"unset",
		"created-by":"7546977",
		"time":[
			{
				"seconds":"3600"
			}
		]
	}
}

User

{
	"user":{
		"id":"18761453",
		"name":"Darrell M. Stearn",
		"company-id":"36107075",
		"status-message-updated-at":"2010-07-27 14:15:12",
		"status-message":"",
		"email":"dstearn@gmail.com",
		// The language is coded in two lowercase characters, according to the ISO 639-1
		// standard (for instance, en for English). The country is coded in two
		// uppercase characters, according to the ISO 3166-1 standard (for instance,
		// GB for Great Britain).
		"culture":"en_US",
		"created-at":"2010-03-16 01:15:34",
		// 0 = is not admin, 1 = is admin
		"is-admin":"1",
		// 0 = internal user, 1 = external user
		"type":"1",
		// 0 = is not crm enabled, 1 = is crm enabled
		"is-crm-enabled":"1",
		// 1 = the user i automatically included when a new project is created,
		// 0 = the user is not included
		"auto-access-to-future-projects":"1",
		// 0 = is not account owner, 1 = is account owner
		"is-account-owner":"1",
		// 1 = user wants to be notified when a task is due,
		// 0 = user doesn't want to be notified
		"notify-before-a-task-is-due":"1",
		// 1 = user wants to be notified when a task is assigned to him,
		// 0 = user doesn't want to be notified
		"notify-when-a-task-is-assigned":"1",
		// 1 = user receive a daily email with all his upcoming tasks,
		// 0 = user doesn't receive the email
		"receive-upcoming-tasks":"1",
		// 1 = the email is sent only on workdays,
		// 0 = the email is sent everyday
		"upcoming-tasks-only-on-workdays":"0",
		// 1 = no notifications will be sent for comments already read,
		// 0 = notifications sent anyway
		"prevent-notifications-form-comments-read":"0",
		// 1 = user will be subscribed automatically to any new message,
		// 0 = user will not be subscribed automatically
		"autosubscribe-to-new-messages":"1",
		"dropbox":"XXXXXXXXXXXXXXXXXXXX58O0D2",
		// 1 = user don't receive notifications for his own comments,
		// 0 = user receive notifications anyway
		"dont-notify-own-comments":"0",
		// 1 = invert comments order,
		// 0 = don't invert comments order
		"invert-comments-order":"0",
		// 1 = user receive a daily digest of his activities,
		// 0 = user doesn't receive any digest
		"receive-daily-digest":"1",
		"ical-feed-token":"9xxxxxxxxxxxx3j7wotxc4fdfslzfiosg7ufk",
		// 1 = every user allowed to see the project will be notified when a
		// new message is posted, 0 = only subscribed users will be notified
		"notify-everyone-on-new-messages":"0",
		// 1 = when generating i-cal feed tasks will be exported as events (for
		// compatibility with some clients), 0 = tasks will not be exported as
		// events
		"export-tasks-as-events":"1",
		// when the user creates a new project tasks it will be assigned by
		// default to: 0 (anyone), 1 (the user himself), 2 (the user's company)
		"assign-tasks-to":"0",
		"do-not-add-to-tasks-notification-list":"0",
		// 1 = always use https, 0 = don't always use https
		"always-use-https":"1",
		// 1 = when opening Apollo overview the user see contacts' feed as the
		// default page, 0 = projects' feed as default page
		"overview-defaults-to-contacts-view":"0",
		// 1 = when opening Apollo contacts' section the user see the contacts' list
		// as the default page, 0 = activities' feed as default page
		"default-to-contacts-list-in-contacts-section":"0",
		// 1 = user can export contacts,
		// 0 = user cannot export contacts
		"can-export-contacts":"1",
		// By default new contacts created by this user are visible to:
		// 0 (anyone), 1 (only the user)
		"default-contacts-visibility":"0",
		// 1 = notes in contacts' pages will not be truncated,
		// 0 = notes in contacts' pages will be truncated as usual
		"view-full-notes-in-contact-page":"0",
		// New deals, created by this user, will have this currency
		// by default
		"default-deals-currency":"EUR"
	}
}

Writeboard

{
	"writeboard":{
		"id": "2258",
		"project-id": "371728",
		"title": "Title",
		"created-at": "2013-04-03 10:19:02",
		"created-by": "2",
		"updated-at": "2013-04-03 10:19:02",
		"updated-by": "2",
		"is-private": "0",
		"subscribers": [
			"2",
			"7447"
		],
		"revisions": [
			{
				"id": "4972",
				"project-id": "371728",
				"writeboard-id": "2258",
				"plain-text": "This is a paragraph",
				"created-at": "2013-04-03 10:19:02",
				"created-by": "2",
				"updated-at": "2013-04-03 10:19:02",
				"updated-by": "2",
				"revision-number": "6",
				"html-text": "<p>This is paragraph</p>"
			},
			...
		]
	}
}