Groups

List groups

get

Authorizations

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, lastModified, -lastModified. Defaults to name.

Default: namePossible values:

limitinteger · min: 1 · max: 256Optional

Maximum number of groups to return (1-256). Defaults to 32.

Default: 32

skipinteger · max: 65536Optional

Number of groups to skip (pagination) (0-65536). Defaults to 0.

Default: 0

filter[id]string[]Optional

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

Example: ["3abc234abc234abc2"]

filter[search]string · max: 256Optional

General search string (max 256 chars). Searches group name (case-insensitive).

Example: Marketing

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/groups

GET /api/rest/v1/groups 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": "groups",
      "id": "text",
      "attributes": {
        "name": "text",
        "description": "text",
        "icon": "text",
        "clientId": "text",
        "createdAt": 1,
        "lastModified": 1,
        "lastModifiedBy": "text",
        "userIds": [
          "text"
        ]
      },
      "links": {
        "self": "https://example.com",
        "thumbnail": {
          "href": "https://example.com",
          "meta": {
            "version": "text",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        },
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

Get group

get

Authorizations

X-Api-KeystringRequired

HIVO API Key

X-User-IdstringRequired

HIVO User ID

Path parameters

groupIdstringRequired

Group ID

Example: 3abc234abc234abc2

Responses

200

OK

application/json

metaobjectOptional

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/groups/{groupId}

GET /api/rest/v1/groups/{groupId} 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",
    "thumbnail": {
      "href": "https://example.com",
      "meta": {
        "version": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "data": {
    "type": "groups",
    "id": "text",
    "attributes": {
      "name": "text",
      "description": "text",
      "icon": "text",
      "clientId": "text",
      "createdAt": 1,
      "lastModified": 1,
      "lastModifiedBy": "text",
      "userIds": [
        "text"
      ]
    },
    "links": {
      "self": "https://example.com",
      "thumbnail": {
        "href": "https://example.com",
        "meta": {
          "version": "text",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
}