Back to top

Users

User Management

Retrieve all users
GET
/users

Returns a list of users that the are accessible to the current user (all users in the current user’s projects, essentially).

  • Parameters
  • include
    string in query

    related attributes to include

    page
    integer in query

    page to display, default to 1, max 100_000

    per_page
    integer in query

    items per page, default to 10, max 1_000

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"users": [
    		{
    			"id": "string",
    			"short_id": "string",
    			"first_name": "string",
    			"last_name": "string",
    			"full_name": "string",
    			"email": "string",
    			"two_factor_auth": "string",
    			"avatar_url": "string",
    			"max_projects": "integer",
    			"credit_amount": "number",
    			"created_at": "string",
    			"updated_at": "string",
    			"timezone": "string",
    			"fraud_score": "string",
    			"last_login_at": "string",
    			"emails": [
    				{
    					"href": "string"
    				}
    			],
    			"href": "string",
    			"phone_number": "string"
    		}
    	],
    	"meta": {
    		"first": {
    			"href": "string"
    		},
    		"previous": {
    			"href": "string"
    		},
    		"self": {
    			"href": "string"
    		},
    		"next": {
    			"href": "string"
    		},
    		"last": {
    			"href": "string"
    		},
    		"total": "integer"
    	}
    }
  • Response  401   unauthorized
Retrieve a user
GET
/users/{id}

Returns a single user if the user has access

  • Parameters
  • id
    string  (required) in path

    User UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"id": "string",
    	"short_id": "string",
    	"first_name": "string",
    	"last_name": "string",
    	"full_name": "string",
    	"email": "string",
    	"two_factor_auth": "string",
    	"avatar_url": "string",
    	"max_projects": "integer",
    	"credit_amount": "number",
    	"created_at": "string",
    	"updated_at": "string",
    	"timezone": "string",
    	"fraud_score": "string",
    	"last_login_at": "string",
    	"emails": [
    		{
    			"href": "string"
    		}
    	],
    	"href": "string",
    	"phone_number": "string"
    }
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Retrieve the current user
GET
/user

Returns the user object for the currently logged-in user.

  • Parameters
  • include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"id": "string",
    	"short_id": "string",
    	"first_name": "string",
    	"last_name": "string",
    	"full_name": "string",
    	"email": "string",
    	"two_factor_auth": "string",
    	"avatar_url": "string",
    	"max_projects": "integer",
    	"credit_amount": "number",
    	"created_at": "string",
    	"updated_at": "string",
    	"timezone": "string",
    	"fraud_score": "string",
    	"last_login_at": "string",
    	"emails": [
    		{
    			"href": "string"
    		}
    	],
    	"href": "string",
    	"phone_number": "string"
    }
  • Response  401   unauthorized
Update the current user
PUT
/user

Updates the currently logged-in user.

  • Parameters
  • user
     (required) in body

    User to update

    {
    	"first_name": "string",
    	"last_name": "string",
    	"phone_number": "string",
    	"timezone": "string",
    	"password": "string"
    }
  • Response  200   ok
  • {
    	"id": "string",
    	"short_id": "string",
    	"first_name": "string",
    	"last_name": "string",
    	"full_name": "string",
    	"email": "string",
    	"two_factor_auth": "string",
    	"avatar_url": "string",
    	"max_projects": "integer",
    	"credit_amount": "number",
    	"created_at": "string",
    	"updated_at": "string",
    	"timezone": "string",
    	"fraud_score": "string",
    	"last_login_at": "string",
    	"emails": [
    		{
    			"href": "string"
    		}
    	],
    	"href": "string",
    	"phone_number": "string"
    }
  • Response  401   unauthorized
  • Response  422   unprocessable entity