Find recipient

Find recipient

You can search for recipients by name or phone. Note that finding a recipient requires that there be an exact match for the target property provided. Names are case insensitive and must be properly encoded, while phones will be automatically E.164-formatted prior to performing the lookup as per your organization's country setting.

To find a recipient by name, the endpoint format is /name/:name, for example, /name/jony%20chives. Similarly, to find a recipient by phone, the format is /phone/:phone, for example, /phone/4155521837.

If the recipient was created without validation, you may provide the query parameter skipPhoneNumberValidation as true in order to bypass validation.

curl -X GET "https://onfleet.com/api/v2/recipients/name/neiman%20runtilly" \
       -u "cd3b3de84cc1ee040bf06512d233719c:"

onfleet.recipients.get(name="neiman runtilly")

onfleet.recipients.get("neiman runtilly", "name");

$onfleet->recipients->get("neiman runtilly", "name")

{
  "id": "7tuqrtwo75UlcJFCzDk7Clfk",
  "organization": "yAM*fDkztrT3gUcz9mNDgNOL",
  "timeCreated": 1455142309000,
  "timeLastModified": 1455142309695,
  "name": "Neiman Runtilly",
  "phone": "+16503201133",
  "notes": "Always orders our GSC special",
  "skipSMSNotifications": false,
  "metadata": []
}