COcollectly
patients

List patients

Changed on

Get/provide an information about patients.

get/practices/{practice_id}/patients

Request

  • Base URL
    sandbox.collectly.co/api/api/partners/v1 (relative, and the document’s source URL is not known)
  • URL
    sandbox.collectly.co/api/api/partners/v1/practices/{practice_id}/patients
  • Auth
    API key in header Authorization

Path parameters

practice_idstring required

Practice ID in which the requested resource exists

Query parameters

pageinteger

Page number of dataset

per_pageinteger

Custom page size of dataset

sortstring

String with a comma-separated list of parameters by which to sort the dataset. To specify a descending order, add a "-" character before the parameter. For example, ?sort=-created_at,id

Response

OK

card_auth_on_fileboolean

The flag indicates if the patient has at least one payment method that is authorized for auto-pay

collectly_idstring

Unique Collectly resource ID

created_atunknown
current_balancenumber
date_of_birthstring date nullable
external_balancenumber
external_refnumstring nullable
first_namestring required
genderstring nullable

Allowed values: female, male, other

idstring required

Unique resource ID from your integration

last_namestring required
last_payment_datestring date-time

Date and time of the patient's last payment

metadataunknown
middle_namestring nullable
modified_atunknown
on_payment_planboolean

The flag indicates if the patient has an active payment plan

pausedboolean nullable
practice_idstring required
ssnstring nullable

Changes