List contact properties | Resend API (unofficial showcase)

3 parameters

limitintegeroptional

The number of contact properties to return; must be between 1 and 100.

afterstringoptional

Return contact properties after this cursor.

beforestringoptional

Return contact properties before this cursor.

1 status code

200Returns a response object containing contact property data and a `has_more` flag indicating whether additional results are available.

objectstringoptional

Type of the response object.

has_morebooleanoptional

Indicates if there are more results available.

dataarray<object>optional

Array containing contact property information.

Error handling

limit must be an integer between 1 and 100. Use after or before to specify a cursor for navigating the results.

import { Client } from "@octridev/resend";

const client = new Client({
  baseUrl: "https://api.resend.com",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.contactProperties.list({
  limit: 20,
  after: "example",
  before: "example",
});

{
  "object": "list",
  "has_more": true,
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "key": "example_key_abc123",
      "type": "standard",
      "fallback_value": "example_value",
      "created_at": "2023-10-06 23:47:56.678+00"
    }
  ]
}

Request

Response

Errors