Retrieves all documents associated with a member

GET /api/members/{memberId}/documents

Success: 200 OK

Products: Operator (FOH), Consumer (CONSUMER) (any one of these products, not all)
Features: Online Bookings (ONLINEBOOK), Online Joining (ONLINEJOIN), Front of House Generic Access (FOHGENERIC) (any one of these features, not all)

Overview

Lists the documents held against a member — contracts, health forms, direct debit mandates, uploaded photos of ID and so on — as metadata only.

No download link is returned by this call. Despite the fileLink field appearing in the response shape, it is never populated here. To download a document, take its id from this list and call Retrieve a document associated with a member, which mints a short-lived link.

Two filters are applied silently, so the same member can see a different list depending on who asks:

When the caller is a member — the token identifies a member rather than a staff user — only documents flagged as member-visible are returned. A staff or integration token sees everything, including documents deliberately withheld from the member.
Unconfirmed direct debit mandates are always hidden, from everyone. A mandate appears in this list only once it has been confirmed.

The list is never paginated and has no filtering parameters; a member with no documents returns an empty array with 200, not a 404.

Endpoint

GET {base_url}/api/members/{memberId}/documents

{base_url} is the environment URL issued to your integration. See Authenticating with Gladstone APIs.

Path parameters

Name	Type	Required	Description
`memberId`	integer (int32)	Yes	The member whose documents are listed. Must match the member id in your access token; linked members are not accepted, so a primary member cannot list a linked member's documents.

Sample request

cURL

curl -X GET '{base_url}/api/members/{memberId}/documents' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'X-Use-SSO: true'

Response fields

Field	Type	Description
`[].id`	integer (int32)	The document's id. Pass it to Retrieve a document associated with a member to obtain a download link.
`[].name`	string	The document's subject line — the human-readable title staff gave it when uploading, not the file name.
`[].documentTypeId`	integer (int32)	The numeric id of the document type this document was filed under.
`[].documentTypeName`	string	The document type's display description, suitable for showing to a user.
`[].documentTypeKey`	string	The document type's stable code, which is what to branch on in your integration — display names are editable by the tenant, keys are not.
`[].fileName`	string	The file name to present for download. This is the original name the file was uploaded with where one was recorded, falling back to the stored file name otherwise, so it is not necessarily unique.
`[].isSensitive`	boolean	Marks the document as sensitive, for your own display and handling decisions. It does not filter this list — the member-visibility flag does that.
`[].dateValidTo`	string (date-time)	When the document stops being valid, for documents that expire such as a medical certificate. `null` means it does not expire. Nothing in the platform hides or rejects an expired document, so check it yourself.
`[].dateAdded`	string (date-time)	When the document was added to the member's record. Always present.
`[].isMemberVisible`	boolean	Whether the member is allowed to see this document. Always `true` in the results a member-scoped token receives, since anything else has already been filtered out; useful when calling with a staff token to see what the member can see.
`[].fileLink`	string	Always `null` in this response — the download link is only generated by the single-document endpoint. Do not build against a value here.

Sample response

200 OK

[
  {
    "id": 12345,
    "name": "string",
    "documentTypeId": 12345,
    "documentTypeName": "string",
    "documentTypeKey": "string",
    "fileName": "string",
    "isSensitive": true,
    "dateValidTo": "2026-08-14T19:00:00Z",
    "dateAdded": "2026-08-14T19:00:00Z",
    "isMemberVisible": true,
    "fileLink": "string"
  }
]

Errors

Status	Meaning	When
`400`	Bad request	Not returned by this endpoint.
`404`	Not found	No member exists with that id: `The member with the ID {memberId} doesn't exist`
`500`	Internal server error	An unexpected server-side failure. No detail is returned in the body.

This page as markdown · All pages · llms.txt