Conduit Docs
  • Getting Started
    • Importing Data
    • Connecting Multiple Accounts
    • How To Invite Additional Team Members to Your Account
    • How Does the Trial Work?
    • What's a Table/Data Schema?
    • Number of Sub-Connections
    • Default Time Range for Downloading Data
    • Conduit Data Lake
    • Conduit vs Boost.Space
    • Conduit vs Reportz.io
    • Conduit vs Google Looker Studio
  • Use Cases
    • Use Case: AI-powered Text Extraction
    • Use Case: Track Ad Campaign Performance with Conduit
    • Use Case: Enhancing Project Management with Copilot
    • Use Case: Using Conduit for Financial Analysis
    • Use Case: Use ChatGPT with your data
    • Use Case: Build financial models from raw transactional data and generate P&L statements.
    • Use Case: Marketing data analytics
    • Use Case: Using data science frameworks using your data in spreadsheets Low-Code
    • Use Case: Custom Dimensions for Ad Operations
    • Use Case: Custom dimensions for E-Commerce
    • Use Case: Extract invoices from PDF
    • Use Case: Export data from SaaS applications to your spreadsheet
    • Use Case: Online store and a physical retail locations consolidated
    • Use Case: Pull data from Advertisement platforms to a spreadsheet
    • Use Case: Consolidation of data received as separate files, for example, separate Excel reports
    • Use Case: Names, IDs, SKUs normalization
    • Use Case: Integrating Conduit with a custom CRM using SSO/OAuth2
    • Use Case: Chat Bot for Your Data
    • Use Case: Display Net sales On a Dashboard by Subtracting Ad spend from Total Sales
    • Use Case: Conduit for Healthcare Applications
  • Security & Data Privacy
    • Data Retention Policy
    • How Conduit Complies with GDPR?
    • Security
  • Spreadsheets
    • Writing data to spreadsheets: Overwrite and Update
    • Using Formulas in Spreadsheets
    • The Time Range in formulas
    • The table in the spreadsheet does not start from the first line
  • Conduit for Digital Agencies
    • How to Use White Label
    • What is a Workspace and a Sub-account
    • Use Case: Creating a Dashboard for Two Clients
    • Users in Your Team vs. Sub-Accounts in Workspaces
    • Deleting a Workspace
    • How to Log Into a Workspace
    • How to Buy Additional Workspaces
    • Schedulers in Workspaces
  • Troubleshooting
    • Error codes and how to troubleshoot data-related issues
    • Google Drive Refusing To Connect
    • Why Are my Shopify stats different?
    • Facebook Integration: How to Fix the GraphMethodException Error
  • Copilot
    • Copilot Roles: Data Analyst vs AI Generalist
    • Conduit Copilot vs. ChatGPT – What's The Difference?
    • How to Tune the Copilot
    • Data Sources for Copilot
  • For Developers
    • IP Addresses of Conduit Servers
    • Create an AI Сopilot for your app
    • Manage your AI Copilot users
    • Upload CSV files to Conduit via API (Guide)
  • Integrations
    • Instagram Integration
    • Dashboard Widgets Based On a SQL Connection
    • GA4 Integration Notes
    • Salesloft Integration
    • Self-service and Manual integrations
    • Installing Google Sheets Add-On
    • Slack Integration
    • YouTube Integration
    • HubSpot Integration
    • Conduit integration for Bigcommerce
    • Xero Integration
    • Recharge integration
    • Wrike Integration
    • Zoho Integration
    • Monday.com Integration
    • ActiveCampaign Integration
    • ClickUp Integration
    • FreshSales Integration
    • Google Ads Quality Score
    • Facebook Ads Reach
    • Shopify Net Sales and Returns
    • Gorgias tickets with Spam/Deleted/Auto-Close statuses
    • Looker Studio Connector
  • Workflows
    • Workflows – Adding New Columns
    • Workflows – using the Join by Key block
    • Workflows – using the Union block
    • Workflows – using the Transpose block
    • Workflows – creating a weekly Ad Spend report
Powered by GitBook
On this page
Edit on GitHub
  1. For Developers

Manage your AI Copilot users

The Conduit Link API is designed for creating and managing sub-clients. With this API, you can create sub-clients, generate links to connect data with sub-clients, and extract downloaded data from Conduit.

Link APP

Conduit users can create multiple Link APPs. Each sub-client (Company) is associated with a specific Link APP, and the uniqueness of sub-clients does not overlap between different Link APPs. To obtain a token, please visit https://app.getconduit.app/auth/link_app_token/. For creating additional Link APPs, please contact sales@getconduit.app.

