GEgetorchestra
Assets

List assets

Changed on

Retrieve a paginated list of assets for the workspace the credential resolves to.

Assets can be filtered by type, integration, integration account, workspace, database, schema, status, or asset ID. By default, results are sorted by created_in_integration in descending order.

get/assets

Request

  • Base URL
    https://app.getorchestra.io/api/engine/public
  • URL
    https://app.getorchestra.io/api/engine/public/assets
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getorchestra.io/oauth/authorize
      Token URL: https://app.getorchestra.io/oauth/token scopes: orchestra:read

Query parameters

asset_typestring

Filter by asset type. Comma-separated values are supported.

integration'AIRBYTE_CLOUD' | 'AIRBYTE_SERVER' | 'AIRFLOW' | 'ARCH' | 'ALTERYX_SERVER' | 'ANTHROPIC' | 'AWS_EC2' | 'AWS_ECS' | 'AWS_EMR' | 'AWS_EKS' | 'AWS_FIREHOSE' | 'AWS_GLUE' | 'AWS_LAMBDA' | 'AWS_RDS' | 'AWS_REDSHIFT' | 'AWS_S3' | 'AWS_BATCH' | 'AWS_BEDROCK' | 'AWS_SAGEMAKER' | 'AWS_SECRETS_MANAGER' | 'AWS_SES' | 'AWS_STEP_FUNCTIONS' | 'AZURE' | 'AZURE_CONTAINER_APPS' | 'AZURE_DATA_FACTORY' | 'AZURE_DATA_LAKE_STORAGE' | 'AZURE_KEY_VAULT' | 'AZURE_KUBERNETES_SERVICE' | 'AZURE_LOGIC_APPS' | 'AZURE_SYNAPSE_ANALYTICS' | 'AZURE_VM' | 'BAUPLAN' | 'BOOMI' | 'CDATA' | 'CENSUS' | 'CLICKHOUSE' | 'COALESCE' | 'COUNT' | 'DATADOG' | 'DATABRICKS' | 'DATAPROC' | 'DATAZEN' | 'DBT' | 'DBT_CORE' | 'DLT' | 'DOMO' | 'DREMIO' | 'DUCKDB' | 'EMAIL' | 'ESTUARY' | 'ETLEAP' | 'FABRIC' | 'FABRIC_SYNAPSE' | 'FIVETRAN' | 'FORTRA' | 'GCP_BIG_QUERY' | 'GCP_CLOUD_RUN' | 'GCP_CLOUD_FUNCTIONS' | 'GCP_CLOUD_STORAGE' | 'GCP_DATAFLOW' | 'GCP_DATAFORM' | 'GCP_DATASTREAM' | 'GCP_LOOKER' | 'GKE' | 'GITHUB_ACTIONS' | 'GOOGLE_CLOUD' | 'HEVO' | 'HEX' | 'HIGHTOUCH' | 'HTTP' | 'HUBSPOT' | 'INFORMATICA_IICS' | 'INFORMATICA_POWERCENTER' | 'KAFKA' | 'KEBOOLA' | 'KLEENE' | 'LIGHTDASH' | 'LINUX_SSH' | 'MARIADB' | 'MATILLION' | 'MATILLION_ETL' | 'METAPLANE' | 'MICROSOFT_TEAMS' | 'MICROSTRATEGY' | 'MONGODB' | 'MOTHERDUCK' | 'MYSQL' | 'N8N' | 'NIMBLE' | 'NOTION' | 'OMNI' | 'OPEN_AI' | 'ORCHESTRA' | 'PARADIME' | 'PAGER_DUTY' | 'PINECONE' | 'PORTABLE' | 'POSTGRES' | 'POWER_AUTOMATE' | 'POWER_BI' | 'PREFECT_CLOUD' | 'PYTHON' | 'QLIK' | 'QLIK_REPLICATE' | 'QUICKBOOKS' | 'RENDER' | 'RIVERY' | 'RUDDERSTACK' | 'SALESFORCE' | 'SAP' | 'SFTP' | 'SHAREPOINT' | 'SIGMA' | 'SISENSE' | 'SLACK' | 'SNOWFLAKE' | 'SNOWPLOW' | 'SODA' | 'SQL_MESH' | 'SQL_SERVER' | 'STITCH' | 'STREAMKAP' | 'TABLEAU_CLOUD' | 'TALEND_CLOUD' | 'THOUGHTSPOT' | 'TOBIKO_CLOUD' | 'TYPESAFE' | 'WEAVIATE' | 'WEBHOOK' | 'WELD' | 'WINDOWS_SSH'

Integration identifier.

integration_account_idstring nullable

Filter by the account identifier in the integration.

workspace_idstring nullable

Filter by integration workspace ID.

database_namestring nullable

Filter by database name.

schema_namestring nullable

Filter by schema name.

statusstring

Filter by status. Comma-separated values are supported where the parameter accepts multiple values.

asset_idsstring nullable

Filter by asset IDs. Provide comma-separated UUIDs for multiple values.

sort_column'asset_name' | 'asset_type' | 'status' | 'integration' | 'created_in_integration' | 'last_updated_in_integration'

Column used to sort assets.

sort_direction'asc' | 'desc'

