Segments

List contacts in a segment

GET/v1/segments/{id}/contacts

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

Evaluates a saved segment and returns the matching contacts. Because segments are evaluated on read, results can change between pages if contacts are changing underneath. Results are cursor-paginated: pass meta.pagination.nextCursor back as cursor until it comes back null. The cursor is opaque — do not construct or parse one. meta.count counts the matching contacts up to 10000: beyond that it reports the cap and meta.countExact is false; both are counted on the first page only (null with a cursor).

Path parameters

idstringrequired: uuid

Query parameters

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

Returns

Returns 200 OK with a list of Contact 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.

idstringrequired: uuid
externalIdstring | nullrequired: Your own id for the contact, if set.
emailstring | nullrequired: email
firstNamestring | nullrequired
lastNamestring | nullrequired
phonestring | nullrequired: Phone number in E.164 format.
timezonestring | nullrequired: IANA timezone, e.g. Europe/London.
countrystring | nullrequired: ISO 3166-1 alpha-2 code: as written, or inferred from the phone, else the timezone.
datesobjectrequired: Named calendar dates, e.g. birthday, as YYYY-MM-DD or --MM-DD.
attributesobjectrequired: Custom attributes, keyed by attribute name.
emailConsentbooleanrequired: Whether the contact has consented to email.
pushConsentbooleanrequired: Whether the contact has consented to push.
createdAtstringrequired: date-time
updatedAtstringrequired: date-time

curl https://api.kirora.io/v1/segments/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/contacts \
  -H "Authorization: Bearer $KIRORA_API_KEY"

const response = await fetch('https://api.kirora.io/v1/segments/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/contacts', {
  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/segments/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/contacts",
    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/segments/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/contacts", 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": [
    {
      "id": "018f2a4e-6b1c-7d3e-9f40-37386ae05a6b",
      "externalId": "user_8812",
      "email": "amaka@juniperkitchen.com",
      "firstName": "Amaka",
      "lastName": "Eze",
      "phone": "+447700900123",
      "timezone": "Europe/London",
      "country": "GB",
      "dates": {},
      "attributes": {},
      "emailConsent": true,
      "pushConsent": true,
      "createdAt": "2030-03-14T09:30:00Z",
      "updatedAt": "2030-03-14T09:30:00Z"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 1,
      "nextCursor": "nextCursor_example"
    },
    "count": 0,
    "countExact": true
  }
}

Example values are generated from the schema.