---
updatedAt: 2026-09-08T22:10:09.000Z
agentTools:
  projectIndex: https://developers.virtualincentives.com/llms.txt
---

# Get Recipients by Email

**Endpoint:** `https://rest.virtualincentives.com/{version}/{format}/recipients?email={email}`

**Method:** `GET`

<Callout icon="📘" theme="info">
  ### Query string parameters must be URL encoded.
</Callout>

# Definitions

| Field       | Type         | Description                                                                    |
| ----------- | ------------ | ------------------------------------------------------------------------------ |
| id          | integer      | The unique id for this recipient.                                              |
| email       | string(200)  | Account holder email address.                                                  |
| udf1        | string(100)  | Additional User Defined field.<br /><br />**Note:** See ‘udf1’ for definition. |
| udf2        | string(100)  | Additional User Defined field.<br /><br />**Note:** See ‘udf1’ for definition. |
| udf3        | string(1000) | Additional User Defined field.<br /><br />**Note:** See ‘udf1’ for definition. |
| udf4        | string(1000) | Additional User Defined field.<br /><br />**Note:** See ‘udf1’ for definition. |
| udf5        | string(1000) | Additional User Defined field.<br /><br />**Note:** See ‘udf1’ for definition. |
| udf6        | string(4000) | Additional User Defined field.<br /><br />**Note:** See ‘udf1’ for definition. |
| udf7        | string(4000) | Additional User Defined field.<br /><br />**Note:** See ‘udf1’ for definition. |
| udf8        | string(4000) | Additional User Defined field.<br /><br />**Note:** See ‘udf1’ for definition. |
| udf9        | string(4000) | Additional User Defined field.<br /><br />**Note:** See ‘udf1’ for definition. |
| udf10       | string(4000) | Additional User Defined field.<br /><br />**Note:** See ‘udf1’ for definition. |
| ordernumber | integer      | Order number that this recipient is related to.                                |

# Examples

## XML Example

```text
<response>
  <page>1</page>
  <more>false</more>
  <count>1</count>
  <total>1</total>

  <recipients>
    <recipient>
      <id>258160</id>
      <email>sample@virtualincentives.com</email>
      <ordernumber>24690879</ordernumber>
    </recipient>
  </recipients>
</response>
```

## JSON Example

```text
{"response":{
"Page":1,
"More":false,
"Count":1,
"Total":1,

"Recipients":[
{"id":"258160",
"email":"sample@virtualincentives.com",
"ordernumber":"24690879"}]}}
```