Get a contact by ID or email | Resend API (unofficial showcase)

1 parameter

idstringrequired

The contact ID or email address.

1 status code

200Returns the contact's identifier, email address, name, creation timestamp, subscription status, and custom properties.

objectstringoptional

Type of the response object.

idstringoptional

Unique identifier for the contact.

emailstringoptional

Email address of the contact.

first_namestringoptional

First name of the contact.

last_namestringoptional

Last name of the contact.

created_atstringoptional

Timestamp indicating when the contact was created.

unsubscribedbooleanoptional

Indicates if the contact is unsubscribed.

propertiesobjectoptional

A map of custom property keys and values.

Error handling

The id path parameter must contain the contact's ID or email address.

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

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

const result = await client.contacts.get({ id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "object": "contact",
  "id": "e169aa45-1ecf-4183-9955-b1499d5701d3",
  "email": "steve.wozniak@gmail.com",
  "first_name": "Steve",
  "last_name": "Wozniak",
  "created_at": "2023-10-06 23:47:56.678+00",
  "unsubscribed": false
}

Request

Response

Errors