Company

Within the Conduit Link API, a sub-client is referred to as a Company.

Creating a Company

To create a Company, perform an HTTP POST request:

curl -X POST https://api.getconduit.app/link/company/ \\
     -H "Authorization: Bearer {Link_APP_Token}" \\
     -H "Content-Type: application/json" \\
     -d '{ \\
           "id": "1", \\
           "name": "My Client 1", \\
           "page_enabled": false \\
         }'

Query Parameters:

  • id: The unique identifier for the client, which can contain 1 to 1024 characters of A-Z and 0-9 without case sensitivity. This could be, for example, the client's ID in your system or a composite ID.

  • name: (Optional) The name of the client, up to 1024 characters.

  • page_enabled: (Optional) A flag indicating whether to enable the Company Page, which allows the user to choose connection sources independently. It is set to True by default.

Response

{
  "id": "1",
  "name": "My Client 1",
  "created_at": "2023-03-15T12:34:56Z",
  "link_page": {
    "url": null,
    "enabled": false
  },
  "api_token": {
    "token": "token_string",
    "expires_at": 1678898400
  }
}

Description of Response Fields:

  • id: The ID of the created Company.

  • name: The name of the created Company.

  • created_at: The date and time when the Company was created in ISO 8601 format.

  • link_page: An object containing information about the connection page.

    • url: The URL of the connection page, unique to each Company. Returns null if page_enabled is disabled.

    • enabled: The availability status of the connection page.

  • api_token: An object containing the API token for accessing Company functions.

    • token: The API token.

    • expires_at: The expiration timestamp of the token in UTC format.

Note: The token expires after 10 minutes.

Retrieving Company Information

To obtain information about a Company, execute an HTTP GET request:

curl -X GET https://api.getconduit.app/link/company/{cid}/ \\
     -H "Authorization: Bearer {Link_APP_Token}"

Request Parameters:

  • {cid}: The identifier of the Company to be obtained.

Response:

The response to the request for Company information has the same format as the response to the Company creation request.

{
  "id": "1",
  "name": "My Client 1",
  "created_at": "2023-03-15T12:34:56Z",
  "link_page": {
    "url": null,
    "enabled": false
  },
  "api_token": {
    "token": "token_string",
    "expires_at": 1678898400
  }
}

Description of Response Fields:

The description of response fields for the request for Company information is identical to the description of fields in the response to the Company creation request.

  • id: The ID of the created Company.

  • name: The name of the created Company.

  • created_at: The date and time when the Company was created in ISO 8601 format.

  • link_page: An object containing information about the connection page.

    • url: The URL of the connection page, unique to each Company. Returns null if page_enabled is disabled.

    • enabled: The availability status of the connection page.

  • api_token: An object containing the API token for accessing Company functions.

    • token: The API token.

    • expires_at: The expiration timestamp of the token in UTC format.

Note: The token expires after 10 minutes.

Editing Company

To edit an existing Company, you need to send an HTTP POST request.

curl -X POST https://api.getconduit.app/link/company/{cid}/ \\
     -H "Authorization: Bearer {Link_APP_Token}" \\
     -H "Content-Type: application/json" \\
     -d '{ \\
           "name": "My Client 1", \\
           "page_enabled": false \\
         }'

Request Parameters:

  • {cid}: The identifier of the Company to be edited.

  • name: The new name for the Company. Accepts up to 1024 characters.

  • page_enabled: A flag indicating whether to enable or disable the Company page. Defaults to True.

Response:

Upon successful editing of the Company, the response will include the updated information about the Company.

{
  "id": "1",
  "name": "My Client 1",
  "created_at": "2023-03-15T12:34:56Z",
  "link_page": {
    "url": null,
    "enabled": false
  },
  "api_token": {
    "token": "updated_token_string",
    "expires_at": 1678898400
  }
}

Response Field Descriptions:

  • id: The unique identifier of the Company, which remains unchanged after editing.

  • name: The new name of the Company after editing.

  • created_at: The date and time when the Company was created, which remains unchanged after editing.

  • link_page: An object containing information about the connection page after editing.

    • url: The URL of the connection page, unique to each Company. It may be null if page_enabled is disabled.

    • enabled: The status of the connection page's availability after editing.

  • api_token: An object containing the updated API token for accessing Company functionalities.

    • token: The updated API token.

    • expires_at: The expiration timestamp of the token in UTC format.

Note: The token expires after 10 minutes.

PreviousCreate an AI Сopilot for your appNextUpload CSV files to Conduit via API (Guide)

Last updated 11 months ago