APapaleo
UnitAttribute

Get unit attribute list

Get unit attribute list<br>You must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.<br>For fine-grained clients, you must have this permission: 'core.unit_attributes.read'.

get/inventory/v1/unit-attributes

Request

  • Base URL
    https://api.apaleo.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.apaleo.com/inventory/v1/unit-attributes
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: unitattributes.read, setup.read, setup.manage, admin

Query parameters

pageNumberinteger

Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.

pageSizeinteger

Items per page. Default: 500. Maximum: 500.

Response

Returns unit attribute list for given account

countinteger required

Total count of items

Example response

{
  "unitAttributes": [
    {
      "id": "KQOSXHLS",
      "name": "Floor 1",
      "description": "Floor number"
    },
    {
      "id": "ADVFSSUL",
      "name": "Street view",
      "description": "View from the room"
    }
  ],
  "count": 2
}

Changes

No recorded changes to this operation across all 4 revisions of this API.