---
title: "Get object custom attributes"
method: GET
path: "/v1/objects/{object-id}/custom-attributes"
tags: ["Objects"]
---

# Get object custom attributes

`GET /v1/objects/{object-id}/custom-attributes`

Retrieve the object's custom attributes as an array. Each element carries the
attribute name, value, flags and the source object. This is the same
representation that is embedded as the `customAttributes` array in the full
object document. Inherited attributes are included; the `sourceObject` field
identifies the object an inherited attribute originates from (0 when the
attribute is defined directly on this object).

## Path parameters

- `object-id` integer, required

## Response `200`

Array of custom attributes.

- CustomAttribute[]
  - `name` string — Attribute name.
  - `value` union — Attribute value. Plain text for regular attributes; a JSON object or array for structured attributes (`flags.json` is true).
    - string
    - object
  - `flags` object — Attribute flags as named booleans.
    - `inheritable` boolean — Attribute is inherited by child objects.
    - `redefined` boolean — Inherited attribute is redefined on this object.
    - `conflict` boolean — Attribute is inherited from multiple parents with differing values.
    - `json` boolean — Attribute holds a structured value (JSON object or array).
  - `sourceObject` integer — ID of the object an inherited attribute originates from; 0 if defined directly on this object.

## Other responses

- `401` — Unauthorized
- `403` — User does not have modify access to the object
- `404` — Object with given ID does not exist

## Changes

- **2026-09-15** `ef2ed4fdc376` — 1 breaking, 1 info
  - response property `items/value` list-of-types was widened by adding types `array and object` to media type `application/json` of response `200`
  - added the optional property `items/flags/json` to the response with the `200` status
- **2026-06-02** `051240cd3a79` — 1 breaking
  - the response's body type changed from `object` to `array` for status `200`
- **2026-05-29** `7d6c145c0be0` — 1 info
  - endpoint added
- **2026-05-08** `c6aaf3632e48` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/netxms/apis/netxms-api/changes/v1/objects/:object-id/custom-attributes/get.md)

---

[API](https://skmtc.dev/netxms/apis/netxms-api.md) · [All operations](https://skmtc.dev/netxms/apis/netxms-api/llms.txt) · [OpenAPI document](https://skmtc.dev/netxms/apis/netxms-api/revisions/8dab9171ee5d?raw)