Introduction
Organization APIs
- Users
- Invitations
- Workspaces
Workspace APIs
- Syncs
- Sync Management Links
- Sync Runs
- Destination Types
- Destinations
- Destination Connect Links
- Source Types
- Sources
- Source Connect Links
- Segment Management Links
Fetch source type
Use this endpoint to fetch the details for a specific type of source connection that can be created in the current workspace. This is particularly useful for Census Embedded solutions when determining the required values to authorize a new source connection.
curl --request GET \
--url https://app.getcensus.com/api/v1/source_types/{service_name} \
--header 'Authorization: Bearer <token>'{
"status": "success",
"data": {
"documentation_slug": "snowflake",
"label": "Snowflake",
"service_name": "snowflake",
"supported_sync_engines": [
"advanced"
],
"creatable_via_api": true,
"creatable_via_connect_link": true,
"configuration_fields": {
"fields": [
{
"id": "instance_url",
"rules": "required",
"label": "Endpoint URL",
"type": "string",
"placholder": "https://rest.iad-01.braze.com",
"matches": "^(?:(?=.*rest)https:\\\\/\\\\/rest|(?!.*rest)(https:\\\\/\\\\/)?sdk)\\\\.(iad|fra)-\\\\d\\\\d\\\\.braze\\\\.(com|eu)",
"is_password_type_field": false,
"possible_values": [
"<string>"
],
"read_more": "https://docs.getcensus.com/destinations/available-destinations/hubspot#managing-object-associations",
"hint": "You can find your API key in the YourService UI under Settings > Integrations > API Key\n",
"input_type": "textbox"
}
]
}
}
}Authorizations
Bearer token for the current workspace. Can be retrieved from the Workspace's settings page.
Path Parameters
Name of the source type to retrieve
Response
The outcome of the fetch request
success The path to this source type's Census documentation, ie https://docs.getcensus.com/sources/available-sources/{documentation_slug}.
The name of this source type.
The full name for this source type. This is used to identify the source type in the API
advanced, basic Whether you can create connections of this type using the Create Source API. If you'd like to create a source via API that isn't marked as creatable_via_api, reach out to us.
Whether you can create connections of this type using Census Connect Links. If you'd like to create a source via Connect Link that isn't currently supported, please reach out to us.
Top level object containing a list of fields needed to create a connection of this type.
The name of this configuration field. This is used to identify the credential in the API to create a connection of this type.
Validations around this field, ie 'required'
A user facing name for this field
The type of this field
string, integer, boolean A placeholder for this field, usually an example of its value
A regex string the value must match
If this is a credential field that contains sensitive data
If this credential accepts a finite list of values, what those values are
A link to read more about this destination, usually linking to the Census docs.
A hint to the user about this field, such as instructions for how to find the value
Was this page helpful?
curl --request GET \
--url https://app.getcensus.com/api/v1/source_types/{service_name} \
--header 'Authorization: Bearer <token>'{
"status": "success",
"data": {
"documentation_slug": "snowflake",
"label": "Snowflake",
"service_name": "snowflake",
"supported_sync_engines": [
"advanced"
],
"creatable_via_api": true,
"creatable_via_connect_link": true,
"configuration_fields": {
"fields": [
{
"id": "instance_url",
"rules": "required",
"label": "Endpoint URL",
"type": "string",
"placholder": "https://rest.iad-01.braze.com",
"matches": "^(?:(?=.*rest)https:\\\\/\\\\/rest|(?!.*rest)(https:\\\\/\\\\/)?sdk)\\\\.(iad|fra)-\\\\d\\\\d\\\\.braze\\\\.(com|eu)",
"is_password_type_field": false,
"possible_values": [
"<string>"
],
"read_more": "https://docs.getcensus.com/destinations/available-destinations/hubspot#managing-object-associations",
"hint": "You can find your API key in the YourService UI under Settings > Integrations > API Key\n",
"input_type": "textbox"
}
]
}
}
}