Jump to Content
Home
Guides
Recipes
API Reference
v1.0
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v1.0
Home
Guides
Recipes
API Reference
UsersWorkspaceMember
Search
JUMP TO
V7 Go API
Generate an API Key
Create Entities Programmatically
Uploading Files to Collections
IntegrationConnections
List all integration connections
get
Confirm creation of a new connection
post
Confirm creation of the connection
post
Start a file picker session
post
Create a new connect session
post
Resume connection syncs
post
Delete the connection
del
Start the connection
post
Pause connection syncs
post
Get action authentication data
get
Update connection visibility
put
Cases
Lists cases
get
Confirms a tool run
post
Marks a case as read
post
Creates a new case
post
Cancels a tool run
post
Adopts existing Entities into the Case (bulk)
post
Retrieve a url to upload a file to a Case
post
Edits a case query
put
Adopts an existing Entity into the Case
post
Adds a case query
post
Delete a file linked to a Case
del
Restarts a case
post
Deletes a case
del
Gets a case
get
Updates a case
post
Confirm the files have been uploaded to a Case
post
Asynchronously uploads a file to a Case
post
Folders
Get folder tree
get
Delete folder
del
Get folder details
get
Update folder
put
List folders
get
Create folder
post
Entities
List all entity IDs in a Project
get
Confirm files has been uploaded to fields
post
List all entities in a Project
post
Skips a field
post
Sets a field metadata
put
Sync integration files on all or given stale file fields for a project
post
List all entity IDs in a Project (filtered)
post
Sets the Ground Truth status of a field.
put
Sets the review status of a field.
put
Refines a field's tool value using configured AI tool
post
IntegrationConnectionsSync
Creates a synced file record, which causes updates and deletion of that file to be tracked.
post
Deletes the given synced file record, stopping tracking of that file.
del
Tools
Toggles enabled/disabled state of tool integration
post
Returns current state of tool integration along with available tools.
get
List model configs for a given tool key
get
Set default tool for workspace
put
List custom API keys set for a workspace
get
Upserts custom API key for tool integration
post
Upserts custom model configuration for a given tool key / tool
post
Removes existing custom API key for tool integration
del
Hubs
List hubs
get
Move files in hub
post
Create hub
post
Delete hub
del
Get hub
get
Add files to hub
post
Reindex hub
post
List files in hub
get
Billing
Get limit usage for a project
get
List plans for current workspace
get
Get effective plan for current workspace
get
Get limit usage for a workspace
get
UsersHubMember
Update a hub's access type
put
Delete a user's role in a Hub.
del
Get a member of a Hub
get
Adds a user's role in a Hub.
post
Update a user's role in a Hub.
put
List members in a Hub
get
Projects
Properties
List properties in a project
get
Add a property to a project
post
Remove a property from a project
del
Get a property
get
Update a property in a project
put
Retrieve a url to upload a file to a field
post
Generate a property configuration from a prompt
post
List ancestors and descendants (minimal)
get
Confirm the file has been uploaded to a field
post
Gets the previous entity
get
Gets the next entity
get
Bulk delete entities
post
Removes a workspace icon
del
Recalculate all entities
post
Recalculate entity fields
post
Delete an entity
del
Get an entity
get
Sets field values on an entity
put
Removes a project's cover image
del
List all entities in a Project
get
Update a project's cover image
post
Create an entity
post
Mark project as visited
post
List projects in a Workspace
get
Create a project
post
Clone a project
post
Delete a project
del
Get a project
get
Update a project
put
Move project to folder
post
List public template projects
get
Secrets
List secret names
get
Delete a secret
del
Create or update a secret by name
put
UsersProjectMember
TriggersInbound
Deploy trigger with configuration
post
Update inbound trigger
put
Get a specific inbound trigger
get
Create a new inbound trigger
post
List trigger events
get
Create and deploy a new inbound pipedreamtrigger
post
Delete an inbound trigger
del
Disable inbound trigger
post
List all inbound triggers for a project
get
Enable inbound trigger
post
TriggersOutbound
Delete a trigger
del
Return a trigger
get
List triggers in a workspace
get
Create a trigger
post
UsersWorkspaceMember
UsersFolderMember
Auth0SSOConnection
List SSO connections for a workspace
get
Workspaces
List aggregated field errors
get
Update a workspace icon
post
List workspaces
get
Create a workspace
post
Delete a workspace
del
Return a workspace
get
Update a workspace
put
WorkspaceInvitations
Verify invitation
get
List invitations in a Workspace
get
Create new invitation into a Workspace
post
Delete an pending invitation from a Workspace
del
Accept an invitation
post
ProjectInvitations
Accept an invitation
post
Delete an pending invitation from a Project
del
Verify invitation
get
List invitations in a Project
get
Create new invitation into a Project
post
Skills
Create global skill
post
List skills
get
Create skill
post
Delete global skill
del
Update global skill
put
Execute skill
post
Delete skill
del
Get skill
get
Update skill
put
ApiKeys
Delete an api key
del
Return an api key
get
List api keys for a user
get
Templates
Creates new projects from a template structure
post
Exports projects to a template structure
post
Library
List all entities in a Library
get
Update Library's entity attributes
put
Get a Library project for a workspace
get
Exports
Delete an export
del
Return an Export
get
List exports in a project
get
Create an Export
post
Users
Delete a user's role in a Project.
del
Get a member of a Project
get
Adds a user's role in a Project.
post
Update a user's role in a Project.
put
Update a project's access type
put
List historic members of a Workspace
get
Delete a user's role in a Folder.
del
Get a member of a Folder
get
Adds a user's role in a Folder.
post
Update a user's role in a Folder.
put
Update a folder's access type
put
Return a user
get
Delete a service account
del
Return a user
get
Update a user
put
List members in a Folder
get
Create a service account
post
Delete a user's role in a workspace
del
Get a member of a Workspace
get
Update a user's role in a workspace
put
List members in a Workspace
get
List members in a Project
get
Imports
Starts an Import
post
List imports in a project
get
Return an Import
get
Get upload URL
post
List imports in a workspace
get
Prepares an Import
post
Powered by
UsersWorkspaceMember
