List Attributes

GET 
/v2/attributes/:resourceType/:lookupKey/:lookupValue/attributes

List Attributes by resource by lookupKey and lookupValue

Request

Path Parameters

resourceType stringrequired
Possible values: [products, clusters, categories, customers, contacts, companies]
The resourceType to list the attributes for
Example: products
lookupKey stringrequired
Possible values: [id, sourceId]
The lookupKey to find the resource by, i.e. id or sourceId
Example: id
lookupValue stringrequired
The lookupValue to find the resource by, i.e. the id or sourceId
Example: 1234

Query Parameters

source integer
The source of the lookupValue when the lookupKey is a sourceId
Example: 1234

Responses

200

A list of Attributes

application/json

Schema

Schema

• Array [

oneOf

ProductAttribute

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

The ID for this attribute

createdAt date-time

Default value: CURRENT_TIMESTAMP

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

createdBy integer

The ID of the user that created the attribute

lastModifiedBy integer

The ID of the user that last modified the attribute

attributeDescriptionId uuidrequired

Possible values: >= 36 characters and <= 36 characters

The AttributeDescription ID for this attribute

value

object

required

The value for this attribute

oneOf

AttributeTextValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

textValues

object[]

required

Attribute textValues per language

Array [

language stringrequired

Possible values: >= 2 characters and <= 2 characters

Language is set as 2 character country code.

values array[]

List of localized string values

]

AttributeEnumValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

enumValues string[]required

Attribute enum values

AttributeIntValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

intValue integerrequired

Attribute integer value

AttributeDecimalValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

decimalValue floatrequired

Attribute decimal value

AttributeColorValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

colorValue stringnullablerequired

Attribute color value, stored as a hex string

AttributeDateTimeValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

dateTimeValue date-timenullablerequired

Attribute decimal value

productId integerrequired

The ID of the product this attribute belongs to

ClusterAttribute

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

The ID for this attribute

createdAt date-time

Default value: CURRENT_TIMESTAMP

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

createdBy integer

The ID of the user that created the attribute

lastModifiedBy integer

The ID of the user that last modified the attribute

attributeDescriptionId uuidrequired

Possible values: >= 36 characters and <= 36 characters

The AttributeDescription ID for this attribute

value

object

required

The value for this attribute

oneOf

AttributeTextValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

textValues

object[]

required

Attribute textValues per language

Array [

language stringrequired

Possible values: >= 2 characters and <= 2 characters

Language is set as 2 character country code.

values array[]

List of localized string values

]

AttributeEnumValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

enumValues string[]required

Attribute enum values

AttributeIntValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

intValue integerrequired

Attribute integer value

AttributeDecimalValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

decimalValue floatrequired

Attribute decimal value

AttributeColorValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

colorValue stringnullablerequired

Attribute color value, stored as a hex string

AttributeDateTimeValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

dateTimeValue date-timenullablerequired

Attribute decimal value

clusterId integerrequired

The ID of the cluster this attribute belongs to

CategoryAttribute

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

The ID for this attribute

createdAt date-time

Default value: CURRENT_TIMESTAMP

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

createdBy integer

The ID of the user that created the attribute

lastModifiedBy integer

The ID of the user that last modified the attribute

attributeDescriptionId uuidrequired

Possible values: >= 36 characters and <= 36 characters

The AttributeDescription ID for this attribute

value

object

required

The value for this attribute

oneOf

AttributeTextValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

textValues

object[]

required

Attribute textValues per language

Array [

language stringrequired

Possible values: >= 2 characters and <= 2 characters

Language is set as 2 character country code.

values array[]

List of localized string values

]

AttributeEnumValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

enumValues string[]required

Attribute enum values

AttributeIntValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

intValue integerrequired

Attribute integer value

AttributeDecimalValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

decimalValue floatrequired

Attribute decimal value

AttributeColorValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

colorValue stringnullablerequired

Attribute color value, stored as a hex string

AttributeDateTimeValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

dateTimeValue date-timenullablerequired

Attribute decimal value

categoryId integerrequired

The ID of the category this attribute belongs to

CompanyAttribute

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

The ID for this attribute

createdAt date-time

Default value: CURRENT_TIMESTAMP

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

createdBy integer

The ID of the user that created the attribute

lastModifiedBy integer

The ID of the user that last modified the attribute

attributeDescriptionId uuidrequired

Possible values: >= 36 characters and <= 36 characters

The AttributeDescription ID for this attribute

value

object

required

The value for this attribute

oneOf

AttributeTextValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

textValues

object[]

required

Attribute textValues per language

Array [

language stringrequired

Possible values: >= 2 characters and <= 2 characters

Language is set as 2 character country code.

values array[]

List of localized string values

]

AttributeEnumValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

enumValues string[]required

Attribute enum values

AttributeIntValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

intValue integerrequired

Attribute integer value

AttributeDecimalValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

decimalValue floatrequired

Attribute decimal value

AttributeColorValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

colorValue stringnullablerequired

Attribute color value, stored as a hex string

AttributeDateTimeValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

dateTimeValue date-timenullablerequired

Attribute decimal value

companyId integerrequired

The ID of the company this attribute belongs to

ContactAttribute

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

The ID for this attribute

createdAt date-time

Default value: CURRENT_TIMESTAMP

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

createdBy integer

The ID of the user that created the attribute

lastModifiedBy integer

The ID of the user that last modified the attribute

attributeDescriptionId uuidrequired

Possible values: >= 36 characters and <= 36 characters

The AttributeDescription ID for this attribute

value

object

required

The value for this attribute

oneOf

AttributeTextValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

textValues

object[]

required

Attribute textValues per language

Array [

language stringrequired

Possible values: >= 2 characters and <= 2 characters

Language is set as 2 character country code.

values array[]

List of localized string values

]

AttributeEnumValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

enumValues string[]required

Attribute enum values

AttributeIntValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

intValue integerrequired

Attribute integer value

AttributeDecimalValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

decimalValue floatrequired

Attribute decimal value

AttributeColorValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

colorValue stringnullablerequired

Attribute color value, stored as a hex string

AttributeDateTimeValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

dateTimeValue date-timenullablerequired

Attribute decimal value

contactId integerrequired

The ID of the contact this attribute belongs to

CustomerAttribute

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

The ID for this attribute

createdAt date-time

Default value: CURRENT_TIMESTAMP

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

createdBy integer

The ID of the user that created the attribute

lastModifiedBy integer

The ID of the user that last modified the attribute

attributeDescriptionId uuidrequired

Possible values: >= 36 characters and <= 36 characters

The AttributeDescription ID for this attribute

value

object

required

The value for this attribute

oneOf

AttributeTextValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

textValues

object[]

required

Attribute textValues per language

Array [

language stringrequired

Possible values: >= 2 characters and <= 2 characters

Language is set as 2 character country code.

values array[]

List of localized string values

]

AttributeEnumValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

enumValues string[]required

Attribute enum values

AttributeIntValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

intValue integerrequired

Attribute integer value

AttributeDecimalValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

decimalValue floatrequired

Attribute decimal value

AttributeColorValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

colorValue stringnullablerequired

Attribute color value, stored as a hex string

AttributeDateTimeValue

id uuidrequired

Possible values: >= 36 characters and <= 36 characters

Unique identifier of the attribute value

createdAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value creation date

lastModifiedAt date-time

Default value: CURRENT_TIMESTAMP

Attribute value last modified date

createdBy integer

The userId of the user that created the attribute value

lastModifiedBy integer

The userId of the user that last modified the attribute description

dateTimeValue date-timenullablerequired

Attribute decimal value

customerId integerrequired

The ID of the customer this attribute belongs to

• ]

Example (from schema)

[
  {},
  {},
  {},
  {},
  {},
  {}
]

400

Bad request

401

Unauthorized

application/json

Schema

Schema

any

invalid_client_id

{
  "ErrorCode": "invalid_client",
  "Error": "ClientId is Invalid"
}

invalid_client_cred

{
  "ErrorCode": "invalid_client",
  "Error": "Client credentials are invalid"
}

500

List attributes error

Loading...