Tross
EZDERM

List lab recipients

List active address book contacts for labs.

POSThttps://api.ontross.com/api/integrations/ezderm/list-lab-recipients
Request Fields
input.query
string
Optional case-insensitive recipient name filter.
Example
"laboratory"
auth_id
string
required
Saved connection to run this operation through, from the Authentication page. It decides which practice and login the call uses.
Example
"00000000-0000-4000-8000-000000000000"
Output Fields
recipients
array
Active address book contacts matching the optional label filter.
recipients[].id
string
Active address book contact UUID accepted when placing orders.
Example
"b72d163e-508a-4ef9-b682-9c37af5410de"
recipients[].name
string
Server contact label used for optional substring filtering.
Example
"Northside Reference Laboratory"
recipients[].address_book_type
string
Server contact category, not restricted to laboratories by this handler.
Example
"COMPANY"
total
integer
Number of contacts returned after applying the optional filter.
Example
3
Code
curl --request POST \
  --url https://api.ontross.com/api/integrations/ezderm/list-lab-recipients \
  --header 'X-API-Key: REPLACE_KEY_VALUE' \
  --header 'content-type: application/json' \
  --data '{"input":{"query":"laboratory"},"auth_id":"auth_uuid_here"}'
Request BODY
{
  "input": {
    "query": "laboratory"
  },
  "auth_id": "auth_uuid_here"
}
Response BODY
{
  "id": "string",
  "workflow_id": "string",
  "auth_id": "string",
  "status": "string",
  "input": {},
  "output": {
    "recipients": [
      {
        "id": "b72d163e-508a-4ef9-b682-9c37af5410de",
        "name": "Northside Reference Laboratory",
        "address_book_type": "COMPANY"
      }
    ],
    "total": 3
  },
  "files": null,
  "created_at": "2019-08-24T14:15:22Z",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z"
}