List attribute definitions

List attribute definitions

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

GEThttps://api.bird.com/workspaces/{workspaceId}/attribute-definitions

Path parameters

workspaceId*string (uuid)

Your workspace identifier.

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

Query parameters

Response

200404

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

Body

application/json

idstring

The UUID, primarily for internal reference

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

keystring

A user-specified key, primarily for client reference.

Example: "countryCode"

displayNamestring

A human-readable name of the attribute.

Example: "Country Code"

descriptionstring

A user-friendly description of the attribute.

Example: "The country code of the contact."

cardinalityenum

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

onemany

typeenum

The data type of the attribute.

booleandatetimenumberstring

formatContacts_AttributeFormat (object)

emailAddressphoneNumberselectuuidtexturldatenumberScale

piiboolean

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

Example: false

readOnlyboolean

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

Example: false

builtinboolean

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

archivedboolean

A flag to indicate whether this attribute is archived.

Example: false

indexMappingContacts_AttributeIndexMapping (object)

createdAtstring (date-time)

updatedAtstring (date-time)

versionnumber

The version number of the attribute definition.

Example: 1

aclarray of Contacts_AttributeDefinitionAcl (object)

An array of ACLs that define the access control for this attribute

nextPageTokenstring

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.

Request

JavaScriptCurlPython

const response = await fetch('https://api.bird.com/workspaces/{workspaceId}/attribute-definitions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200404

{
  "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": "2024-12-21T15:46:13.524Z",
  "updatedAt": "2024-12-21T15:46:13.524Z",
  "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"
    }
  ]
}