Search recipients

v1.0.0

This endpoint allows you to perform a search on all of your Marketing Campaigns recipients.

field_name:

is a variable that is substituted for your actual custom field name from your recipient.
Text fields must be url-encoded. Date fields are searchable only by unix timestamp (e.g. 2/2/2015 becomes 1422835200)
If field_name is a 'reserved' date field, such as created_at or updated_at, the system will internally convert your epoch time to a date range encompassing the entire day. For example, an epoch time of 1422835600 converts to Mon, 02 Feb 2015 00:06:40 GMT, but internally the system will search from Mon, 02 Feb 2015 00:00:00 GMT through Mon, 02 Feb 2015 23:59:59 GMT.

Input

{
  "type": "object",
  "properties": {
    "on-behalf-of": {
      "type": "string"
    },
    "{field_name}": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "recipients": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "recipients": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "email"
              ],
              "properties": {
                "created_at": {
                  "type": "number",
                  "description": "The time this record was created in your contactdb, in unixtime."
                },
                "custom_fields": {
                  "type": "array",
                  "description": "The custom fields assigned to this recipient and their values.",
                  "items": {
                    "type": "object"
                  }
                },
                "email": {
                  "type": "string",
                  "format": "email",
                  "description": "The email address of this recipient. This is a default custom field that SendGrid provides."
                },
                "first_name": {
                  "type": "string",
                  "description": "The first name of this recipient. This is a default custom field that SendGrid provides."
                },
                "id": {
                  "type": "string",
                  "description": "The ID of this recipient."
                },
                "last_clicked": {
                  "type": "number",
                  "description": "The last time this recipient clicked a link from one of your campaigns, in unixtime."
                },
                "last_emailed": {
                  "type": "number",
                  "description": "The last time this user was emailed by one of your campaigns, in unixtime."
                },
                "last_name": {
                  "type": "string",
                  "description": "The last name of the recipient."
                },
                "last_opened": {
                  "type": "number",
                  "description": "The last time this recipient opened an email from you, in unixtime."
                },
                "updated_at": {
                  "type": "number",
                  "description": "The last update date for this recipient's record."
                }
              }
            }
          }
        }
      }
    }
  }
}