GET companies/{companyId}/reports
Returns all available reports for a Company
Information:
The Cova Reporting API guide contains critical information regarding parameter processing.
Base URL:
https://api.covasoft.net/reporting
Example of a call would be:
https://api.covasoft.net/reporting/companies/{companyId})/reports
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| companyId |
The unique Company Id that was provided in your onboarding pacakage |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
All reports for a Company
Collection of ReportDefinition| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The unique identifier of the report. |
globally unique identifier |
None. |
| Name |
The name of the report. |
string |
None. |
| Description |
Description of the report. |
string |
None. |
| CreatedDateUtc |
The UTC date that the report was created. This attribute is readonly and will be ignored if provided on POST and PUT. |
date |
None. |
| Category |
Used to group reports into categories. |
string |
None. |
| Parameters |
Parameters that can be specified for this report. |
Collection of ReportParameter |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Id": "f8b6e798-4763-4668-8f2d-2595bcfd395a",
"Name": "sample string 2",
"Description": "sample string 3",
"CreatedDateUtc": "2025-11-21T14:57:23.6617582+00:00",
"Category": "sample string 5",
"Parameters": [
{
"Name": "sample string 1",
"Required": true,
"Label": "sample string 3",
"Options": [
{
"Id": {},
"Label": "sample string 2"
},
{
"Id": {},
"Label": "sample string 2"
}
],
"Multiple": true,
"DataType": "sample string 5"
},
{
"Name": "sample string 1",
"Required": true,
"Label": "sample string 3",
"Options": [
{
"Id": {},
"Label": "sample string 2"
},
{
"Id": {},
"Label": "sample string 2"
}
],
"Multiple": true,
"DataType": "sample string 5"
}
]
},
{
"Id": "f8b6e798-4763-4668-8f2d-2595bcfd395a",
"Name": "sample string 2",
"Description": "sample string 3",
"CreatedDateUtc": "2025-11-21T14:57:23.6617582+00:00",
"Category": "sample string 5",
"Parameters": [
{
"Name": "sample string 1",
"Required": true,
"Label": "sample string 3",
"Options": [
{
"Id": {},
"Label": "sample string 2"
},
{
"Id": {},
"Label": "sample string 2"
}
],
"Multiple": true,
"DataType": "sample string 5"
},
{
"Name": "sample string 1",
"Required": true,
"Label": "sample string 3",
"Options": [
{
"Id": {},
"Label": "sample string 2"
},
{
"Id": {},
"Label": "sample string 2"
}
],
"Multiple": true,
"DataType": "sample string 5"
}
]
}
]