People API - Version 1.0

People - /people/ - GET

Retrieve data about users. The following fields are returned from the API.

13 {27}
  id : 22
  username : Sarah.Gonzalez
  first_name : Sarah
  last_name : Gonzalez
  full_name : Gonzalez Sarah
  calendar : 1
  email : sarah.gonzalez@example.com
  calendar_name : Test
  startdate : 2015-01-01
  enddate : null
  language : en
  node : null
  supervisor : 9
  country : null
  is_active : true
  is_external : true
  is_stealth : false
  is_superuser : false
  is_staff : false
  dayload : 7.5
  cost_price : null
  hourly_rate : null
  default_role : 1
  external_id : null
  capacity : 100
  usergroups [2]
  currency : 1


Sample URL

https://< SUBDOMAIN >.agbucket.com/api/1.0/people/?active_people=true&passive_people=true


People - /people/x/ - GET

Retrieve data about single user, by id


Sample URL

https://< SUBDOMAIN >.agbucket.com/api/1.0/people/1/


People - /people/ - POST

API for adding new people.


Payload

Field name
Description
Is required
calendar
User’s calendar
False
capacity
User’s capacity 1-100
False
cost_price
User’s costprice
False
currency_id
User’s currency, id
True
email
User’s email
True
dayload
User’s dayload
True
startdate
User’s startdate
True
first_name
User’s first name
True
last_name
User’s last name
True
is_active
Is user active
False
language
User’s language, for example ‘fi’/’en’
True
last_name
User’s lastname
True


People - /people/x/ - PATCH

Update single person’s properties


Sample URL

https://< SUBDOMAIN >.agbucket.com/api/1.0/people/1/