Skip to main content
POST
Create a report run

Authorizations

Authorization
string
header
required

You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>. These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.

Body

application/json
reportCode
string
required

The unique code of the report.

parameters
object
required
workspaceId
string<uuid> | null

Unique identifier of a workspace in Payrails.

Response

Accepted.

id
string<uuid>
required

The unique identifier of the report run.

createdAt
string<date-time>
required

Time at which the reportRun was created.

parameters
object
required
status
enum<string>
required

The status of the report run.

Available options:
pending,
successful,
failed
workspaceId
string<uuid>

Unique identifier of a workspace in Payrails.

report
object
result
object | null

If the report run is successful (i.e. status=successful), the details about the generated report file.

error
string | null

If the report run fails (i.e. status=failed), a message about the failure.

completedAt
string<date-time> | null

The time at which the report run completes.

Last modified on October 1, 2026