Search invitations

At least one search criterion must be provided. customer_no supports % for zero or more characters and _ for one character; site_code and invitation_key are exact matches.

invitation_url is returned for invitation, registration, and Deeplink uploads—not for direct uploads.

Request parameters

Parameter	Required	Description
customer_no	Conditional	Customer number; % and _ wildcards are accepted.
customer_to	Conditional	Email address or phone number.
invitation_key	Conditional	Exact invitation key.
site_code	Conditional	Exact site code.
limit	No	Maximum records; default 20.
language_interface	No	Response language.

Response

{
  "meta": {
    "limit": 20,
    "results_returned": 1,
    "results_available": 1
  },
  "result": [
    {
      "invitation_key": "o2hIyfWYpMq8",
      "customer_no": "123456789",
      "upload_channel": "invitation",
      "site_code": "demo",
      "photo_status": "exported",
      "qc_status": null,
      "created_at": "2024-03-12T17:07:55+01:00"
    }
  ]
}