Search Link customers
Searches active (not removed) customers in the caller's Link tenant. Use exactly one search mode per request, otherwise the request fails with 400 BAD_REQUEST:
- name — Link's own partial match on first or last name.
- identifier — exact match on the customer identifier (for example a Swedish personal identity number). Vetnio also tries the common spellings with and without century digits and hyphen, and merges the results.
- firstName and/or lastName — at least one with two or more characters. Vetnio queries Link with the longer term and keeps only customers whose first and last names contain the supplied values (case-insensitive).
Results are paginated with page (default 1) and perPage (1–100, default 100). total and sourceTotal count upstream Link rows, not filtered matches: the final field-aware match count is known only after all source pages are scanned, so keep requesting pages while hasNextPage is true to see every match.
Request
- Base URLhttps://vetnio.com/api/v2
- URLhttps://vetnio.com/api/v2/workspaces/{workspaceId}/link/customers
- AuthHTTP bearer
Path parameters
Identifier of the clinic (workspace), as returned by GET /workspaces. The key's user must be a member of the clinic, or an admin of the organization it belongs to.
Query parameters
Legacy search: partial, case-insensitive match on the customer's first or last name, performed by Link. Use exactly one search mode: name, identifier, or firstName/lastName.
Exact customer identifier, typically a Swedish personal identity number. Vetnio also tries the common spellings (with or without century digits and hyphen) and merges the results.
Case-insensitive substring of the customer's first name. Combine with lastName; at least one of the two must have two or more characters.
Case-insensitive substring of the customer's last name.
1-based page of Link results.
Results per page, from 1 to 100.
Response
Paginated customer search results.
Example response
{
"customers": [
{
"id": 54967922,
"name": "Alex Morgan",
"firstName": "Alex",
"lastName": "Morgan",
"identifier": "198501011234",
"primaryEmail": "alex.morgan@example.com",
"primaryPhone": "0701234567"
}
],
"total": 3,
"sourceTotal": 3,
"page": 1,
"perPage": 100,
"scannedCount": 3
}Changes
No recorded changes to this operation across all 1 revision of this API.