List generated reports

Retrieve a list of generated reports.

You can use query parameters to filter, sort, and paginate the results.

GET /billing/org/v1/reports

List generated reports

cURL

curl --request GET \
  --url https://api.gcore.com/billing/org/v1/reports \
  --header 'Authorization: <api-key>'

200

{
  "count": 123,
  "results": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "user_id": 123,
      "client_id": 123,
      "status": "Pending",
      "processing_notes": {
        "celery_group_id": "<string>",
        "period": "<string>",
        "records_to_process": 123,
        "errors": [
          {}
        ],
        "warnings": [
          {}
        ]
      },
      "parameters": {
        "type": "<string>",
        "date_from": "2023-12-25",
        "date_to": "2023-12-25",
        "client_id": 123
      }
    }
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234_abcdef

Query Parameters

client_id · integer

created_after · string<date-time>

Filter by creation date-time.

Returns items created after the specified date-time (ISO 8601/RFC 3339 format, UTC.)

You can specify a date with a time separated by a space, or just a date.

Examples:

• &created_after=2025-05-15
• &created_after=2025-05-15 12:00:00
• &created_after=2025-05-15T12:00:00Z

created_before · string<date-time>

Filter by creation date-time.

Returns items created before the specified date-time (ISO 8601/RFC 3339 format, UTC.)

You can specify a date with a time separated by a space, or just a date.

Examples:

• &created_before=2025-05-15
• &created_before=2025-05-15 12:00:00
• &created_before=2025-05-15T12:00:00Z

created_on · string<date>

limit · integer

Number of results to return per page. Maximum is 100. Default is 20.

offset · integer

The initial index from which to return the results.

order_by · enum<string>[]

Ordering of the results.

For ascending sort order use field.asc, for descending sort order use field.desc.

For sorting by multiple parameters write them as comma separated string: client_id.asc,id.desc.

Final stable tiebreak ordering is added except when pk sorting used.

• uuid.asc - Uuid
• uuid.desc - Uuid (descending)
• created_at.asc - Created at
• created_at.desc - Created at (descending)
• client_id.asc - Client id
• client_id.desc - Client id (descending)
• task_type.asc - Task type
• task_type.desc - Task type (descending)
• status.asc - Status
• status.desc - Status (descending)
• template.asc - Template
• template.desc - Template (descending)

Available options: client_id.asc, client_id.desc, created_at.asc, created_at.desc, status.asc, status.desc, task_type.asc, task_type.desc, template.asc, template.desc, uuid.asc, uuid.desc

ordering · enum<string>[]

Ordering of the results.

This field is left for compatibility and can be deprecated in future versions. Use order_by instead.

Default sort order is ascending. Put - before value for descending sort order: -id.

For sorting by multiple parameters write them as comma separated string: -client_id,id.

Final stable tiebreak ordering is added except when pk sorting used.

• uuid - Uuid
• -uuid - Uuid (descending)
• created_at - Created at
• -created_at - Created at (descending)
• client_id - Client id
• -client_id - Client id (descending)
• task_type - Task type
• -task_type - Task type (descending)
• status - Status
• -status - Status (descending)
• template - Template
• -template - Template (descending)

Available options: -client_id, -created_at, -status, -task_type, -template, -uuid, client_id, created_at, status, task_type, template, uuid

status · enum<string>[]

Filter by file task statuses. Can be multiple.

• Pending - pending
• InProgress - in_progress
• Completed - completed
• Failed - failed
• Cancelled - cancelled

Available options: Cancelled, Completed, Failed, InProgress, Pending

template · string

Filter by the type of the report template. Allows partial matches.

uuid · string

Filter by task UUID. Supports partial matches starting from the beginning.

Response

200

application/json

Request successful.

count · integer · required

Example:

123

results · object[] · required

Show child attributes

next · string<uri> | null

Example:

"http://api.example.org/accounts/?offset=400&limit=100"

previous · string<uri> | null

Example:

"http://api.example.org/accounts/?offset=200&limit=100"