Users

List the users

get

List the users

Authorizations
Responses
200
successful operation
application/json
get
GET //users HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "users": {
    "email": "[email protected]",
    "firstName": "text",
    "lastName": "text",
    "timezone": "text",
    "userType": "text",
    "access": {
      "startDate": "2025-07-02",
      "endDate": "2025-07-02",
      "preventDownload": "no",
      "restrictProjects": "no"
    }
  }
}

Creates a new user assigning them a server generated ID

post

Creates a new user assigning them a server generated ID

Authorizations
Body

Refer to the /schemas/user endpoint for the full JSON Schema definition

emailstring · emailRequired
firstNamestringRequired
lastNamestringRequired
timezonestringOptional
userTypestringOptional
Responses
200
successful operation
application/json
post
POST //users HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 205

{
  "email": "[email protected]",
  "firstName": "text",
  "lastName": "text",
  "timezone": "text",
  "userType": "text",
  "access": {
    "startDate": "2025-07-02",
    "endDate": "2025-07-02",
    "preventDownload": "no",
    "restrictProjects": "no"
  }
}
{
  "email": "[email protected]",
  "firstName": "text",
  "lastName": "text",
  "timezone": "text",
  "userType": "text",
  "access": {
    "startDate": "2025-07-02",
    "endDate": "2025-07-02",
    "preventDownload": "no",
    "restrictProjects": "no"
  }
}

Get the user

get

Get the user

Authorizations
Path parameters
userIdstringRequired

The ID of the user

Responses
200
successful operation
application/json
get
GET //users/{userId} HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "email": "[email protected]",
  "firstName": "text",
  "lastName": "text",
  "timezone": "text",
  "userType": "text",
  "access": {
    "startDate": "2025-07-02",
    "endDate": "2025-07-02",
    "preventDownload": "no",
    "restrictProjects": "no"
  }
}

Update the user

put

Update the user

Authorizations
Path parameters
userIdstringRequired

The ID of the user

Body

Refer to the /schemas/user endpoint for the full JSON Schema definition

emailstring · emailRequired
firstNamestringRequired
lastNamestringRequired
timezonestringOptional
userTypestringOptional
Responses
200
successful operation
application/json
Responseobject
put
PUT //users/{userId} HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 205

{
  "email": "[email protected]",
  "firstName": "text",
  "lastName": "text",
  "timezone": "text",
  "userType": "text",
  "access": {
    "startDate": "2025-07-02",
    "endDate": "2025-07-02",
    "preventDownload": "no",
    "restrictProjects": "no"
  }
}
{}

Delete the user

delete

Delete the user

Authorizations
Path parameters
userIdstringRequired

The ID of the user

Responses
200
successful operation
application/json
Responseobject
delete
DELETE //users/{userId} HTTP/1.1
Host: api.ecosuite.io
Authorization: YOUR_API_KEY
Accept: */*

{}
PreviousUser groupsNextAlerts