# Erguvan Docs

## Docs

- [Add activity](https://docs.azalt.co/api-reference/activity/add-activity.md): Create a new activity with automatic calculation:
- [Export activities data](https://docs.azalt.co/api-reference/activity/export-activities-data.md): Export activities data in CSV or Excel format:
- [Import multiple activities](https://docs.azalt.co/api-reference/activity/import-multiple-activities.md): Import multiple activities in bulk:
- [List activities](https://docs.azalt.co/api-reference/activity/list-activities.md): Retrieve activities for a specific form and activity type with flexible filtering:
- [Recalculate multiple activities](https://docs.azalt.co/api-reference/activity/recalculate-multiple-activities.md): Bulk recalculate activities with filtering:
- [Recalculate single activity](https://docs.azalt.co/api-reference/activity/recalculate-single-activity.md): Recalculate a specific activity's values:
- [Remove activities](https://docs.azalt.co/api-reference/activity/remove-activities.md): Delete multiple activities in one request:
- [Remove activities by filter](https://docs.azalt.co/api-reference/activity/remove-activities-by-filter.md): Delete activities by form element and filters:
- [Remove activity](https://docs.azalt.co/api-reference/activity/remove-activity.md): Delete a specific activity:
- [Update activity input](https://docs.azalt.co/api-reference/activity/update-activity-input.md): Update a specific activity's input data and recalculate its values:
- [Create activity definition](https://docs.azalt.co/api-reference/activitydefinition/create-activity-definition.md): Create a new activity definition template:
- [Generate calculation code for activity](https://docs.azalt.co/api-reference/activitydefinition/generate-calculation-code-for-activity.md): Generate JavaScript calculation code using AI:
- [Generate UI code for activity](https://docs.azalt.co/api-reference/activitydefinition/generate-ui-code-for-activity.md): Generate React component UI code using AI:
- [Get activity definition](https://docs.azalt.co/api-reference/activitydefinition/get-activity-definition.md): Retrieve a specific activity definition:
- [List activity definitions](https://docs.azalt.co/api-reference/activitydefinition/list-activity-definitions.md): Retrieve all available activity definitions:
- [Create API key](https://docs.azalt.co/api-reference/apikey/create-api-key.md): Create a new API key for programmatic access:
- [Delete API key](https://docs.azalt.co/api-reference/apikey/delete-api-key.md): Permanently delete an API key:
- [List API keys](https://docs.azalt.co/api-reference/apikey/list-api-keys.md): Retrieve all API keys for your organization:
- [Create benchmark](https://docs.azalt.co/api-reference/benchmark/create-benchmark.md): Create a new benchmark for comparison.
- [Delete benchmark](https://docs.azalt.co/api-reference/benchmark/delete-benchmark.md): Permanently delete a benchmark and all its associated entries.
- [Get benchmark](https://docs.azalt.co/api-reference/benchmark/get-benchmark.md): Retrieve a specific benchmark by its unique identifier.
- [List benchmarks](https://docs.azalt.co/api-reference/benchmark/list-benchmarks.md): Retrieve all benchmarks for the organization with optional filtering.
- [Update benchmark](https://docs.azalt.co/api-reference/benchmark/update-benchmark.md): Update an existing benchmark's properties and entries.
- [Create cron job](https://docs.azalt.co/api-reference/cron-jobs/create-cron-job.md): Create a new scheduled automation job:
- [Execute cron job manually](https://docs.azalt.co/api-reference/cron-jobs/execute-cron-job-manually.md): Manually trigger execution of a cron job:
- [Get cron job details](https://docs.azalt.co/api-reference/cron-jobs/get-cron-job-details.md): Get detailed information about a specific cron job:
- [Get execution details](https://docs.azalt.co/api-reference/cron-jobs/get-execution-details.md): Get complete details for a specific cron job execution:
- [List cron jobs](https://docs.azalt.co/api-reference/cron-jobs/list-cron-jobs.md): Get all scheduled automation jobs for your organization:
- [Create dashboard](https://docs.azalt.co/api-reference/dashboard/create-dashboard.md): Create a new dashboard:
- [Delete dashboard](https://docs.azalt.co/api-reference/dashboard/delete-dashboard.md): Permanently delete a dashboard and all its widgets:
- [Get dashboard](https://docs.azalt.co/api-reference/dashboard/get-dashboard.md): Get a specific dashboard by its ID:
- [List dashboards](https://docs.azalt.co/api-reference/dashboard/list-dashboards.md): Get all dashboards you have access to:
- [Update dashboard](https://docs.azalt.co/api-reference/dashboard/update-dashboard.md): Update an existing dashboard:
- [Create dataset](https://docs.azalt.co/api-reference/dataset/create-dataset.md): Create a new dataset to store coefficient data for environmental calculations. Requires owner permissions.
- [Delete dataset](https://docs.azalt.co/api-reference/dataset/delete-dataset.md): Permanently delete a dataset and all its coefficient data. Requires owner permissions.
- [List datasets](https://docs.azalt.co/api-reference/dataset/list-datasets.md): Retrieve all datasets available in your organization. Datasets contain coefficient data used for environmental calculations.
- [Create dataset item](https://docs.azalt.co/api-reference/datasetitem/create-dataset-item.md): Add a new coefficient value to a dataset. Requires owner permissions.
- [Delete dataset items](https://docs.azalt.co/api-reference/datasetitem/delete-dataset-items.md): Delete coefficient values from datasets. Requires owner permissions.
- [Export dataset items as CSV](https://docs.azalt.co/api-reference/datasetitem/export-dataset-items-as-csv.md): Export all coefficient values from a dataset as a CSV file for backup, sharing, or analysis.
- [Import dataset items from CSV](https://docs.azalt.co/api-reference/datasetitem/import-dataset-items-from-csv.md): Import coefficient values from a CSV file into a dataset. Requires owner permissions.
- [List dataset items](https://docs.azalt.co/api-reference/datasetitem/list-dataset-items.md): Retrieve all coefficient values from all datasets in your organization.
- [List items for a dataset](https://docs.azalt.co/api-reference/datasetitem/list-items-for-a-dataset.md): Get all coefficient values for a specific dataset, plus the dataset details.
- [Update dataset item](https://docs.azalt.co/api-reference/datasetitem/update-dataset-item.md): Update an existing coefficient value in a dataset. Requires owner permissions.
- [Create presigned URL for file upload](https://docs.azalt.co/api-reference/file/create-presigned-url-for-file-upload.md): Get a secure upload URL for sending files directly to cloud storage, avoiding server bandwidth limits.
- [Delete file](https://docs.azalt.co/api-reference/file/delete-file.md): Permanently delete a file from both the database and cloud storage. This action cannot be undone.
- [Get files by entity](https://docs.azalt.co/api-reference/file/get-files-by-entity.md): Get all files attached to a specific item (like a form submission or organization), with secure download links.
- [Create forms](https://docs.azalt.co/api-reference/form/create-forms.md): Create one or more new data collection forms with comprehensive configuration options. Requires site manager permissions.
- [Create forms from CSV](https://docs.azalt.co/api-reference/form/create-forms-from-csv.md): Bulk create multiple forms from a structured CSV template, ideal for large-scale deployments. Requires site manager permissions.
- [Delete forms](https://docs.azalt.co/api-reference/form/delete-forms.md): Permanently delete one or more forms and all associated data. Requires site manager permissions.
- [Duplicate form](https://docs.azalt.co/api-reference/form/duplicate-form.md): Create a copy of an existing form with all elements, configurations, and settings. Requires site manager permissions.
- [Get form](https://docs.azalt.co/api-reference/form/get-form.md): Retrieve a complete form configuration with all elements and settings for authenticated users.
- [Get form summary](https://docs.azalt.co/api-reference/form/get-form-summary.md): Generate a comprehensive summary of form data and submission status for a specific form-site-year combination.
- [Get public form](https://docs.azalt.co/api-reference/form/get-public-form.md): Retrieve a public form configuration for external data collection without authentication.
- [List forms](https://docs.azalt.co/api-reference/form/list-forms.md): Retrieve all forms accessible to the authenticated user within their organization and site permissions.
- [Submit public form](https://docs.azalt.co/api-reference/form/submit-public-form.md): Submit data to a public form without authentication, enabling external data collection.
- [Update form](https://docs.azalt.co/api-reference/form/update-form.md): Update an existing form's configuration, elements, and deployment settings. Requires site manager permissions.
- [List form elements](https://docs.azalt.co/api-reference/formelement/list-form-elements.md): Retrieve all available form element types and their configurations within the user's organization context.
- [List form elements by form ID](https://docs.azalt.co/api-reference/formelement/list-form-elements-by-form-id.md): Retrieve form elements attached to a specific form.
- [List form elements by form metadata](https://docs.azalt.co/api-reference/formelement/list-form-elements-by-form-metadata.md): Retrieve form elements by resolving the parent form using a metadata key-value pair.
- [Update form elements](https://docs.azalt.co/api-reference/formelement/update-form-elements.md): Bulk update form element configurations across multiple forms. Requires site manager permissions.
- [Approve, reject, or revert form element submission](https://docs.azalt.co/api-reference/formelementsubmission/approve-reject-or-revert-form-element-submission.md): Approve, reject, or revert a specific form element submission.
- [Bulk approve, reject, or revert form element submissions](https://docs.azalt.co/api-reference/formelementsubmission/bulk-approve-reject-or-revert-form-element-submissions.md): Bulk approve, reject, or revert all form element submissions for a specific form element within a form submission (site + year scope).
- [Export form element submissions](https://docs.azalt.co/api-reference/formelementsubmission/export-form-element-submissions.md): Export form element submissions data to various formats for analysis and reporting.
- [Get form element submission](https://docs.azalt.co/api-reference/formelementsubmission/get-form-element-submission.md): Retrieve a specific form element submission for a given form element, period unit, and form submission.
- [Import form element submissions](https://docs.azalt.co/api-reference/formelementsubmission/import-form-element-submissions.md): Import form element submissions data from external sources in bulk.
- [Preview form element submissions import](https://docs.azalt.co/api-reference/formelementsubmission/preview-form-element-submissions-import.md): Preview the years, row counts, and new form-site records that would be affected by a form element submissions import.
- [Create a form element submission comment](https://docs.azalt.co/api-reference/formelementsubmissioncomment/create-a-form-element-submission-comment.md): Create a comment on a form element submission. The comment is attributed to the authenticated user.
- [Delete a form element submission comment](https://docs.azalt.co/api-reference/formelementsubmissioncomment/delete-a-form-element-submission-comment.md): Delete a form element submission comment owned by the authenticated user.
- [List form element submission comments](https://docs.azalt.co/api-reference/formelementsubmissioncomment/list-form-element-submission-comments.md): List comments attached to a single form element submission. Requires access to the form, site, and organization for the referenced submission.
- [Update a form element submission comment](https://docs.azalt.co/api-reference/formelementsubmissioncomment/update-a-form-element-submission-comment.md): Update a form element submission comment owned by the authenticated user.
- [Check if form site exists](https://docs.azalt.co/api-reference/formsite/check-if-form-site-exists.md): Verify whether a form-site association exists for the given parameters.
- [Create form site association](https://docs.azalt.co/api-reference/formsite/create-form-site-association.md): Create a new association between a form and a site, enabling data collection.
- [Update form site associations](https://docs.azalt.co/api-reference/formsite/update-form-site-associations.md): Update the associations between forms and sites in bulk operations.
- [Delete form submission](https://docs.azalt.co/api-reference/formsubmission/delete-form-submission.md)
- [Get form submission counts](https://docs.azalt.co/api-reference/formsubmission/get-form-submission-counts.md)
- [Get form submissions](https://docs.azalt.co/api-reference/formsubmission/get-form-submissions.md): Retrieve form submissions with flexible identification options:
- [Recalculate public form submission scores](https://docs.azalt.co/api-reference/formsubmission/recalculate-public-form-submission-scores.md): Recalculate and persist scores for all submissions in a public form site.
- [Update form submission action plan](https://docs.azalt.co/api-reference/formsubmission/update-form-submission-action-plan.md): Create, update, or clear a follow-up action plan for a form submission.
- [Upsert form submission](https://docs.azalt.co/api-reference/formsubmission/upsert-form-submission.md): Create or update a form submission. You have flexible options for identifying forms, sites, and form elements:
- [Create import definition](https://docs.azalt.co/api-reference/import/create-import-definition.md): Create a new import definition:
- [Delete import definition](https://docs.azalt.co/api-reference/import/delete-import-definition.md): Delete an import definition:
- [Detect matching import definitions](https://docs.azalt.co/api-reference/import/detect-matching-import-definitions.md): Analyze column headers to find matching import definitions:
- [Execute import](https://docs.azalt.co/api-reference/import/execute-import.md): Execute an import and create form submissions:
- [Get import definition](https://docs.azalt.co/api-reference/import/get-import-definition.md): Retrieve a specific import definition by ID:
- [Get import details](https://docs.azalt.co/api-reference/import/get-import-details.md): Get detailed information about a specific import:
- [List import definitions](https://docs.azalt.co/api-reference/import/list-import-definitions.md): Retrieve all available import definitions:
- [List imports](https://docs.azalt.co/api-reference/import/list-imports.md): List import history for the organization:
- [Preview import results](https://docs.azalt.co/api-reference/import/preview-import-results.md): Preview the results of an import without saving:
- [Update import definition](https://docs.azalt.co/api-reference/import/update-import-definition.md): Update an existing import definition:
- [Create indicator](https://docs.azalt.co/api-reference/indicator/create-indicator.md): Create a new indicator with mathematical expression and configuration settings.
- [Delete indicator](https://docs.azalt.co/api-reference/indicator/delete-indicator.md): Delete an indicator and remove it from all associated calculations and references.
- [Get current values for indicators](https://docs.azalt.co/api-reference/indicator/get-current-values-for-indicators.md): Calculate and retrieve current values for multiple indicators based on the latest available data.
- [Get indicator](https://docs.azalt.co/api-reference/indicator/get-indicator.md): Retrieve detailed information about a specific indicator including its mathematical formula, units, and configuration.
- [Get indicator data with widget settings](https://docs.azalt.co/api-reference/indicator/get-indicator-data-with-widget-settings.md): Retrieve indicator data formatted specifically for dashboard widgets with customizable visualization settings.
- [Get indicators used in hierarchy](https://docs.azalt.co/api-reference/indicator/get-indicators-used-in-hierarchy.md): Retrieve all indicators that depend on or reference the specified indicator in their calculations.
- [List all indicators](https://docs.azalt.co/api-reference/indicator/list-all-indicators.md): Retrieve a list of all indicators available within the current site context.
- [Update indicator](https://docs.azalt.co/api-reference/indicator/update-indicator.md): Update an existing indicator's configuration, mathematical expression, or metadata.
- [Create organization](https://docs.azalt.co/api-reference/organization/create-organization.md): Create a new organization with the authenticated user as the owner.
- [Get current organization](https://docs.azalt.co/api-reference/organization/get-current-organization.md): Retrieve detailed information about the user's currently active organization.
- [Invite user to organization](https://docs.azalt.co/api-reference/organization/invite-user-to-organization.md): Send an invitation to a user to join the current organization with specified role and site access.
- [List organization users](https://docs.azalt.co/api-reference/organization/list-organization-users.md): Retrieve all users who are members of the current organization.
- [List user organizations](https://docs.azalt.co/api-reference/organization/list-user-organizations.md): Retrieve all organizations where the authenticated user has membership.
- [Resend user invitation](https://docs.azalt.co/api-reference/organization/resend-user-invitation.md): Resend an organization invitation email to a user who is currently in INVITED status.
- [Update current organization](https://docs.azalt.co/api-reference/organization/update-current-organization.md): Update the current organization's settings, configuration, and metadata.
- [Update user membership status](https://docs.azalt.co/api-reference/organization/update-user-membership-status.md): Activate or deactivate an existing organization user within the current manager's site scope.
- [Update user role and site assignment](https://docs.azalt.co/api-reference/organization/update-user-role-and-site-assignment.md): Modify an existing user's role and site assignments within the organization.
- [Get reminder status](https://docs.azalt.co/api-reference/reminderstatus/get-reminder-status.md): Return pending and overdue form tasks for active organization users.
- [Create site](https://docs.azalt.co/api-reference/site/create-site.md): Create a new site within the organizational hierarchy.
- [Delete site](https://docs.azalt.co/api-reference/site/delete-site.md): Delete a site and handle all associated data and relationships.
- [Import sites from CSV](https://docs.azalt.co/api-reference/site/import-sites-from-csv.md): Import multiple sites from a CSV file with validation and error reporting.
- [List sites](https://docs.azalt.co/api-reference/site/list-sites.md): Retrieve all sites accessible to the authenticated user within their organizational context.
- [Update site](https://docs.azalt.co/api-reference/site/update-site.md): Update an existing site's information, hierarchy, or configuration.
- [Create target](https://docs.azalt.co/api-reference/target/create-target.md): Create a new sustainability or performance target.
- [Delete target](https://docs.azalt.co/api-reference/target/delete-target.md): Permanently delete a target and all its associated target entries.
- [Get target](https://docs.azalt.co/api-reference/target/get-target.md): Retrieve a specific target by its unique identifier.
- [List targets](https://docs.azalt.co/api-reference/target/list-targets.md): Retrieve all targets for the organization with optional filtering.
- [Update target](https://docs.azalt.co/api-reference/target/update-target.md): Update an existing target's properties and target entries.
- [Create unit](https://docs.azalt.co/api-reference/unit/create-unit.md): Create a new measurement unit for the organization.
- [Delete unit](https://docs.azalt.co/api-reference/unit/delete-unit.md): Delete a measurement unit from the organization.
- [List units](https://docs.azalt.co/api-reference/unit/list-units.md): Retrieve all measurement units available to the organization.
- [Merge multiple units into one](https://docs.azalt.co/api-reference/unit/merge-multiple-units-into-one.md): Consolidate multiple units into a single unit with a new name.
- [Get current user's profile](https://docs.azalt.co/api-reference/user/get-current-users-profile.md): Retrieve the authenticated user's profile information.
- [Update current user's profile](https://docs.azalt.co/api-reference/user/update-current-users-profile.md): Update the authenticated user's profile information.
- [Create widget](https://docs.azalt.co/api-reference/widget/create-widget.md): Create a widget linked to a dashboard or report section. Provide exactly one scope identifier. Include layout fields when targeting dashboards.
- [Delete dashboard widget](https://docs.azalt.co/api-reference/widget/delete-dashboard-widget.md): Permanently delete a dashboard widget:
- [Get dashboard widget data](https://docs.azalt.co/api-reference/widget/get-dashboard-widget-data.md): Get calculated data for a dashboard widget:
- [List widgets](https://docs.azalt.co/api-reference/widget/list-widgets.md): Return widget configurations by providing either `dashboardId` or `reportSectionId` as query parameters.
- [Update dashboard widget](https://docs.azalt.co/api-reference/widget/update-dashboard-widget.md): Update a dashboard widget:
- [Activity](https://docs.azalt.co/en/concepts/activity.md): Calculated records created from ActivityDefinitions
- [ActivityDefinition](https://docs.azalt.co/en/concepts/activity-definition.md): Reusable calculation blueprints with custom logic and UI
- [Cron Job](https://docs.azalt.co/en/concepts/cron-job.md): Scheduled automation scripts that run at specified intervals within your organization.
- [Cron Job Execution](https://docs.azalt.co/en/concepts/cron-job-execution.md): Execution history records for cron job runs including logs, output, and timing.
- [Cron Job Variable](https://docs.azalt.co/en/concepts/cron-job-variable.md): Environment variables and encrypted secrets for cron job scripts.
- [Dashboard](https://docs.azalt.co/en/concepts/dashboard.md): Container of widgets with org-wide filters, visibility controls, and password-protected public sharing.
- [Dataset](https://docs.azalt.co/en/concepts/dataset.md): Containers for reference data used in calculations, dashboards, and forms
- [DatasetItem](https://docs.azalt.co/en/concepts/dataset-item.md): Rows inside a Dataset that hold coefficients and metadata
- [Form](https://docs.azalt.co/en/concepts/form.md): The container that defines structure, behavior, and deployment for data collection
- [FormElement](https://docs.azalt.co/en/concepts/form-element.md): Fields and UI components, with types, periods, and validation
- [FormElementSubmission](https://docs.azalt.co/en/concepts/form-element-submission.md): Individual field values with period handling, status, and attachments
- [FormSite](https://docs.azalt.co/en/concepts/form-site.md): Deployment of a form to a specific site and reporting year
- [FormSubmission](https://docs.azalt.co/en/concepts/form-submission.md): Submission container for a form at a specific site and year
- [Import](https://docs.azalt.co/en/concepts/import.md): Records of import executions that track bulk data ingestion into the system
- [ImportDefinition](https://docs.azalt.co/en/concepts/import-definition.md): Configurable data transformation rules for bulk importing external data into forms
- [ImportResult](https://docs.azalt.co/en/concepts/import-result.md): Per-site results from import executions with processed data and field mappings
- [Organization](https://docs.azalt.co/en/concepts/organization.md): Organization model, settings, membership, and access
- [Organization User](https://docs.azalt.co/en/concepts/organization-user.md): Membership record that links a User to an Organization with role, status, and site access.
- [Organization User Site](https://docs.azalt.co/en/concepts/organization-user-site.md): Junction table that grants site-level access to an Organization User (with hierarchy awareness).
- [Overview](https://docs.azalt.co/en/concepts/overview.md): An overview of how Azalt works
- [Site](https://docs.azalt.co/en/concepts/site.md): Hierarchy, schema, access, and operations
- [Target](https://docs.azalt.co/en/concepts/target.md): Goals for indicators with period-based entries, baseline support, and site or organization scope
- [Unit](https://docs.azalt.co/en/concepts/unit.md): Reusable measurement labels for forms and indicators
- [User](https://docs.azalt.co/en/concepts/user.md): Global identity, profile fields, and how Users interact with organizations in Azalt.
- [Widget](https://docs.azalt.co/en/concepts/widget.md): A single visualization configured for one indicator, with settings and an optional per-widget filter.
- [Introduction](https://docs.azalt.co/en/index.md): Welcome to the Erguvan API Docs
- [Quickstart](https://docs.azalt.co/en/quickstart.md): Build your first sustainability data collection system in 10 minutes
- [S3 Storage Configuration](https://docs.azalt.co/en/s3-storage.md): Configure S3-compatible storage for file uploads and downloads

## OpenAPI Specs

- [openapi.tr](https://app.azalt.co/api/v1/openapi.tr.json)
- [openapi](https://app.azalt.co/api/v1/openapi.json)