--- title: Pigment API Integration on Truto slug: pigment category: Business Intelligence canonical: "https://truto.one/integrations/detail/pigment/" --- # Pigment API Integration on Truto **Category:** Business Intelligence **Status:** Beta ## MCP-ready AI tools Truto exposes 19 tools for Pigment that AI agents can call directly. - **list_all_pigment_data_flows** — List the Data Flows configured in a Pigment application. Returns: dataFlowId, name, description, application_id, steps. Required: application_id. - **create_a_pigment_data_flow_trigger** — Trigger an execution of a Data Flow in Pigment. Returns: dataFlowExecutionId. Required: dataFlowId. 400 if the Data Flow has no runnable steps; 429 if too many concurrent executions are already running. - **create_a_pigment_push_csv** — Push a CSV file to a Pigment import configuration. The import starts asynchronously and Returns: importId. Required: configuration_id, file. - **create_a_pigment_push_looker** — Trigger a Looker Look import in Pigment. Pigment pulls the Look data and runs the import asynchronously. Returns: importId. Required: configuration_id. - **list_all_pigment_import_configurations** — List Pigment import configurations for the given application and block. Returns: id, name. The returned id is the configurationId needed to trigger imports or push data. - **create_a_pigment_import_trigger** — Trigger an automated import operation in Pigment for an integration-based import, list data copy or metric data copy; the pipeline type is detected from the configuration. Returns: importId. Required: configuration_id. - **list_all_pigment_applications** — List metadata for every Pigment Application in the Workspace associated with the API key. Returns each application's id (UUID) and name — the values used to scope the other Pigment metadata calls. The source documents no additional fields or filters for this endpoint. - **list_all_pigment_applications_snapshots** — List metadata for all application snapshots in Pigment, including scheduled, in progress and failed ones. Returns: id, name, status, date, applications. - **list_all_pigment_blocks** — List Pigment block metadata (metrics, lists, and tables) for an application. Returns: id, name, type. - **get_single_pigment_export_view_by_id** — Export the data of a specific Pigment view as a CSV file. Returns the view's data as a CSV file (text/csv). Optional date_format (Legacy or Iso8601) and field_delimiter (Semicolon or Comma) control output formatting. Fails with 413 if the view is too big (use block export APIs instead) or 422 if the view type is not…. Required: id. - **create_a_pigment_export_list** — Export the data of a specific Pigment list as a CSV file. Returns the exported list data as a CSV file (text/csv). An optional ListRequest JSON body refines the export; sending {} accepts the list's defaults. Required: list_id. - **create_a_pigment_export_metric** — Export the data of a specific Pigment metric as CSV. Returns the exported data as a CSV file (text/csv). The optional MetricRequest JSON body refines the export; omit it or send an empty object to accept upstream defaults. Required: metric_id. - **create_a_pigment_export_table** — Export the data of a specific Pigment table as a CSV file. Returns the table's exported data as a CSV file (text/csv), not a JSON object, so its contents are content-type-specific. Optional TableRequest body refines the export; an empty {} body accepts defaults. Required: table_id. - **list_all_pigment_files** — List the file metadata of a Pigment application with cursor-based pagination. Returns: organizationId, application_id, id, displayFilename, contentType, mimeType, sizeBytes, uploadedBy, uploadedAt. Required: application_id. - **create_a_pigment_file** — Upload a file to a Pigment application as multipart form-data. Returns the uploaded file's metadata: id, displayFilename, contentType, sizeBytes, uploadedAt. Required: application_id, file. - **get_single_pigment_content_by_id** — Download a file's content from a Pigment application. Returns the raw file bytes (binary download, not a JSON object). Required: id, application_id. - **list_all_pigment_views** — List view metadata for a block in Pigment. Returns: id, name, type. Use the returned view ids with the view export endpoint. - **get_single_pigment_data_flow_status_by_id** — Get the status of a Data Flow execution in Pigment. Returns: dataFlowExecutionId, dataFlowId, status, createdAt, completedAt, steps. Status is InProgress, Completed, PartialFailure, or Failed. Required: id. Rate limited — on 429, retry after the Retry-After delay. - **get_single_pigment_import_status_by_id** — Get the status of a csv import, integration import, list data copy or metric data copy operation in Pigment by id. Returns: importId, createdAt, completedAt, importStatus, errorsDetails, detailedReport. Required: id. Set included_detailed_report=true for summary statistics; defaults to false. ## How it works 1. **Link your customer's Pigment account.** Use Truto's frontend SDK; we handle every OAuth and API key flow so you don't need to create the OAuth app. 2. **Authentication is automatic.** Truto refreshes tokens, stores credentials securely, and injects them into every API request. 3. **Call Truto's API to reach Pigment.** The Proxy API is a 1-to-1 mapping of the Pigment API. 4. **Get a unified response format.** Every response uses a single shape, with cursor-based pagination and data in the `result` field. ## Use cases - **Sync HRIS Actuals into Pigment for Headcount Planning** — HRIS and payroll platforms can offer customers a native way to push monthly employee census, salary, and benefits data into Pigment, so FP&A teams can run headcount and compensation forecasts without manual CSV handoffs. - **Enforce Live Budgets in Spend Management Tools** — Spend management and procurement platforms can pull approved departmental budgets directly from Pigment metrics, letting their product flag or block purchase requests that exceed real-time, FP&A-approved limits. - **Provision Sales Quotas from Pigment Models** — Commission and sales performance tools can extract finalized territory maps and quota lists from Pigment, automatically provisioning new comp plans the moment the CRO finalizes capacity modeling. - **Close the Loop on Marketing Spend and Pipeline** — Marketing operations and attribution platforms can push campaign spend and pipeline actuals into Pigment, enabling Finance to dynamically model marketing ROI and adjust budgets without waiting for quarter-end reconciliation. - **Orchestrate Model Recalculations After Data Loads** — Workflow and iPaaS-style products can push operational data into Pigment and immediately trigger data flows to recalculate downstream financial models, giving customers always-fresh forecasts. ## What you can build - **Dynamic Pigment Schema Mapper** — Use list_all_pigment_applications, list_all_pigment_blocks, and list_all_pigment_views to render in-product dropdowns so end users map their fields directly to their own Pigment application structure. - **Async Bulk CSV Push Pipeline** — Ship a background job that calls create_a_pigment_push_csv (or create_a_pigment_file plus create_a_pigment_import_trigger) against a selected import configuration, with polling on get_single_pigment_import_status_by_id to surface row-level errors. - **Data Flow Trigger & Status Monitor** — Let customers kick off Pigment data flows via create_a_pigment_data_flow_trigger after each sync and display live recalculation status using get_single_pigment_data_flow_status_by_id. - **Scheduled Metric & List Exports** — Build recurring exports using create_a_pigment_export_metric, create_a_pigment_export_table, and create_a_pigment_export_list to pull approved budgets, quotas, or forecasts into your product on a schedule. - **Looker-Backed Push Jobs** — For customers with Looker as a source, expose create_a_pigment_push_looker so they can ingest Looker-derived datasets into Pigment import configurations without a separate ETL layer. - **Import Configuration Browser** — Use list_all_pigment_import_configurations and list_all_pigment_data_flows to let admins pick exactly which import target and downstream flow should run for each sync they configure. ## FAQs ### How do end users authenticate their Pigment account? Truto handles the Pigment auth handshake and token storage for you. Your product only needs to launch Truto's connect flow — credentials, refresh, and secure storage are managed on our side. ### Can we push large datasets without hitting synchronous timeouts? Yes. Pigment's import endpoints are asynchronous. You use create_a_pigment_push_csv or create_a_pigment_file + create_a_pigment_import_trigger to submit the data, then poll get_single_pigment_import_status_by_id for completion and row-level errors. ### Can we trigger model recalculations after pushing data? Yes. After an import completes, call create_a_pigment_data_flow_trigger to run the relevant data flow and get_single_pigment_data_flow_status_by_id to monitor the compute job until it finishes. ### How do we read planning data back out of Pigment? Use create_a_pigment_export_metric, create_a_pigment_export_table, or create_a_pigment_export_list with a JSON body that specifies the dimensions you need. Pigment returns structured CSV output you can parse downstream. ### How do we handle customers with different Pigment model structures? Call list_all_pigment_applications, list_all_pigment_blocks, list_all_pigment_views, and list_all_pigment_import_configurations at setup time to discover each tenant's schema, then let the end user map their fields against it in your UI. ### Is there a unified BI API we can use instead of Pigment-specific calls? Not currently. Pigment is available as a native integration with dedicated tools covering imports, exports, data flows, and schema discovery. If you need a unified BI abstraction, reach out and we can prioritize it based on your use case. ## Related reading - [Connect Pigment to Claude: Sync Model Data and Manage Import Jobs](https://truto.one/blog/connect-pigment-to-claude-sync-model-data-and-manage-import-jobs/) — Learn how to connect Pigment to Claude using a managed MCP server. Execute async data flows, manage Looker/CSV imports, and extract financial models using natural language. - [Connect Pigment to ChatGPT: Automate Planning and Export Model Data](https://truto.one/blog/connect-pigment-to-chatgpt-automate-planning-and-export-model-data/) — Learn how to connect Pigment to ChatGPT using a managed MCP server. This step-by-step guide covers how to execute data flows, push CSV imports, and export Pigment model data using natural language. - [Connect Pigment to AI Agents: Trigger Data Flows and Manage Snapshots](https://truto.one/blog/connect-pigment-to-ai-agents-trigger-data-flows-and-manage-snapshots/) — Learn how to connect Pigment to AI agents using Truto's tools endpoint. Build autonomous workflows to trigger data flows, poll jobs, and manage snapshots.