Menu

Contacts API - Recipients

Elements that can be shared among more than one endpoint definition.

Retrieve a single recipient

Retrieve a single recipient

GET /contactdb/recipients/{recipient_id}

This endpoint allows you to retrieve a single recipient by ID from your contact database.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string
default: The subuser's username. This header generates the API call as if the subuser account was making the call.

Path Parameters

recipient_id
string

The ID of the recipient that you want to retrieve.

required

Responses

object
recipients
array[object]
id
string

The ID of this recipient.

created_at
number

The time this record was created in your contactdb, in unixtime.

custom_fields
array[object]

The custom fields assigned to this recipient and their values.

value
string

The value of this recipient's custom field

email
string

The email address of this recipient. This is a default custom field that SendGrid provides.

format: email
first_name
string

The first name of this recipient. This is a default custom field that SendGrid provides.

last_name
string

The last name of the recipient.

last_clicked
number

The last time this recipient clicked a link from one of your campaigns, in unixtime.

last_emailed
number

The last time this user was emailed by one of your campaigns, in unixtime.

last_opened
number

The last time this recipient opened an email from you, in unixtime.

updated_at
number

The last update date for this recipient's record.

object
object
errors
array[object]
message
string

the error message

field
string

the field that generated the error

help
object

helper text or docs for troubleshooting

id
string
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
object

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.