Fetch source type

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"
        }
      ]
    },
    "supports_warehouse_writeback": true
  }
}

GET

source_types

{service_name}

Fetch source type

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"
        }
      ]
    },
    "supports_warehouse_writeback": true
  }
}

Authorizations

Authorization

string

header

required

Bearer token for the current workspace. Can be retrieved from the Workspace's settings page.

Path Parameters

service_name

string

required

Name of the source type to retrieve

Response

Successfully retrieved the source type.

status

enum<string>

required

The outcome of the fetch request

Available options:

success

Example:

"success"

data

object

required

Show child attributes

data.documentation_slug

string

The path to this source type's Census documentation, ie https://docs.getcensus.com/sources/available-sources/{documentation_slug}.

Example:

"snowflake"

data.label

string

The name of this source type.

Example:

"Snowflake"

data.service_name

string

The full name for this source type. This is used to identify the source type in the API

Example:

"snowflake"

data.supported_sync_engines

enum<string>[]

Available options:

advanced,

basic

data.creatable_via_api

boolean

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.

data.creatable_via_connect_link

boolean

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.

data.configuration_fields

object

Top level object containing a list of fields needed to create a connection of this type.

Show child attributes

data.configuration_fields.fields

object[]

Show child attributes

data.configuration_fields.fields.id

string

The name of this configuration field. This is used to identify the credential in the API to create a connection of this type.

Example:

"instance_url"

data.configuration_fields.fields.rules

string

Validations around this field, ie 'required'

Example:

"required"

data.configuration_fields.fields.label

string

A user facing name for this field

Example:

"Endpoint URL"

data.configuration_fields.fields.type

enum<string>

The type of this field

Available options:

string,

integer,

boolean

Example:

"string"

data.configuration_fields.fields.placholder

string

A placeholder for this field, usually an example of its value

Example:

"https://rest.iad-01.braze.com"

data.configuration_fields.fields.matches

string

A regex string the value must match

Example:

"^(?:(?=.*rest)https:\\\\/\\\\/rest|(?!.*rest)(https:\\\\/\\\\/)?sdk)\\\\.(iad|fra)-\\\\d\\\\d\\\\.braze\\\\.(com|eu)"

data.configuration_fields.fields.is_password_type_field

boolean

If this is a credential field that contains sensitive data

Example:

false

data.configuration_fields.fields.possible_values

string[]

If this credential accepts a finite list of values, what those values are

data.configuration_fields.fields.read_more

string

A link to read more about this destination, usually linking to the Census docs.

Example:

"https://docs.getcensus.com/destinations/available-destinations/hubspot#managing-object-associations"

data.configuration_fields.fields.hint

string

A hint to the user about this field, such as instructions for how to find the value

Example:

"You can find your API key in the YourService UI under Settings > Integrations > API Key\n"

data.configuration_fields.fields.input_type

object

The type of input for this credential field

Show child attributes

data.configuration_fields.fields.input_type.type

enum<string>

Available options:

textbox,

textarea,

toggle,

select,

keyvaluepairs

data.configuration_fields.fields.input_type.allow_manual_inputs

boolean

Example:

"textbox"

data.supports_warehouse_writeback

boolean

Indicates if this source type supports warehouse writeback.

List source types List sources

⌘I

Introduction

Organization APIs

Workspace APIs

Fetch source type

Authorizations

Path Parameters

Response