Skip to main content
GET
/
contact-properties
import { Resend } from 'resend';

const resend = new Resend('re_xxxxxxxxx');

const { data, error } = await resend.contactProperties.list();

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "id": "b6d24b8e-af0b-4c3c-be0c-359bbd97381e",
      "key": "company_name",
      "type": "string",
      "fallback_value": "Acme Corp",
      "created_at": "2023-04-08T00:11:13.110779+00:00"
    }
  ]
}
Contact Properties are currently in private beta and only available to a limited number of users. APIs might change before GA.To use the methods on this page, you must upgrade your Resend SDK:
npm install resend@6.3.0-canary.4
Join the waitlist if you’re interested in testing this feature.

Query Parameters

​
limit
number
Number of contact-properties to retrieve.
  • Default value: 20
  • Maximum value: 100
  • Minimum value: 1
​
after
string
The ID after which we'll retrieve more contact-properties (for pagination). This ID will not be included in the returned list. Cannot be used with thebefore parameter.
​
before
string
The ID before which we'll retrieve more contact-properties (for pagination). This ID will not be included in the returned list. Cannot be used with the after parameter.
You can only use either after or before parameter, not both. See our pagination guide for more information.
import { Resend } from 'resend';

const resend = new Resend('re_xxxxxxxxx');

const { data, error } = await resend.contactProperties.list();

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "id": "b6d24b8e-af0b-4c3c-be0c-359bbd97381e",
      "key": "company_name",
      "type": "string",
      "fallback_value": "Acme Corp",
      "created_at": "2023-04-08T00:11:13.110779+00:00"
    }
  ]
}