> This page is for API Reference & Tools.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.moveworks.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.moveworks.com/_mcp/server.

# Custom Attributes (Entities)

> Read and update Custom Attributes (Entities) through the Moveworks Configuration API: endpoints, fields and examples.

`platform.entities`

Custom user attributes.

* **Endpoint:** `/platform/entities`  |  **Methods:** GET, PATCH
* **Request shape:** one per organization, so there is no `id`. It already exists: read it with `GET`, then `PATCH` the fields you want to change. Fields go at the top level of the JSON body, with no `resource` wrapper.
* **Updates:** a JSON merge-patch. Send only the fields you change, plus `version: {num, change_description}` with the `num` from your last read. Lists and maps you send replace the stored ones whole.

### Endpoints

All paths are relative to `https://api.moveworks.ai/configurations/v1alpha1`. Each endpoint page lists the request and response schema, an example, and the errors it can return.

| Method  | Path                 | Endpoint reference                                                                                                                            |
| ------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `GET`   | `/platform/entities` | [Get custom attribute entities](/api-reference/configuration-api/platform-org/custom-attributes-entities/get-custom-attribute-entities)       |
| `PATCH` | `/platform/entities` | [Update custom attribute entities](/api-reference/configuration-api/platform-org/custom-attributes-entities/update-custom-attribute-entities) |

### Fields

| Field           | Type                          | Required  | Notes                                                               |
| --------------- | ----------------------------- | --------- | ------------------------------------------------------------------- |
| `registrations` | array\<DataModelRegistration> |           | Custom attributes registered for each data model.                   |
| `updated_time`  | string                        | read-only | When the configuration was last updated.                            |
| `updated_by`    | string                        | read-only | Who last updated the configuration.                                 |
| `version`       | Version                       |           | Document version. On update, send back the num from your last read. |

### Document fields (example)

The document as `GET` returns it. To change any of these, send only the fields you want to change in the `PATCH` body.

```json
{
  "registrations": [
    {
      "data_model": "USER",
      "attributes": [
        {
          "name": "example-name",
          "data_sensitivity": {
            "customer_data": "CUSTOMER_DATA_UTTERANCE"
          },
          "item_ref": "<string>"
        }
      ],
      "item_ref": "<string>"
    }
  ]
}
```