---
title: "Match Guest Parameters with existing applicants"
method: GET
path: "/v3/diary/{shortname}/{branchID}/guest/search"
tags: ["DiaryController"]
---

# Match Guest Parameters with existing applicants

`GET /v3/diary/{shortname}/{branchID}/guest/search`

## Request

- Base URL: `https://live-api.letmc.com`
- URL: `https://live-api.letmc.com/v3/diary/{shortname}/{branchID}/guest/search`
- Auth: none declared
- TypeScript: <https://skmtc.dev/letmc/apis/agentos-api-v3-diary-call-group/docs/v3/diary/:shortname/:branchID/guest/search/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `shortname` string, required
- `branchID` string, required

## Query parameters

- `forename` string, required
- `emailaddress` string, required
- `surname` string, required
- `offset` integer, required
- `count` integer, required

## Response `200`

OK

- GuestDiaryParametersResultsModel: Contacts Person Model Results:-
  - `Data` GuestDiaryParametersModel[]: Results data:-
    - `OID` string: Guest OID
    - `Forename` string: Guest Forename
    - `Surname` string: Guest Surname
    - `ContactMobile` string: Guest Mobile Phone
    - `EmailAddress` string: Guest Email Address
  - `Count` integer: Results count:-
  - `Links` BaseHypermediaLink[]: Results links:-
    - `Relationship` string: The hypermedia link relationship to current result object.
    - `Href` string: The hypermedia href
    - `Method` string: The http method type

---

[API](https://skmtc.dev/letmc/apis/agentos-api-v3-diary-call-group.md) - [All operations](https://skmtc.dev/letmc/apis/agentos-api-v3-diary-call-group/llms.txt) - [OpenAPI document](https://skmtc.dev/letmc/apis/agentos-api-v3-diary-call-group/revisions/9e518bf9a2f6?raw)