Apollo API Documentation

People API calls


Current person

GET /me

Returns the currently logged in person (you).

Response

{
	"user":{
		"id":"5763983",
		"name":"John Smith",
		...
	}
}

Get people (across projects)

GET /people

Returns all people visible to (and including) the requesting user.

Response

{
	"users":[
		{
			"id":"57583647",
			"name":"John Smith",
			...
		},
		{
			"id":"20847684",
			"name":"Brenda G. Hill",
			...
		},
		...
	]
}

Get people (within project)

GET /projects/#{project_id}/people

Returns all people with access to the given project.

Response

{
	"users":[
		{
			"id":"31456313",
			"name":"Amy K. Weathers",
			...
		},
		{
			"id":"76721148",
			"name":"Vicky Diaz",
			...
		},
		...
	]
}

Get people (within company)

GET /companies/#{company_id}/people

Returns all people from the given company that are visible to the requesting user.

Response

{
	"users":[
		{
			"id":"31456313",
			"name":"Amy K. Weathers",
			...
		},
		{
			"id":"76721148",
			"name":"Vicky Diaz",
			...
		},
		...
	]
}

Get person

GET /people/#{person_id}

Returns a single person identified by their integer ID.

Response

{
	"user": {
		"id":"31456313",
		"name":"Amy K. Weathers",
		...
	}
}