Run Report

Not yet available

This endpoint is reserved for future use. It does not run reports yet. It ignores the request and returns a fixed placeholder text response. Do not build an integration on it.

This page describes how the endpoint behaves today.

Endpoint

POST /v1/reports/reports/run

Authentication

Include your API key in the x-api-key header. See Authentication.

Required Scope

reports:run

Request Body

This endpoint does not read a request body. No report types or report parameters are accepted.

Example Request

cURL

curl -X POST "https://api.crewsum.com/v1/reports/reports/run" \
  -H "x-api-key: $CREWSUM_API_KEY"

JavaScript

const response = await fetch("https://api.crewsum.com/v1/reports/reports/run", {
  method: "POST",
  headers: { "x-api-key": process.env.CREWSUM_API_KEY },
});
const result = await response.text();

HTTP

POST /v1/reports/reports/run HTTP/1.1
Host: api.crewsum.com
x-api-key: <your-api-key>

Response

The API returns HTTP 200 OK with a plain-text body (Content-Type: text/plain), not JSON.

Example Response

POST /reports/run

Behavior

• The response is always the same placeholder text. No report runs and no data is returned.
• The endpoint has no side effects.

Error Responses

This endpoint does not return its own errors.

Authentication and scope failures are described in Errors.

Related Webhooks

This endpoint does not trigger a webhook.