List attribute definitions

List attribute definitions

get

This endpoint will return a list of attribute definitions in the schema.

Authorizations

MessageBird_userMessageBird_accessKey

Path parameters

workspaceIdstring · uuidRequired

Your workspace identifier.

Example: b4e02c85-c6d2-4b15-8885-e09671799c61

Query parameters

limitinteger · min: 1 · max: 100Optional

Limits the number of results to return. The default value is 10, the minimum is one and the maximum is 100.

Default: 10

pageTokenstring · max: 8000Optional

Pagination token that keeps of track of the current position in the list.

Example: nextPageToken123

reversebooleanOptional

Order in which to retrieve the results.

Default: false

Responses

200

A list of attribute definitions was returned. The list can be empty if no attribute definitions are found.

application/json

Responseall of

404

The workspace was not found.

application/json

get

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/attribute-definitions HTTP/1.1
Host: api.bird.com
Authorization: Bearer JWT
Accept: */*

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "key": "countryCode",
      "displayName": "Country Code",
      "description": "The country code of the contact.",
      "cardinality": "one",
      "type": "boolean",
      "format": {
        "type": "emailAddress"
      },
      "pii": false,
      "readOnly": false,
      "builtin": false,
      "archived": false,
      "indexMapping": {
        "fields": [
          {
            "name": "emailaddress-standard",
            "analyzer": "simple",
            "type": "string"
          }
        ]
      },
      "createdAt": "2025-07-11T17:36:35.404Z",
      "updatedAt": "2025-07-11T17:36:35.404Z",
      "version": 1,
      "acl": [
        {
          "roleId": "123e4567-e89b-12d3-a456-426614174000",
          "read": true,
          "write": true
        }
      ]
    }
  ],
  "nextPageToken": "text"
}

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"
    }
  ]
}