Jump to Content
Clean Room
Home
Documentation
Updates
Clean Room
Documentation
Home
Documentation
Updates
Create Cleanroom
JUMP TO
Getting Started
About the Clean Room API
API Limits
Python Tutorial for Creating and Running Questions
Step 1: Environmental Configuration
Step 2: Defining API Operations
Step 3: Creating a Clean Room
Step 4: Provisioning Datasets
Step 5: Creating Analytical Questions
Step 6: Assign Datasets to Questions
Step 7: Run Questions
Step 8: Get Question Run Status and Results
Step 9: Creating Flows
Creating Questions and Flow Runs
Example Question Workflow
Example Flow Run Workflow
Where to Find Relevant Metadata
Authentication
Configuring a Clean Room API User
Request an Access Token
API Reference
Clean Room API Endpoints
Data Connections
Data Sources
Fetch a list of all Data Sources
get
Fetch a Data Source by ID
get
Data Connections
Fetch a list of all Data Connections
get
Fetch a Data Connection by ID
get
Create Data Connection
post
Update a Data Connection by ID
put
Fetch a list of all Field Configurations
get
Map Field Configurations
post
Retry a Data Connection Job by ID
post
Fetch a list of all Identifier Types for Field Mapping
get
Delete a Data Connection by ID
del
Credential Sources
Fetch a list of all Credential Sources
get
Fetch a Credential Source by ID
get
Fetch a Credential Source by Name
get
Data Types
Fetch a list of Data Types
get
Fetch a Data Type by ID
get
Data Source Parameters
Fetch all Data Source Parameters
get
Import Data Types
Fetch a list of all Import Data Types
get
Organizations
Organization Users
Fetch a list of all Organization Users
get
Organization Credentials
Fetch a list of all Organization Credentials
get
Fetch an Organization Credential by ID
get
Create Organization Credentials
post
Update Organization Credentials
put
Delete an Organization Credential by ID
del
Clean Rooms
Cleanrooms
Fetch a list of all Cleanrooms
get
Fetch a Cleanroom by ID
get
Create Cleanroom
post
Update Cleanroom
put
Fetch all Cleanroom Types
get
Get comprehensive asset details for cleanroom operations
get
Delete Cleanroom
del
Cleanroom Partners
Fetch a list of all Cleanroom Partners
get
Fetch a Cleanroom Partner by Partner ID
get
Add Cleanroom Partner
post
Update a partner cleanroom user role
put
Get Cleanroom Partner Roles in Cleanroom
get
Get Cleanroom Partner Role by ID
get
Remove Cleanroom Partner User
del
Delete Cleanroom Partner
del
Invitations
List Cleanroom Partner Invitations For a Cleanroom Inviter
get
Cancel Cleanroom Partner Invitation
del
Cancel Cleanroom Partner Invitation
del
Cleanroom Questions
Fetch a list of all Cleanroom Questions for a Cleanroom
get
Fetch a Cleanroom Question by ID
get
Get Cleanroom Question by Cleanroom ID and Question ID
get
Add Cleanroom Question
post
Enable segmentation for a Cleanroom Question
post
Update segmentation for a Cleanroom Question
put
Update the compute capacity for a cleanroom question
patch
Delete Cleanroom Question
del
Cleanroom Roles
Fetch a list of cleanRoom roles
get
Fetch a cleanroom role by ID
get
Cleanroom Users
Fetch a list of Cleanroom Users
get
Fetch a Cleanroom User by ID
get
Add Cleanroom User
post
Update Cleanroom User Role
put
Remove Cleanroom User
del
Cleanroom Datasets
Fetch a list of all Cleanroom Datasets
get
Get a Cleanroom Dataset by ID
get
Configure a Cleanroom Dataset by Data Connection ID
post
Configure whether a partner can assign a Cleanroom Dataset
post
Update a Cleanroom Dataset by ID
put
Questions
Fetch question details
get
Create question
post
Update question
put
Fetch question data types
get
Delete question
del
CleanroomQuestions
Cleanroom Question Runs
Fetch a list of all Cleanroom Question Runs for a Cleanroom Question
get
Fetch a Cleanroom Question Run by ID
get
Create a Cleanroom Question Run for a Cleanroom Question
post
Update Question Run Status
put
Get the result data for Cleanroom Question Run
get
Get the output file for Cleanroom Question Run
get
Get the count of result data for Cleanroom Question Run
get
Get audit details for Cleanroom Question Run
get
Fetch the Activation Summary for a Cleanroom question run
get
Fetch the Partition Parameters for a Cleanroom question run
get
Delete Cleanroom Question Run
del
Cleanroom Question Result Shares
Get the possible sharing options for the result of a Cleanroom Question
get
Upsert clean room question result shares
put
Cleanroom Question Tags
Get the tags for a Cleanroom Question
get
Cleanroom Question Run Schedule
Get all Cleanroom Question Run Schedules for a Cleanroom Question
get
Get a Cleanroom Question Run Schedule by ID
get
Create a new run schedule for a cleanroom question
post
Update a run schedule for a cleanroom question
patch
delete a Cleanroom Question Run Schedule by ID
del
Cleanroom Question Datasets
Fetch a list of all Cleanroom Question Datasets
get
Fetch a list of stakeholders for this cleanroom
get
Configure Cleanroom Question Datasets
post
Get the parameters for a Cleanroom Question
get
Fetch a list of data type options for this cleanroom question
get
Assign Cleanroom Question Datasets Ownership
post
Cleanroom Question Permissions
Get the permissions for a Cleanroom Question
get
Configure the permissions for a Cleanroom Question
post
Cleanroom Exports
Fetch a list of all Cleanroom Exports
get
Fetch a list of all Cleanroom Exports
get
Create cleanroom export job
post
Destinations
List destination partners
get
List destination connections
get
Delete destination connection
del
Cleanroom Destinations
Provision destinations to a cleanroom
post
Cleanroom Flows
Get a Cleanroom Flow by ID
get
Create or update a cleanroom flow
post
Assign datasets and fields to a cleanroom flow
post
List Cleanroom Flows
post
Set Cleanroom Flow Version
put
Get comprehensive node details for a cleanroom flow
get
Get organization information for datasets by UUID or name
post
Flow Decision Configurations
Get decision configuration for a cleanroom flow
get
Create or update decision configuration for a cleanroom flow
post
Delete decision configuration for a cleanroom flow
del
Cleanroom Flow Runs
Fetch a Cleanroom Flow Run by ID
get
Create a Cleanroom Flow Run
post
get the status of a Cleanroom Flow Run
get
Get Flow Run Parameters
get
Fetch a Cleanroom Flow Run Report
get
Fetch output nodes for a Cleanroom Flow Run Report
get
Download output file for a Cleanroom Flow Run node
get
Resume a Cleanroom Flow Run
post
replay a Cleanroom Flow Run
post
Create Cleanroom
Ask AI
post
https://api.habu.com/v1/cleanrooms
This operation creates a new Cleanroom.
Language
Shell
Node
Ruby
PHP
Python
Credentials
OAuth2
OAuth2
Bearer
