GET v1/Clients/{clientId}/EFiles?facilityId={facilityId}&eFileApplicationReferenceId={eFileApplicationReferenceId}
Retrieves a list E-Files matching the provided parameters. The bytes of each E-File are not included.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientId |
Client identifier. |
globally unique identifier |
Required |
| facilityId |
The facility identifier. |
integer |
Required |
| eFileApplicationReferenceId |
The E-File Application Reference Id. Valid values can be retrieved from v1/Clients/{clientId}/References?type=EFileApplication. |
integer |
None. |
Body Parameters
None.
Response Information
Resource Description
The list of EFileListItemV1.
Collection of EFileListItemV1| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The E-File Id identifier. |
integer |
None. |
| FacilityId |
The Facility Id for the facility the E-File is associated with. |
integer |
None. |
| EFileApplicationReferenceId |
The E-File Application Reference Id. Valid values can be retrieved from v1/Clients/{clientId}/References?type=EFileApplication. |
integer |
None. |
| FileName |
The file name including file extension. |
string |
None. |
| DateOfFile |
The Date of the E-File. |
date |
None. |
| Description |
The file description. |
string |
None. |
| Tags |
The list of Tags to apply to the file. |
Collection of string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Id": 1,
"FacilityId": 2,
"EFileApplicationReferenceId": 3,
"FileName": "sample string 4",
"DateOfFile": "2025-12-04T19:36:58.7416369+00:00",
"Description": "sample string 5",
"Tags": [
"sample string 1",
"sample string 2"
]
},
{
"Id": 1,
"FacilityId": 2,
"EFileApplicationReferenceId": 3,
"FileName": "sample string 4",
"DateOfFile": "2025-12-04T19:36:58.7416369+00:00",
"Description": "sample string 5",
"Tags": [
"sample string 1",
"sample string 2"
]
}
]
application/xml, text/xml
Sample:
<ArrayOfEFile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Titan.API.Core.Models">
<EFile>
<DateOfFile>2025-12-04T19:36:58.7416369+00:00</DateOfFile>
<Description>sample string 5</Description>
<EFileApplicationReferenceId>3</EFileApplicationReferenceId>
<FacilityId>2</FacilityId>
<FileName>sample string 4</FileName>
<Id>1</Id>
<Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>sample string 1</d3p1:string>
<d3p1:string>sample string 2</d3p1:string>
</Tags>
</EFile>
<EFile>
<DateOfFile>2025-12-04T19:36:58.7416369+00:00</DateOfFile>
<Description>sample string 5</Description>
<EFileApplicationReferenceId>3</EFileApplicationReferenceId>
<FacilityId>2</FacilityId>
<FileName>sample string 4</FileName>
<Id>1</Id>
<Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>sample string 1</d3p1:string>
<d3p1:string>sample string 2</d3p1:string>
</Tags>
</EFile>
</ArrayOfEFile>