v1

latestOpenAPI 3.1.02026-08-04103211436.0 KB

Attributes

Retrieve attribute

Returns a single attribute by customId.

get/attributes/{companyId}/{customId}

Path parameters

customIdstring required

companyIdstring required

Response

Successful Response

customIdstring nullable

Your own unique ID for the attribute. If omitted, Embat auto-generates one.

source'erp' | 'api' | 'embat'

activeboolean

Whether the attribute is active.

namestring required

Display name of the attribute.

type'list' | 'string' | 'number'

requiredboolean

Whether a value for this attribute should be mandatory wherever it is used. Informational only: this API does not enforce it.

parentCustomIdstring nullable

Custom ID of the parent attribute this attribute is nested under.

idstring required

Embat attribute ID.

createdAtstring date-time required

Creation date of the attribute.

updatedAtstring date-time required

Last modification date of the attribute.

parentIdstring nullable

Embat ID of the parent attribute. Only present when the attribute is nested under another one via parentCustomId.

companyIdstring required

Embat company ID. You can get them from "companies" endpoints

Example response

{
  "customId": "cost-center",
  "name": "Cost Center",
  "values": [
    {
      "customId": "madrid",
      "name": "Madrid",
      "parentCustomId": "spain"
    }
  ]
}