Try our plataform
Invitations to Add Sources and Destinations

When creating a source or destination in Kondado, you can choose to invite a temporary user to perform this creation securely. This user will not have access to your account and will only be able to create the specific source or destination. See here how to do this through the graphical interface.

When using our API for this process, you can build a seamless flow in which your user does not need to share passwords with your team. After creating a source or destination, you will also be able to create new Pipelines.

Create a New Invitation

This endpoint is available only to customers on Enterprise plans (starting at 100 million records).

Description

Creates an invitation and returns an access link.

Method

POST

Endpoint

/collection_guests

URL Parameters

client_id

  • Description: Parameter that indicates the account ID where the source or destination will be created. It can be obtained at app.kondado.com.br/account (it will appear next to your team name, in the format XXXXX-Y, where XXXXX is your client ID).
  • Required: yes
  • Format: integer number

recipient_email

  • Description: Parameter that indicates the email address of the user who will receive the invitation. You may use a default email address if you do not want the user to receive an email invitation (the link will be exposed in the response).
  • Required: yes
  • Format: text

parent_collection_id

parent_collection_direction

  • Description: Parameter that indicates whether the parent collection refers to:
    • src: a source
    • dest: a destination
  • Required: yes
  • Format: fixed values src or dest

assigned_collection_name

  • Description: Parameter that indicates the name that will be assigned to the source or destination.
  • Required: yes
  • Format: text

Example Request (body)

{
    "client_id": "123456789",
    "recipient_email": "julia-pizzol@kondado.ai",
    "parent_collection_id": 130,
    "parent_collection_direction": "src",
    "assigned_collection_name": "[Guest] Toggl"
}

Example Response (body)

{
    "success": true,
    "data": {
        "success": true,
        "data": {
            "link": "https://app.kondado.com.br/collection_guest/eyJnasukaskxaskxbaskdbaskbdaksjcnkjqwkudhauwkdnasjklxn"
        }
    }
}

Response Description

The data object will return a link parameter containing the URL that can be accessed to create the source or destination according to the request.

Create Secure API Invitations for Sources or Destinations

Use Kondado's API to generate temporary, secure invitations that let external users add sources or destinations without accessing your account.

1
Confirm your Enterprise plan eligibility

Verify that your account is on an Enterprise plan (100M+ records), since the /collection_guests endpoint is restricted to these tiers. Review pricing and plan details if you are unsure.

2
Gather required parameters

Collect your client_id from app.kondado.com.br/account, the parent_collection_id of the source or destination template, and decide whether the invited user will create a src (source) or dest (destination). You can browse available data integration options to identify the right parent collection.

3
Build the POST request body

Construct a JSON payload with client_id, recipient_email, parent_collection_id, parent_collection_direction (src or dest), and assigned_collection_name. Use a placeholder email if you prefer to expose the link only in the API response.

4
Send the request to /collection_guests

Execute a POST request to the /collection_guests endpoint. On success, the response returns a secure link that the temporary user can use to create the source or destination without ever accessing your main account.

5
Use the created source or destination in pipelines

Once the guest completes setup, the new source or destination appears in your account. You can then proceed to build pipelines and dashboards using the connected data.

Frequently asked questions

Who can use the /collection_guests API endpoint?▼
The /collection_guests endpoint is available exclusively to customers on Enterprise plans starting at 100 million records. If you are on a lower tier, you will need to upgrade before you can generate secure guest invitations via the API. Check our pricing page for plan details.
Does the invited user get access to my Kondado account?▼
No. The temporary user receives only a secure, single-purpose link to create the specific source or destination. They cannot log into your account, view other pipelines, or access any data beyond the invited collection setup.
Can I prevent the invitation email from being sent to the user?▼
Yes. If you do not want the recipient to receive an email, provide any default or placeholder email address in the recipient_email field. The access link will still be exposed in the API response for you to distribute manually.
What happens after the guest creates the source or destination?▼
Once the guest completes the setup, the source or destination becomes available in your account under the assigned_collection_name you specified. You can then use it to create new pipelines and connect to dashboards as normal.
Where do I find my client_id and parent_collection_id?▼
Your client_id appears next to your team name at app.kondado.com.br/account in the format XXXXX-Y (the XXXXX part is your ID). The parent_collection_id comes from listing your existing parent collections via the API; the article references a separate guide for retrieving these values.
Written by·Published 2026-01-12·Updated 2026-04-25