Get

[POST] .../v1/report/get

Returns a list of report types. Use this method to discover report types before creating a queued report request with Report/AddRequest. The response returns active Report records with their report group and translated names for the current request language; the request supports id and group_id filters while ids and group_ids fields. The caller must have report-list permission 348 and missing body, denied access, translation or database errors and persistent failures are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.

Filterable Fields

Field Type Description
group_id int Report group IDs.
id int Report IDs.

Request Example

{
  "filters": [
    {
      "Field": "id",
      "Operator": "Equal",
      "Value": "5"
    },
    {
      "Field": "group_id",
      "Operator": "Equal",
      "Value": "2"
    }
  ]
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Array of Report Result object.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 5,
      "group": {
        "id": 2,
        "parent_id": 0,
        "name": "Sales reports",
        "name_var": "REPORT_GROUP_SALES",
        "last_update": 1772527200
      },
      "name": "Retail sales by item",
      "name_var": "REPORT_RETAIL_SALES_BY_ITEM",
      "last_update": 1772527200
    }
  ]
}