Skip to content

Latest commit

 

History

History
126 lines (110 loc) · 4.33 KB

people.md

File metadata and controls

126 lines (110 loc) · 4.33 KB
Raw

People

The major problems of our work are not so much technological as sociological in nature - T. DeMarco & T. Lister

Get people

  • GET /people.json will return all people on the account.
  • GET /people/trashed.json will return all people who have been deleted from the account. Only admins are able to access trashed people.
[
  {
    "id": 149087659,
    "identity_id": 982871737,
    "name": "Jason Fried",
    "email_address": "jason@basecamp.com",
    "admin": true,
    "trashed": false,
    "avatar_url": "https://asset0.37img.com/global/4113d0a133a32931be8934e70b2ea21efeff72c1/avatar.96.gif",
    "fullsize_avatar_url": "https://asset0.37img.com/global/4113d0a133a32931be8934e70b2ea21efeff72c1/original.gif?r=3",
    "created_at": "2012-03-22T16:56:48-05:00",
    "updated_at": "2012-03-22T16:56:48-05:00",
    "url": "https://basecamp.com/999999999/api/v1/people/149087659-jason-fried.json",
    "app_url": "https://basecamp.com/999999999/people/149087659-jason-fried"
  },
  {
    "id": 1071630348,
    "identity_id": 827377171,
    "name": "Jeremy Kemper",
    "email_address": "jeremy@basecamp.com",
    "admin": true,
    "trashed": false,
    "avatar_url": "https://asset0.37img.com/global/e68cafa694e8f22203eb36f13dccfefa9ac0acb2/avatar.96.gif",
    "fullsize_avatar_url": "https://asset0.37img.com/global/4113d0a133a32931be8934e70b2ea21efeff72c1/original.gif?r=3",
    "created_at": "2012-03-22T16:56:48-05:00",
    "updated_at": "2012-03-22T16:56:48-05:00",
    "url": "https://basecamp.com/999999999/api/v1/people/1071630348-jeremy-kemper.json",
    "app_url": "https://basecamp.com/999999999/people/1071630348-jeremy-kemper"
  }
]

Get person

  • GET /people/1.json will return the specified person.
  • GET /people/me.json will return the current person.
{
  "id": 149087659,
  "identity_id": 982871737,
  "name": "Jason Fried",
  "email_address": "jason@basecamp.com",
  "admin": true,
  "trashed": false,
  "avatar_url": "https://asset0.37img.com/global/4113d0a133a32931be8934e70b2ea21efeff72c1/avatar.96.gif?r=3",
  "fullsize_avatar_url": "https://asset0.37img.com/global/4113d0a133a32931be8934e70b2ea21efeff72c1/original.gif?r=3",
  "created_at": "2012-03-22T16:56:51-05:00",
  "updated_at": "2012-03-23T13:55:43-05:00",
  "events": {
    "count": 19,
    "updated_at": "2012-03-23T13:55:43-05:00",
    "url": "https://basecamp.com/999999999/api/v1/people/149087659-jason-fried/events.json",
    "app_url": "https://basecamp.com/999999999/people/149087659-jason-fried/events"
  },
  "assigned_todos": {
    "count": 80,
    "updated_at": "2013-06-26T16:22:05.000-04:00",
    "url": "https://basecamp.com/999999999/api/v1/people/149087659-jason-fried/assigned_todos.json",
    "app_url": "https://basecamp.com/999999999/people/149087659-jason-fried/assigned_todos"
  }
}

Get projects a person has access to

  • GET /people/1/projects.json will return a list of all projects a person has access to including draft, template, archived, and deleted projects. Projects that the requesting user does not have access to will not appear in the project list. If the requesting user does not have the ablity to view the person 404 Not Found will be returned.
[
  {
    "id": 605816632,
    "name": "BCX",
    "description": "The Next Generation",
    "updated_at": "2012-03-23T13:55:43-05:00",
    "url": "https://basecamp.com/999999999/api/v1/projects/605816632.json",
    "template": false,
    "archived": false,
    "starred": true,
    "trashed": false,
    "draft":false,
    "is_client_project": false,
    "color": "3185c5"
  },
  {
    "id": 684146117,
    "name": "Nothing here!",
    "description": null,
    "updated_at": "2012-03-22T16:56:51-05:00",
    "url": "https://basecamp.com/999999999/api/v1/projects/684146117.json",
    "template": false,
    "archived": false,
    "starred": false,
    "trashed": false,
    "draft":false,
    "is_client_project": true,
    "color": "3185c5"
  }
]

Create person

New people can be invited directly to projects via the accesses API.

Delete person

  • DELETE /people/1.json will delete the person specified and return 204 No Content if that was successful. If the user does not have access to delete the person, you'll see 403 Forbidden.