Get attribute definition

Get attribute definition

get

https://api.bird.comhttp://localhost:3000https://api.bird.ai

/workspaces/{workspaceId}/attribute-definitions/{attributeDefinitionKey}

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

Authorizations

MessageBird_userMessageBird_accessKey

AuthorizationstringRequired

An access token issued to a user.

Path parameters

workspaceIdstring · uuidRequired

Your workspace identifier.

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

attributeDefinitionKeystringRequired

The key of an attribute definition.

Example: company

Responses

200

The attribute definition was returned successfully.

application/json

idstringOptional

The UUID, primarily for internal reference

Example: 123e4567-e89b-12d3-a456-426614174000

keystringOptional

A user-specified key, primarily for client reference.

Example: countryCode

displayNamestringOptional

A human-readable name of the attribute.

Example: Country Code

descriptionstringOptional

A user-friendly description of the attribute.

Example: The country code of the contact.

cardinalitystring · enumOptional

The cardinality configures how many values belong to the single key.

Possible values:

typestring · enumOptional

The data type of the attribute.

Possible values:

formatone ofOptional

or

or

or

or

or

or

or

piibooleanOptional

A flag to indicate whether this attribute is considered personally identifiable information.

Example: false

readOnlybooleanOptional

A flag to indicate whether this attribute may be updated after creation.

Example: false

builtinbooleanOptional

A flag to indicate whether this attribute is built-in. Built-in attributes are system-defined and cannot be updated or deleted by end-users.

Example: false

archivedbooleanOptional

A flag to indicate whether this attribute is archived.

Example: false

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

versionnumberOptional

The version number of the attribute definition.

Example: 1

404

The workspace or attribute definition key was not found.

application/json

get

/workspaces/{workspaceId}/attribute-definitions/{attributeDefinitionKey}

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/attribute-definitions/{attributeDefinitionKey} HTTP/1.1
Host: api.bird.com
Authorization: Bearer YOUR_SECRET_TOKEN
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": "2026-03-09T23:57:31.689Z",
  "updatedAt": "2026-03-09T23:57:31.689Z",
  "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)