User Management

Returns all invitations in current user.

    /invitations
  • 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

    id
    string  (required) in path

    User UUID

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Provides the custom metadata stored for this user in json format

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

    /users
  • 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

Retrieve a user

GET
/users/{id}

Returns a single user if the user has access

    /users/{id}
  • 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

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

Updates the currently logged-in user.

    /user
  • Parameters
  • user
     (required) in body

    User to update

    {
    	"first_name": "string",
    	"last_name": "string",
    	"phone_number": "string",
    	"timezone": "string",
    	"password": "string",
    	"avatar": "string",
    	"customdata": "string"
    }