ERerply
Attributes

Read Attributes

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

get/v1/attributes

Request

  • Base URL
    (relative, and it does not resolve against the document’s source URL)
  • Auth
    • API key in header sessionKey
    • or API key in header clientCode
    • or API key in header jwt
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

matchstring

match type of the filtering. Supported values: =, >=, <=, contains, startswith. Default is =

recordIdsinteger[]

records are the objects that have the attributes. The parameter can contain up to 100 semicolon delimited ids.

entityNamestring required

attribute entity name, The possible entities are: customer, customer group

namestring

attribute name

orderBystring

field to order by

orderByDirection'ASC' | 'DESC'

direction to order by

skipinteger

skip n records

takeinteger

amount to take

Response

OK

entitystring

Entity name of the record

idinteger

ID of the attribute

namestring
record_idinteger

ID of the database record

typestring

3 types are available - int, double, text

valueunknown

Example response

[
  {
    "entity": "customer",
    "id": 33,
    "name": "is_good",
    "record_id": 7,
    "type": "text"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.