> For the complete documentation index, see [llms.txt](https://docs.bird.com/api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bird.com/api/contacts-api/api-reference/manage-contact-attribute-definition/list-attribute-definitions.md).

# List attribute definitions

{% openapi src="<https://global--openapi-specs--151603429280--use1.s3.us-east-1.amazonaws.com/joined-specs/openapi.yml>" path="/workspaces/{workspaceId}/attribute-definitions" method="get" %}
<https://global--openapi-specs--151603429280--use1.s3.us-east-1.amazonaws.com/joined-specs/openapi.yml>
{% endopenapi %}

## 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.

{% tabs %}
{% tab title="Request" %}

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

{% endtab %}

{% tab title="Response (200 - OK)" %}

```json
{
  "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"
    }
  ]
}

```

{% endtab %}
{% endtabs %}
