# List VBA Reports (deprecated)

Retrieves a list of all available VBA Reports.

Endpoint: GET /reports
Version: v1
Security: apiKeyAuth, bearerAuth

## Security:

  - `apiKeyAuth` (unknown)
    apiKey in header x-api-key

  - `bearerAuth` (unknown)
    http bearer JWT

## Header parameters:

  - `vbasoftware-database` (string, required)
    The target database name to query.

## Response 200:

  - `200` (unknown)
    Successfully retrieved the list of VBA reports.

## Response 200 fields (application/json):

  - `data` (array)

  - `data.reportDefinition_Key` (integer)
    Unique identifier for the report definition.

  - `data.report_ID` (string)
    ID of the report in VBASoftware, often used as a unique string identifier.

  - `data.vbaSoftware_Report_ID` (string)
    ID of the report in VBASoftware, often used as a unique string identifier.

  - `data.vbaReporting_Report_ID` (string)
    ID of the report in VBAReporting, often used as a unique string identifier.

  - `data.report_Name` (string)
    Name of the report.

  - `data.report_Category` (string)
    Category under which the report falls.

  - `data.report_Description` (string)
    Description of the report and its purpose.

  - `data.embed_Url` (string)
    URL for embedding the report in other applications.

  - `error` (object)

  - `error.detail` (string)
    A human-readable explanation specific to this occurrence of the problem.

  - `error.instance` (string)
    A URI reference that identifies the specific occurrence of the problem.It may
or may not yield further information if dereferenced.

  - `error.status` (integer)
    The HTTP status code([RFC7231], Section 6) generated by the origin server for
this occurrence of the problem.

  - `error.title` (string)
    A short, human-readable summary of the problem type.It SHOULD NOT change from
occurrence to occurrence of the problem, except for purposes of localization(e.g.,
using proactive content negotiation; see[RFC7231], Section 3.4).

  - `error.type` (string)
    A URI reference [RFC3986] that identifies the problem type. This specification
encourages that, when dereferenced, it provide human-readable documentation for
the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member
is not present, its value is assumed to be "about:blank".

  - `debug` (object)

  - `debug.activityID` (string, required)

## Response 401:

  - `401` (unknown)
    Unauthorized

## Response 403:

  - `403` (unknown)
    Forbidden. The x-api-key header is missing or not valid. The API gateway sends this response, not VBAPI, so the body is not the VBAPI envelope; see Errors and troubleshooting.

## Response 429:

  - `429` (unknown)
    Too many requests. The limit is 25 requests per second sustained, with bursts up to 50, per API key. Wait and retry with exponential backoff and jitter.