Attributes

List contact attribute keys

GET/v1/attributes

Requires an API key with the attributes:read scope. About keys and scopes

Every attribute key your contacts carry, with its inferred type and how many contacts have it: the pickers for segment rules and merge tags. Read from an index up to five minutes old (a contact import refreshes it at once). A list key takes contains, notContains, exists and notExists in rules. masked keys are listed, but their values are hidden from members and embed sessions.

Query parameters

limitintegeroptional: min > 0 · max 100 · default 20
cursorstringoptional: 1–2048 characters

Returns

Returns 200 OK with a list of Attribute objects in data, and the next page's cursor in meta (see pagination). Otherwise returns an error; Errors lists every code and which to retry.

keystringrequired

The attribute key, as written on contacts.

typestringrequired

Inferred from the values held. list: every value is an array (["running", "yoga"], a form's checkboxes); mixed: more than one type.

one of string, number, boolean, date, list, mixed

contactCountintegerrequired

Contacts that have this key.

min 0 · max 9007199254740991

maskedbooleanrequired

Masked in workspace settings: members see the key, not its values.

curl https://api.kirora.io/v1/attributes \
  -H "Authorization: Bearer $KIRORA_API_KEY"

const response = await fetch('https://api.kirora.io/v1/attributes', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.KIRORA_API_KEY}`,
  },
});
const { data } = await response.json();

import os

import requests

response = requests.get(
    "https://api.kirora.io/v1/attributes",
    headers={
        "Authorization": f"Bearer {os.environ['KIRORA_API_KEY']}",
    },
)
data = response.json()["data"]

package main

import (
	"encoding/json"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest("GET", "https://api.kirora.io/v1/attributes", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("KIRORA_API_KEY"))

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	var out struct {
		Data json.RawMessage `json:"data"`
	}
	if err := json.NewDecoder(res.Body).Decode(&out); err != nil {
		panic(err)
	}
}

Response · 200

{
  "data": [
    {
      "key": "key_example",
      "type": "string",
      "contactCount": 0,
      "masked": true
    }
  ],
  "meta": {
    "pagination": {
      "limit": 1,
      "nextCursor": "nextCursor_example"
    }
  }
}

Example values are generated from the schema.