Users

Users are individuals who have access to Hilenium. You can only access users in your organization.

Property Type Description
id int Unique identifier
email string Email address
group_name string The group the user is in (determines system permissions).
active bool Identifies if the user is enabled (must explicitly set to true for the user to have access)
created datetime Date created
modified datetime Date last modified
profile.first_name string First name
profile.last_name string Last name
profile.initials string 2-3 characters that identifies the user in comments
profile.job_title string Job title

List Users

GET /users.json

Returns all users in the organization.

Query Parameters:
 
  • offset – Default is 0
  • limit – Default is 30

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

  [
    {
      "id": 1234,
      "email": "user1@yourorganisation.com",
      "group_name": "Administrator",
      "active": true,
      "profile": {
        "first_name": "User",
        "last_name": "One",
        "initials": "U1",
        "job_title": "Marketing Manager",
      }
    },
    {
      "id": 1235,
      "email": "user2@yourorganisation.com",
      "group_name": "Editor",
      "active": true,
      "profile": {
        "first_name": "User",
        "last_name": "Three",
        "initials": "U1",
        "job_title": "Marketing Assistant",
      }
    }
  ]

Create a User

POST /users.json

Creates a new user in the organisation.

Request JSON Object:
 
  • email (string) – Unique email address
  • group_name (string) – Name of the group the user is in
  • active (boolean) – Active (default is true)
  • profile.first_name (string) – First name
  • profile.last_name (string) – Last name
  • profile.initials (string) – Initials/short identifier (3 char max)
  • profile.job_title (string) – Job title

Example Response

HTTP/1.1 201 OK
Content-Type: application/json

    {
      "id": 1236,
      "email": "user2@yourorganisation.com",
      "group_name": "Editor",
      "active": true,
      "profile": {
        "first_name": "New",
        "last_name": "User",
        "initials": "NU",
        "job_title": "New User",
      }
    }

Retrieve a User

GET /users/[id].json

Returns a single user by their id.

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

    {
      "id": 1234,
      "email": "user1@yourorganisation.com",
      "group_name": "Administrator",
      "active": true,
      "profile": {
        "first_name": "User",
        "last_name": "One",
        "initials": "U1",
        "job_title": "Marketing Manager",
      }
    }

Update a User

PATCH /users/[id].json

Updates a user. You only need include the properties you wish to update in the JSON object.

Example Response

HTTP/1.1 204 OK

Delete a User

You cannot currently delete users in Hilenium. Instead set their ‘active’ status to ‘false’.