Get a contact property | Resend API (unofficial showcase)

1 parameter

idstringrequired

The ID of the contact property to retrieve.

1 status code

200Returns the contact property’s ID, key, type, fallback value, and creation timestamp, along with the response object type.

objectstringoptional

The object type.

idstringoptional

The ID of the contact property.

keystringoptional

The property key.

typestringoptional

The property type.

fallback_valuestringoptional

The default value when the property is not set for a contact.

created_atstringoptional

Timestamp indicating when the contact property was created.

Error handling

The id path parameter must identify the contact property you want to retrieve. Supply the contact property ID as a string.

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.get({ id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "object": "contact_property",
  "id": "b6d24b8e-af0b-4c3c-be0c-359bbd97381e",
  "key": "company_name",
  "type": "string",
  "fallback_value": "Acme Corp",
  "created_at": "2023-10-06 23:47:56.678+00"
}

Request

Response

Errors