Skip to content
This repository has been archived by the owner on Apr 19, 2023. It is now read-only.

Latest commit

 

History

History
133 lines (124 loc) · 5.04 KB

users.md

File metadata and controls

133 lines (124 loc) · 5.04 KB
Raw

🚨 🚨 🚨 Deprecated: please see Resource Guru API documentation instead

Users

Get Users

  • GET /v1/:account-id/users returns an Array of Users.

Response

[
  {
    "id": 1,
    "first_name": "Shaun",
    "last_name": "Prestor",
    "email": "[email protected]",
    "image": "https://resourceguru.s3.amazonaws.com/images/card_69cb-7f96ae8b2e17.png",
    "timezone": "Pacific Time (US & Canada)",
    "last_login_at": "2014-08-17T21:38:09.000Z",
    "last_logout_at": "2014-08-15T10:56:32.000Z",
    "last_activity_at": "2013-06-26T17:30:11.000Z",
    "activation_state": "active",
    "created_at": "2012-06-05T21:17:19.000Z",
    "updated_at": "2014-08-19T09:27:52.000Z",
    "color": "#ef247f",
    "permissions": "administrator",
    "booking_rights": "manage_all",
    "client_rights": "manage_all",
    "project_rights": "manage_all",
    "resource_rights": "manage_all",
    "report_rights": "view",
    "owner": "true"
  },
  {
    "id": 2,
    "first_name": "Neil",
    "last_name": "Jones",
    "email": "[email protected]",
    "image": "https://resourceguru.s3.amazonaws.com/images/card_69cb-7f96ae8b2e17.png",
    "timezone": "London",
    "last_login_at": "2014-08-17T21:38:09.000Z",
    "last_logout_at": "2014-08-15T10:56:32.000Z",
    "last_activity_at": "2013-06-26T17:30:11.000Z",
    "activation_state": "active",
    "created_at": "2012-06-05T21:17:19.000Z",
    "updated_at": "2014-08-19T09:27:52.000Z",
    "color": "#2654ea",
    "permissions": "basic_user",
    "booking_rights": "view",
    "client_rights": "view",
    "project_rights": "view",
    "resource_rights": "view",
    "report_rights": "view",
    "owner": "false"
  }
]
Key Type Description
id integer Unique identifier for a User.
first_name string First name of a User.
last_name string Last name of a User.
email string Email address of a User.
image string URL to User's image.
timezone string Timezone of a User.
last_login_at string Last login timestamp for a User.
last_logout_at string Last log out timestamp for a User.
last_activity_at string Last activity timestamp for a User.
activation_state string Activation state of a User.
created_at string Timestamp when a User was created.
updated_at string Timestamp when a User was updated.
color string Hex color code of a User.
permissions string Permission level of a User(Basic User, Manager, Administrator, Custom).
booking_rights string Permissions of a User with regards to Bookings.
client_rights string Permissions of a User with regards to Clients.
project_rights string Permissions of a User with regards to Projects.
resource_rights string Permissions of a User with regards to Resources.
report_rights string Permissions of a User with regards to Reports.
owner boolean Boolean representing whether a User is the account owner.

Get User

  • GET /v1/:account-id/users/:id returns the specified user. If the special value me is given for the id, it will return the user that authenticated the request.

Response

{
  "id": 1,
  "first_name": "Shaun",
  "last_name": "Prestor",
  "email": "[email protected]",
  "image": "/uploads/development/images/user/1/image/thumb_66343c29-2353-4965-a254-af28ccc53a83.png",
  "timezone": "Pacific Time (US & Canada)",
  "last_login_at": "2014-08-17T21:38:09.000Z",
  "last_logout_at": "2014-08-15T10:56:32.000Z",
  "last_activity_at": "2013-06-26T17:30:11.000Z",
  "activation_state": "active",
  "created_at": "2012-06-05T21:17:19.000Z",
  "updated_at": "2014-08-19T09:27:52.000Z",
  "color": "#ffcc00",
  "permissions": "administrator",
  "booking_rights": "manage_all",
  "client_rights": "manage_all",
  "project_rights": "manage_all",
  "resource_rights": "manage_all",
  "report_rights": "view",
  "owner": "true"
}
Key Type Description
id integer Unique identifier of the User
first_name string First name of the User.
last_name string Last name of the User.
email string Email address of the User.
image string URL to the User's image.
timezone string Timezone of a User.
last_login_at string Last login timestamp for a User.
last_logout_at string Last log out timestamp for a User.
last_activity_at string Last activity timestamp for a User.
activation_state string Activation state of a User.
created_at string Timestamp when a User was created.
updated_at string Timestamp when a User was updated.
color string Hex color code of the User.
permissions string Permission level of a User(Basic User, Manager, Administrator, Custom).
booking_rights string Permissions of a User with regards to Bookings.
client_rights string Permissions of a User with regards to Clients.
project_rights string Permissions of a User with regards to Projects.
resource_rights string Permissions of a User with regards to Resources.
report_rights string Permissions of a User with regards to Reports.
owner boolean Boolean representing whether a User is the account owner.