List Contact Properties

List all custom contact properties for the organization with cursor-based pagination.

GET/contact-properties

Requires an API key with properties:read permission.

Query Parameters

limitnumber

Maximum number of results to return. Min 1, max 100. Default 20.

afterstring

Cursor for forward pagination.

beforestring

Cursor for backward pagination.

Response Fields

objectstring

Always "list".

has_moreboolean

Whether there are more results available.

dataarray

Array of contact property objects. Each item contains id, key, type, fallback_value, and created_at.

curl -X GET 'https://api.postflare.dev/contact-properties?limit=20' \
  -H 'Authorization: Bearer sk_xxxxxxxxx'

const response = await fetch(
  'https://api.postflare.dev/contact-properties?limit=20',
  {
    headers: {
      'Authorization': 'Bearer sk_xxxxxxxxx',
    },
  }
);

const data = await response.json();

Response

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "key": "plan",
      "type": "string",
      "fallback_value": "free",
      "created_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}