Get attribute definition

Error while loading OpenAPI operation — Invalid OpenAPI document

Examples

Let's establish some of our data that will be used in the following examples:

• Workspace ID: a1405560-c8d3-4b1a-877d-3f449ad95352

• AccessKey: abcd

• Attribute Definition Key: countryCode

Get an attribute definition

In this example, we're fetching the attribute definition by its key.

Request

curl -X GET "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/attribute-definitions/countryCode" \
-H "Authorization: AccessKey abcd" \
-H "Content-Type: application/json" \

Response (200 OK)

{
  "key": "countryCode",
  "displayName": "countryCode",
  "description": "Country code",
  "cardinality": "one",
  "type": "string",
  "pii": false,
  "readOnly": false,
  "builtin": false,
  "archived": false,
  "createdAt": "2024-11-26T15:00:00.000Z",
  "updatedAt": "2024-11-26T15:00:00.000Z",
  "group": "custom"
}