Attributes

Attributes are key-value pairs hanging off an organization. They hold whatever business data belongs with a customer record, subscription tier, external system ids, feature flags, without anyone extending the core schema for it.

Groups carry attributes too, with the same shape and the same upsert semantics, under /groups/{group_id}/attributes. See Groups.

Attribute endpoints

Listing needs view_organizations, manage_organizations or manage_realm. Upserting and deleting need manage_organizations or manage_realm.

Upsert semantics

PUT upserts by key. An existing key has its value overwritten; a new key is created. There is no separate create endpoint. The response is the attribute.

{
  "value": "enterprise"
}

The key comes from the path and the value from the body. Both are required, and FerrisKey trims surrounding whitespace from them. An empty or missing value is rejected.

Attribute fields

Several attributes at once

A typical organization might carry several attributes. The list answers an object with a data array:

{
  "data": [
    {
      "id": "01936b2e-aaaa-7000-abcd-000000000001",
      "organization_id": "01936b2e-1234-7000-abcd-000000000001",
      "key": "plan",
      "value": "enterprise",
      "created_at": "2026-01-15T09:00:00Z"
    },
    {
      "id": "01936b2e-bbbb-7000-abcd-000000000002",
      "organization_id": "01936b2e-1234-7000-abcd-000000000001",
      "key": "stripe_customer_id",
      "value": "cus_Qx8mN2kLpR4t",
      "created_at": "2026-01-15T09:01:00Z"
    },
    {
      "id": "01936b2e-cccc-7000-abcd-000000000003",
      "organization_id": "01936b2e-1234-7000-abcd-000000000001",
      "key": "feature_advanced_reporting",
      "value": "true",
      "created_at": "2026-03-01T14:30:00Z"
    }
  ]
}

The list is not paginated.

Real-world uses