---
title: "Read Attributes"
method: GET
path: "/v1/attributes"
tags: ["Attributes"]
---

# Read Attributes

`GET /v1/attributes`

## Request

- Base URL: `` (relative, and it does not resolve against the document’s source URL)
- URL: `/v1/attributes`
- Auth: one of:
  - API key in header `sessionKey`
  - API key in header `clientCode`
  - API key in header `jwt`
- TypeScript: <https://skmtc.dev/erply/apis/crm-api/docs/v1/attributes/get.ts> (a function with typed inputs; its response is checked against the schema)

API client specifies record Id or multiple Ids and fetches attributes for all those records.
Filtering & Sorting by Value is not supported.

## Query parameters

- `match` string
- `recordIds` integer[]
- `entityName` string, required
- `name` string
- `orderBy` string
- `orderByDirection` 'ASC' | 'DESC'
- `skip` integer
- `take` integer

## Response `200`

OK

- CustomersApiInternalModelsAttributeResponse[]
  - `entity` string: Entity name of the record
  - `id` integer: ID of the attribute
  - `name` string
  - `record_id` integer: ID of the database record
  - `type` string: 3 types are available - int, double, text
  - `value` unknown

## Other responses

- `400`: Bad Request
- `500`: Internal Server Error

---

[API](https://skmtc.dev/erply/apis/crm-api.md) - [All operations](https://skmtc.dev/erply/apis/crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/erply/apis/crm-api/revisions/36dd4cc370b2?raw)