Users

Get current user

get

Authorizations

XApiKey & XUserId

X-Api-KeystringRequired

HIVO API Key

X-User-IdstringRequired

HIVO User ID

Responses

200

OK

application/json

401

Unauthorized

application/json

429

Too Many Requests

application/json

get/v1/users/me

HTTPcURLJavaScriptPython

GET /api/rest/v1/users/me HTTP/1.1
Host: app.hivo.com.au
X-Api-Key: YOUR_API_KEY
X-User-Id: YOUR_API_KEY
Accept: */*

{
  "meta": {
    "timestamp": 1,
    "authentication": "text",
    "links": {
      "me": "https://example.com"
    }
  },
  "links": {
    "self": "https://example.com",
    "thumbnail": {
      "href": "https://example.com",
      "meta": {
        "version": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "data": {
    "type": "users",
    "id": "text",
    "attributes": {
      "name": "text",
      "email": "text",
      "profilePicture": "text",
      "jobTitle": "text",
      "company": "text",
      "clientId": "text"
    },
    "links": {
      "self": "https://example.com",
      "thumbnail": {
        "href": "https://example.com",
        "meta": {
          "version": "text",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
}

List users

get

Authorizations

XApiKey & XUserId

X-Api-KeystringRequired

HIVO API Key

X-User-IdstringRequired

HIVO User ID

Query parameters

sortstring · enumOptional

Sort key. Allowed values are name, -name, createdAt, -createdAt. Defaults to name.

Default: namePossible values:

limitinteger · min: 1 · max: 256Optional

Maximum number of users to return (1–256). Defaults to 32.

Default: 32

skipinteger · max: 65536Optional

Number of users to skip (pagination) (0–65536). Defaults to 0.

Default: 0

filter[id]string[]Optional

User ID filter. May be repeated and/or provided as a comma‑separated list. Max 512 IDs.

Example: ["2abc234abc234abc2"]

filter[search]string · max: 256Optional

General search string (max 256 chars). Searches user name and email (case‑insensitive).

Example: Jane

filter[clientId]stringOptional

Admin‑only. Client ID to filter within (ObjectId).

Example: 7abc234abc234abc2

Responses

200

OK

application/json

metaobjectRequired

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

get/v1/users

HTTPcURLJavaScriptPython

GET /api/rest/v1/users HTTP/1.1
Host: app.hivo.com.au
X-Api-Key: YOUR_API_KEY
X-User-Id: YOUR_API_KEY
Accept: */*

{
  "meta": {},
  "links": {
    "self": "https://example.com",
    "first": "https://example.com",
    "prev": "https://example.com",
    "next": "https://example.com"
  },
  "data": [
    {
      "type": "users",
      "id": "text",
      "attributes": {
        "name": "text",
        "email": "text",
        "profilePicture": "text",
        "jobTitle": "text",
        "company": "text",
        "clientId": "text"
      },
      "links": {
        "self": "https://example.com",
        "thumbnail": {
          "href": "https://example.com",
          "meta": {
            "version": "text",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        },
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

Get user

get

Authorizations

XApiKey & XUserId

X-Api-KeystringRequired

HIVO API Key

X-User-IdstringRequired

HIVO User ID

Path parameters

userIdstringRequired

User ID

Example: 2abc234abc234abc2

Query parameters

filter[clientId]stringOptional

Admin‑only. Client ID to filter within (ObjectId).

Example: 7abc234abc234abc2

Responses

200

OK

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

get/v1/users/{userId}

HTTPcURLJavaScriptPython

GET /api/rest/v1/users/{userId} HTTP/1.1
Host: app.hivo.com.au
X-Api-Key: YOUR_API_KEY
X-User-Id: YOUR_API_KEY
Accept: */*

{
  "meta": {
    "timestamp": 1,
    "authentication": "text",
    "links": {
      "me": "https://example.com"
    }
  },
  "links": {
    "self": "https://example.com",
    "thumbnail": {
      "href": "https://example.com",
      "meta": {
        "version": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "data": {
    "type": "users",
    "id": "text",
    "attributes": {
      "name": "text",
      "email": "text",
      "profilePicture": "text",
      "jobTitle": "text",
      "company": "text",
      "clientId": "text"
    },
    "links": {
      "self": "https://example.com",
      "thumbnail": {
        "href": "https://example.com",
        "meta": {
          "version": "text",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
}