Users

Users API

Get project users
GET  /portal/[PORTALID]/projects/[PROJECTID]/users/
Add Users to a Project
POST /portal/[PORTALID]/projects/[PROJECTID]/users/
Update Users in a Project
POST /portal/[PORTALID]/projects/[PROJECTID]/users/[USERID]/
Get remaining no. of users in a portal
GET  /portal/[PORTALID]/users/availcount/
Get portal users
GET  /portal/[PORTALID]/users/
Activate user
POST  /portal/[PORTALID]/users/activate/
Deactivate user
POST  /portal/[PORTALID]/users/activate/

 Get project users

GET  /portal/[PORTALID]/projects/[PROJECTID]/users/

Gets the details of all the users in a specific project.

Request Parameters

usertypeStringAvailability status of the user.
Allowed values:
  • Active
  • Inactive
  • All

By default, the active users will be listed.

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8
{
    "users": [{
        "id": "2060758",
        "name": "Patricia Boyle",
        "active": true,
        "email": "patriciab@zillum.com",
        "role": "admin"
    }, {
        "id": "2060761",
        "name": "Einhard Klein",
        "active": false,
        "email": "dieterk@zillum.com",
        "role": "manager"
    }, {
        "id": "2063348",
        "name": "Charles Stone",
        "active": true,
        "email": "charless@zillum.com",
        "role": "employee"
    }, {
        "id": "2063354",
        "name": "Nathan Brooks",
        "active": true,
        "email": "nbrooks@zillum.com",
        "role": "contractor"
    }]
}

 Add Users to a Project

POST  /portal/[PORTALID]/projects/[PROJECTID]/users/

Adds users to a specific project.

Request Parameters

emailStringEmail ID of users separated by a comma.
roleStringRole of the user (manager, employee, contractor).
rateFloatThe rate per hour set for a specific user in a project based on staff based billing. Example: 20.750

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8
{
    "users": [{
        "id": "2060758",
        "name": "Patricia Boyle",
        "email": "patriciab@zillum.com",
        "role": "employee",
        "rate": "20.750"

    }]
}

 Update Users in a Project

POST  /portal/[PORTALID]/projects/[PROJECTID]/users/[USERID]/

Updates the details of a specific user in a project.

Request Parameters

roleStringRole of the user (manager, employee, contractor).

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8
{
    "users": [{
        "id": "2060758",
        "name": "Patricia Boyle",
        "email": "patriciab@zillum.com",
        "role": "employee",
        "rate": "20.750"
    }]
}

 Get remaining no. of users in a portal

GET  /portal/[PORTALID]/users/availcount/

Fetches the remaining no. of users to be added in a specific portal.

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8
{
"available_user_count": "1"
}

 Get portal users

GET  /portal/[PORTALID]/users/

Gets the details of all users in a specific portal.

Request Parameters

usertypeStringAvailability status of the user.
Allowed values:
  • Active
  • Inactive
  • All

By default, the active users will be listed.

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8
{
{
	"users": [
		{
			"role": "admin",
			"name": "Patricia Boyle",
			"active": true,
			"id": "4652009",
			"email": "patriciab@zylker.com"
		},
		{
			"role": "manager",
			"name": "Einhard Klein",
			"active": false,
			"id": "4652419",
			"email": "dieterk@zylker.com”
		},
		{
			"role": "admin",
			"name": "John Marsh",
			"active": true,
			"id": "4878919",
			"email": "johnm@zylker.com"
		},
		{
			"role": "admin",
			"name": "Steve Banks",
			"active": true,
			"id": "5160704",
			"email": "steveb@zylker.com"
		},
		{
			"role": "manager",
			"name": "Victor Young",
			"active": false,
			"id": "5203674",
			"email": "victory@zylker.com"
		},
		{
			"role": "contractor",
			"name": "Lin Brenn",
			"active": true,
			"id": "5275428",
			"email": "linb@zylker.com"
		}
	]
}
}

 Activate user

POST  /portal/[PORTALID]/users/activate/

Activates a specific user in a specific portal.

Request Parameters

activateLongUser ID

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8
{
 "response": "User Activated Successfully"
}

 Deactivate user

POST  /portal/[PORTALID]/users/activate/

Deactivates a specific user from a specific portal.

Request Parameters

deactivateLongUser ID

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8
{
"response": "User Deactivated Successfully"
}

Share this post : FacebookTwitter

Still can't find what you're looking for?

Write to us: support@zohoprojects.com