Retrieve a sender

client.sender.retrieve(, ?): SenderRetrieveResponse { id, archivedAt, channel, 9 more }

GET/v1/senders/{id}

Retrieves a sender by its ID, archived ones included.

Required scope: senders:read

Rate limit category: Read

ParametersExpand Collapse

id: string

Unique identifier of the sender to retrieve.

ReturnsExpand Collapse

SenderRetrieveResponse { id, archivedAt, channel, 9 more }

id: string

Unique identifier of the sender.

archivedAt: string | null

When the sender was archived, or null if it is active. Archived senders never send.

channel: "EMAIL" | "LINKEDIN"

Whether this sender sends email or LinkedIn messages.

One of the following:

"EMAIL"

"LINKEDIN"

createdAt: string

When the sender was created.

emailAddress: string | null

The address email from this sender is sent from. Null for LinkedIn senders, or when the connected account has no address.

health: "UNVERIFIED" | "HEALTHY" | "UNHEALTHY"

HEALTHY can send. UNHEALTHY cannot send until healthReason is resolved. UNVERIFIED means no health verdict yet: an email sender in this state cannot send until it passes a health check, while a LinkedIn sender is never health-checked, so a working LinkedIn sender is usually UNVERIFIED and can send.

One of the following:

"UNVERIFIED"

"HEALTHY"

"UNHEALTHY"

healthReason: string | null

Why the sender is UNHEALTHY or UNVERIFIED, for example ACCOUNT_DISCONNECTED, BOUNCE_THRESHOLD or INVITE_LIMIT; null when healthy.

objectType: "sender"

Always sender.

owner: string | null

Member ID of the person who owns this sender, or null when no workspace membership can be resolved.

pacing: Pacing { EMAIL, LINKEDIN_INVITE, LINKEDIN_MESSAGE }

How this sender paces each step type it sends, keyed by sequence step type: EMAIL for an email sender; LINKEDIN_INVITE and LINKEDIN_MESSAGE for a LinkedIn sender.

EMAIL?: Email { dailyLimit, maxGapSeconds, minGapSeconds }

Email steps. Present only on an email sender.

dailyLimit: number

Most sends of this step type in any rolling 24 hours.

minimum-9007199254740991

maximum9007199254740991

maxGapSeconds: number | null

Upper bound of the minimum spacing, in seconds. Before each send, a minimum spacing is drawn at random between minGapSeconds and this value, and the send waits until that long after the previous one. Sends can be further apart, for example outside the send window or once dailyLimit is reached. Null means the minimum spacing is always minGapSeconds.

minimum-9007199254740991

maximum9007199254740991

minGapSeconds: number

Lower bound of the minimum spacing between two of its sends, in seconds.

minimum-9007199254740991

maximum9007199254740991

LINKEDIN_INVITE?: LinkedinInvite { dailyLimit, maxGapSeconds, minGapSeconds }

LinkedIn connection requests. Present only on a LinkedIn sender.

dailyLimit: number

Most sends of this step type in any rolling 24 hours.

minimum-9007199254740991

maximum9007199254740991

maxGapSeconds: number | null

minimum-9007199254740991

maximum9007199254740991

minGapSeconds: number

Lower bound of the minimum spacing between two of its sends, in seconds.

minimum-9007199254740991

maximum9007199254740991

LINKEDIN_MESSAGE?: LinkedinMessage { dailyLimit, maxGapSeconds, minGapSeconds }

LinkedIn messages. Present only on a LinkedIn sender.

dailyLimit: number

Most sends of this step type in any rolling 24 hours.

minimum-9007199254740991

maximum9007199254740991

maxGapSeconds: number | null

minimum-9007199254740991

maximum9007199254740991

minGapSeconds: number

Lower bound of the minimum spacing between two of its sends, in seconds.

minimum-9007199254740991

maximum9007199254740991

replyToAddress: string | null

SMTP senders only: the connected mailbox replies are sent to and read from. Null for other senders.

transport: "SMTP" | "OAUTH" | null

How an email sender sends: SMTP through its own mail server, OAUTH through its connected Google or Microsoft account. Null for LinkedIn senders.

One of the following:

"SMTP"

"OAUTH"

Retrieve a sender

import Lightfield from 'lightfield';

const client = new Lightfield({
  apiKey: 'My API Key',
});

const senderRetrieveResponse = await client.sender.retrieve('id');

console.log(senderRetrieveResponse.id);

{
  "id": "id",
  "archivedAt": "archivedAt",
  "channel": "EMAIL",
  "createdAt": "createdAt",
  "emailAddress": "emailAddress",
  "health": "UNVERIFIED",
  "healthReason": "healthReason",
  "objectType": "sender",
  "owner": "owner",
  "pacing": {
    "EMAIL": {
      "dailyLimit": -9007199254740991,
      "maxGapSeconds": -9007199254740991,
      "minGapSeconds": -9007199254740991
    },
    "LINKEDIN_INVITE": {
      "dailyLimit": -9007199254740991,
      "maxGapSeconds": -9007199254740991,
      "minGapSeconds": -9007199254740991
    },
    "LINKEDIN_MESSAGE": {
      "dailyLimit": -9007199254740991,
      "maxGapSeconds": -9007199254740991,
      "minGapSeconds": -9007199254740991
    }
  },
  "replyToAddress": "replyToAddress",
  "transport": "SMTP"
}

Returns Examples

{
  "id": "id",
  "archivedAt": "archivedAt",
  "channel": "EMAIL",
  "createdAt": "createdAt",
  "emailAddress": "emailAddress",
  "health": "UNVERIFIED",
  "healthReason": "healthReason",
  "objectType": "sender",
  "owner": "owner",
  "pacing": {
    "EMAIL": {
      "dailyLimit": -9007199254740991,
      "maxGapSeconds": -9007199254740991,
      "minGapSeconds": -9007199254740991
    },
    "LINKEDIN_INVITE": {
      "dailyLimit": -9007199254740991,
      "maxGapSeconds": -9007199254740991,
      "minGapSeconds": -9007199254740991
    },
    "LINKEDIN_MESSAGE": {
      "dailyLimit": -9007199254740991,
      "maxGapSeconds": -9007199254740991,
      "minGapSeconds": -9007199254740991
    }
  },
  "replyToAddress": "replyToAddress",
  "transport": "SMTP"
}