Skip to content
/
Search Documents

Search Documents

Request

Get a paginated list of documents for a subject.

Security
bearer
Query
pageNumbernumber

Page number to retrieve (1-based index)

Default:1
pageSizenumber

Number of items per page

Default:50
sortFieldstring

Field name to sort by

Default:"created"
sortIsDescendingboolean

Whether to sort in descending order

Default:false
subjectIdstring, (uuid)required
informationTypesArray of strings

Document Classifications (an Array of strings)

Headers
ProjectIdstring, (uuid)required
Example:e6b01018-a333-4732-917e-fe38e91b0fdf
GET
/api/v1/patient-registry/document
curl -i -X GET \
  'https://partner.xcures.com/api/v1/patient-registry/document?pageNumber=1&pageSize=50&sortField=created&sortIsDescending=false&subjectId=497f6eca-6276-4993-bfeb-53cbbbba6f08&informationTypes=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'ProjectId: e6b01018-a333-4732-917e-fe38e91b0fdf'

Responses

Bodyapplication/json
totalCountnumberrequired

Total number of items matching the query

resultsArray of objects(DocumentSummary)required

List of results for the current page

pageNumbernumber

Page number to retrieve (1-based index)

Default:1
pageSizenumber

Number of items per page

Default:50
sortFieldstring

Field name to sort by

Default:"created"
sortIsDescendingboolean

Whether to sort in descending order

Default:false
Response
{
  "pageNumber": 1,
  "pageSize": 50,
  "sortField": "created",
  "sortIsDescending": false,
  "totalCount": 0,
  "results": [
    { … }
  ]
}