Sort direction.

pageinteger

Page number. Must be greater than or equal to 1.

page_sizeinteger

Number of items per page. Defaults to 50; maximum 100.

Headers

X-Orchestra-Account-Idstring uuid4 nullable

Act on this account rather than the one the credential resolves to. Omit it to use the credential's own account. An API key is issued to a single account, so it may only name that account; an OAuth token may name any account its grant covers.

Response

Successful response.

pageinteger required
pageSizeinteger required
totalinteger required

Changes

  • e45165e7e223Revision changes
    • breaking

      removed the enum value CLAUDE from the property anyOf[subschema #1: IntegrationsEnum]/ of the query request parameter integration

    • warning

      removed the optional property // from the response with the status

    • warning

      added the new ANTHROPIC enum value to the /// response property for the response status

    • warning

      added the new ANTHROPIC enum value to the // response property for the response status

    • warning

      added the new AWS_BATCH enum value to the /// response property for the response status

    • warning

      added the new AWS_BATCH enum value to the // response property for the response status

    • warning

      added the new AWS_SES enum value to the /// response property for the response status

    • warning

      added the new AWS_SES enum value to the // response property for the response status

    • warning

      added the new AWS_STEP_FUNCTIONS enum value to the /// response property for the response status

    • warning

      added the new AWS_STEP_FUNCTIONS enum value to the // response property for the response status

    • warning

      added the new DREMIO enum value to the /// response property for the response status

    • warning

      added the new DREMIO enum value to the // response property for the response status

    • warning

      added the new HUBSPOT enum value to the /// response property for the response status

    • warning

      added the new HUBSPOT enum value to the // response property for the response status

    • warning

      added the new MARIADB enum value to the /// response property for the response status

    • warning

      added the new MARIADB enum value to the // response property for the response status

    • warning

      added the new MONGODB enum value to the /// response property for the response status

    • warning

      added the new MONGODB enum value to the // response property for the response status

    • warning

      added the new MYSQL enum value to the /// response property for the response status

    • warning

      added the new MYSQL enum value to the // response property for the response status

    • warning

      added the new N8N enum value to the /// response property for the response status

    • warning

      added the new N8N enum value to the // response property for the response status

    • warning

      added the new NOTION enum value to the /// response property for the response status

    • warning

      added the new NOTION enum value to the // response property for the response status

    • warning

      added the new QUICKBOOKS enum value to the /// response property for the response status

    • warning

      added the new QUICKBOOKS enum value to the // response property for the response status

    • warning

      added the new SALESFORCE enum value to the /// response property for the response status

    • warning

      added the new SALESFORCE enum value to the // response property for the response status

    • warning

      added the new SHAREPOINT enum value to the /// response property for the response status

    • warning

      added the new SHAREPOINT enum value to the // response property for the response status

    • warning

      added the new TYPESAFE enum value to the /// response property for the response status

    • warning

      added the new TYPESAFE enum value to the // response property for the response status

    • info

      the endpoint scheme security BearerAuthReadOnly was removed from the API

    • info

      added the new optional header request parameter X-Orchestra-Account-Id

    • info

      added the enum value ANTHROPIC to the property anyOf[subschema #1: IntegrationsEnum]/ of the query request parameter integration

    • info

      added the enum value AWS_BATCH to the property anyOf[subschema #1: IntegrationsEnum]/ of the query request parameter integration

    • info

      added the enum value AWS_SES to the property anyOf[subschema #1: IntegrationsEnum]/ of the query request parameter integration

    • info

      added the enum value AWS_STEP_FUNCTIONS to the property anyOf[subschema #1: IntegrationsEnum]/ of the query request parameter integration

    • info

      added the enum value DREMIO to the property anyOf[subschema #1: IntegrationsEnum]/ of the query request parameter integration

    • info

      added the enum value HUBSPOT to the property anyOf[subschema #1: IntegrationsEnum]/ of the query request parameter integration

    • info

      added the enum value MARIADB to the property anyOf[subschema #1: IntegrationsEnum]/ of the query request parameter integration

    • info

      added the enum value MONGODB to the property anyOf[subschema #1: IntegrationsEnum]/ of the query request parameter integration

    • info

      added the enum value MYSQL to the property anyOf[subschema #1: IntegrationsEnum]/ of the query request parameter integration

    • info

      added the enum value N8N to the property anyOf[subschema #1: IntegrationsEnum]/ of the query request parameter integration

    • info

      added the enum value NOTION to the property anyOf[subschema #1: IntegrationsEnum]/ of the query request parameter integration

    • info

      added the enum value QUICKBOOKS to the property anyOf[subschema #1: IntegrationsEnum]/ of the query request parameter integration

    • info

      added the enum value SALESFORCE to the property anyOf[subschema #1: IntegrationsEnum]/ of the query request parameter integration

    • info

      added the enum value SHAREPOINT to the property anyOf[subschema #1: IntegrationsEnum]/ of the query request parameter integration

    • info

      added the enum value TYPESAFE to the property anyOf[subschema #1: IntegrationsEnum]/ of the query request parameter integration

    • info

      removed the CLAUDE enum value from the /// response property for the response status

    • info

      removed the CLAUDE enum value from the // response property for the response status