Get attribute definition

Get attribute definition

get

Get the specified attribute definition from the schema given its key.

Authorizations

MessageBird_userMessageBird_accessKey

Path parameters

workspaceIdstring · uuidRequired

Your workspace identifier.

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

attributeDefinitionKeystringRequired

The key of an attribute definition.

Example: company

Responses

application/json

objectOptional

application/json

get

HTTPcURLJavaScriptPython

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

{
  "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-04-19T00:38:49.852Z",
  "updatedAt": "2025-04-19T00:38:49.852Z",
  "version": 1,
  "acl": [
    {
      "roleId": "123e4567-e89b-12d3-a456-426614174000",
      "read": true,
      "write": true
    }
  ]
}

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