---
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` string — Attribute value.
  - `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.
  - `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

---

[API](https://skmtc.net/netxms/apis/netxms-api.md) · [All operations](https://skmtc.net/netxms/apis/netxms-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/netxms/netxms-api/versions/ee1f54ee3abd/schema)