List attribute definitions

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

List the attributes

In this example, we're listing all attribute definitions from a given workspace.

Request

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

Response (200 - OK)

{
  "results": [
    {
      "key": "birthday",
      "displayName": "Birthday",
      "description": "",
      "cardinality": "one",
      "type": "datetime",
      "pii": true,
      "readOnly": false,
      "builtin": true,
      "archived": false,
      "createdAt": "0001-01-01T00:00:00Z",
      "updatedAt": "0001-01-01T00:00:00Z",
      "group": "standard"
    },
    {
      "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"
    }
  ]
}