Export Organization Data

This endpoint generates a credit consumption history report for a specific organization, identified by the orgUuid path parameter. When triggered, the report is compiled and sent to the organization's registered email address. This operation is useful for tracking and auditing credit usage within your organization.

HTTP Method and URL

POST {{host}}/api/v2/organizations/:orgUuid/export

Authentication

This endpoint requires authentication. Include a valid user-token in the request headers. Ensure your token has the necessary permissions to access organization-level reports.

Required Parameters

• Path Variable:
  • orgUuid (string, required): The unique identifier of the organization whose credit consumption report you want to export.

Request Body

No request body parameters are required for this endpoint.

Example Success Response

{
  "message": "Credit consumption report export initiated. The report will be sent via email."
}

Example Error Response

{
  "message": "Invalid organization UUID or insufficient permissions."
}

Usage Notes

• Ensure the orgUuid provided is correct and that your account has access to the specified organization.

• The response message indicates whether the export process has started successfully. The actual report will be delivered via email.

• If you encounter authentication errors, verify your user-token and permissions.