Search Appointment Tasks

POST

https://api.ferry.health/api/v1/appointment-tasks/search

POST

/api/v1/appointment-tasks/search

1 import requests
2 
3 url = "https://api.ferry.health/api/v1/appointment-tasks/search"
4 
5 payload = {
6     "filter": { "patientId": "ferry.patient.84396f99-a7d1-44f9-ae8b-01741931269e" },
7     "pagination": {
8         "page": 0,
9         "pageSize": 10
10     }
11 }
12 headers = {
13     "Authorization": "Bearer <token>",
14     "Content-Type": "application/json"
15 }
16 
17 response = requests.post(url, json=payload, headers=headers)
18 
19 print(response.json())

Try it

200Search appointment tasks

1 {
2   "appointmentTasks": [
3     {
4       "status": "FINDING_APPOINTMENT_OPTIONS",
5       "createdAt": "2025-08-06T16:54:21.000Z",
6       "id": "ferry.task-appointment.a3327c6c-1cc2-4f56-a137-6c457550a04e",
7       "isCanceled": false,
8       "patient": {
9         "id": "ferry.patient.84396f99-a7d1-44f9-ae8b-01741931269e",
10         "phoneNumber": "+12234567890",
11         "firstName": "John",
12         "lastName": "Doe",
13         "dateOfBirth": "1980-01-01",
14         "gender": "MALE",
15         "address": "123 Main St, Anytown, CA",
16         "hasOnboarded": true,
17         "insurancePlanName": "Aetna - Managed Choice Open Access",
18         "insurancePlanMemberId": "123456789"
19       },
20       "task": {
21         "providerSpecialty": "Gastroenterologist",
22         "reasonForVisit": "Ulcerative Colitis",
23         "timeFrame": "Within the next month",
24         "distanceInMiles": 5
25       }
26     }
27   ],
28   "pagination": {
29     "page": 0,
30     "pageSize": 10,
31     "itemsInPage": 1,
32     "totalItems": 1
33   }
34 }

Search appointment tasks.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

filterobjectOptional

The filter to apply to the search.

paginationobjectOptional

The pagination input.

Response

This endpoint returns an object.

appointmentTaskslist of objects

A single page of appointment tasks

paginationobject

The pagination data.