Skip to main content
POST
Filter 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 uses it to scope recipient filtering and upload lookups to the current client.

Body

application/json
filter_groups
object[] | null

Optional advanced filter groups from the file-management UI.

page
integer | null

Optional page number for result pagination.

Example:

1

per_page
integer | null

Optional page size for result pagination.

Example:

25

Response

Filtered recipients and file counts.

entities
object[]
total
integer
Example:

25

total_files
integer
Example:

73

title_field_definitions
object[]
applied_filters
object