Skip to main content
GET
Search recipient files in a program

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

program_id
integer
required

Required program ID. The controller limits matching recipients and uploads to this program for the current client.

Query Parameters

q
string | null

Optional search text from the file UI. The controller applies it to recipient title fields and related file metadata when present.

Response

Matching recipients and file counts.

entities
object[]
total
integer
Example:

25

total_files
integer
Example:

73

page
integer
Example:

1

per_page
integer
Example:

25

title_field_definitions
object[]