Create Report

URL Expired

The URL for this request expired after 30 days.

PublicCreateReportDto

• name

  • Type: string
  • Required: Yes
  • Length: between 1 and 255
  • Description: Display name for the report.

• entityType

  • Type: string
  • Required: Yes
  • Enum: Allowed values: contact, deal, fundraising, investor, company.

Allowed:
contact
deal
fundraising
investor
company

• filters

  • Type: array of objects
  • Length: ≤ 50
  • Description: Stored filters that define what the report returns. Use the matching List Fields endpoint (deals/contacts/fundraising) to discover valid field_id values. Same shape as the aggregate endpoint filters.

• groupBy

  • Type: array of strings
  • Length: ≤ 5
  • Description: Optional. Field IDs the report should group by when rendered in the internal UI. Use the matching List Fields endpoint to discover valid IDs. Stored on the report; the public Get Report Data endpoint currently returns flat rows regardless of this setting.

• pipelineId

  • Type: string
  • Description: Only used when entityType is deal.

• columns

  • Type: array of strings
  • Length: ≤ 200
  • Description: Optional. Field IDs to display as columns, in order. Each id is expanded server-side into a full ag-grid column definition using the field's type, label, and options. Use the matching List Fields endpoint to discover valid IDs.

• permissionType

  • Type: string

  • Enum

  • Description: Optional. Sharing scope of the new report. Defaults to the platform default (typically organization-wide).

    Allowed:
    share
private

Response Codes

• 200
  Report created

• 400
  Invalid request parameters

• 401
  Invalid or missing API key

• 500
  Internal server error

Example curl Command

curl --request POST \
     --url https://crm-public-api.app.carta.com/v1/reports \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '\n{\n  "entityType": "contact"\n}\n' 

API Response Codes

• 200
• 400
• 401
• 500