List source types

Request schema

Query parameters

page

number

Designates which page of results to return. Always starts at 1. If 0 is specified, it defaults to 1.

default:

per_page

number

Determines the number of results on each page. It can't exceed 100.

default:

maximum:

100

order

string

Organizes the results based on their creation time, either ascending or descending.

default:

desc

enum:

"asc""desc"

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

Http + 1.1

GET

https://app.getcensus.com/api/v1/source_types

GET /api/v1/source_types?page=SOME_NUMBER_VALUE&per_page=SOME_NUMBER_VALUE&order=SOME_STRING_VALUE HTTP/1.1
Authorization: Bearer REPLACE_BEARER_TOKEN
Host: app.getcensus.com

Responses

200

Successfully retrieved the list of source types.

`200`

status

stringrequired

The outcome of the request

enum:

"success"

pagination

objectrequired

An object to help you navigate the list of results.

total_records

number

Total records in the collection.

example:

per_page

number

Records on each page.

default:

example:

prev_page

number | null

The previous page number, or null for the first page.

example:

page

number

The current page number.

default:

example:

next_page

number | null

The next page number, or null if it's the last page.

example:

last_page

number

The number of the last page with records.

example:

data

arrayrequired

The list of results.

documentation_slug

string

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

example:

snowflake

label

string

The name of this source type.

example:

Snowflake

service_name

string

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

example:

snowflake

supported_sync_engines

array

type:

string

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.

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.

configuration_fields

object

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

fields

array

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

rules

string

Validations around this field, ie 'required'

example:

required

label

string

A user facing name for this field

example:

Endpoint URL

type

string

The type of this field

enum:

"string""integer""boolean"

placholder

string

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

example:

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

matches

string

A regex string the value must match

example:

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

is_password_type_field

boolean

If this is a credential field that contains sensitive data

possible_values

array

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

type:

string

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

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

show

boolean | object

Controls the visibility of this field in the UI based on the values of other fields. This is commonly used for source and destination types that support multiple authentication methods.

When show is true, the field is always visible. When show is an object, it contains conditional logic using if or unless:

if: The field is shown when the specified condition is met
unless: The field is hidden when the specified condition is met

The eq value can be either a boolean or a string, depending on the field being referenced.

For example, in Snowflake which supports both password and keypair authentication:

The password field has "show": {"unless": {"use_keypair": {"eq": true}}} - shown only when keypair auth is disabled (boolean)
The private_key_pkcs8 field has "show": {"if": {"use_keypair": {"eq": true}}} - shown only when keypair auth is enabled (boolean)

example:

true

object

Condition object specifying when to show this field. The field is shown when the condition evaluates to true.

property name *

object

additional property

boolean | string

The value (boolean or string) the referenced field must equal for this field to be shown.

unless

object

Condition object specifying when to hide this field. The field is hidden when the condition evaluates to true.

property name *

object

additional property

boolean | string

The value (boolean or string) the referenced field must equal for this field to be hidden.

conditionally_required

null | object

Specifies conditions under which this field becomes required, even if it's not listed in the rules array as required. This is used when a field's requirement status depends on the values of other fields.

When conditionally_required is null, the field's requirement is determined solely by the rules array. When it's an object, it contains conditional logic using if or unless:

if: The field becomes required when the specified condition is met
unless: The field is not required when the specified condition is met

The eq value can be either a boolean or a string, depending on the field being referenced.

A field could also use unless with a boolean, such as: {"unless": {"use_keypair": {"eq": true}}} - required unless keypair auth is enabled

example:

{ "if": { "auth_type": { "eq": "system_user" } } }

object

Condition object specifying when this field becomes required. The field is required when the condition evaluates to true.

property name *

object

additional property

boolean | string

The value (boolean or string) the referenced field must equal for this field to become required.

unless

object

Condition object specifying when this field is not required. The field is not required when the condition evaluates to true.

property name *

object

additional property

boolean | string

The value (boolean or string) the referenced field must equal for this field to not be required.

input_type

object

Describes the UI input type for this credential field. All input types have a type field, and some types include additional properties.

Simple input types (only type field):

textbox: Single-line text input
textarea: Multi-line text input
toggle: Boolean toggle switch

Complex input types (additional fields):

select: Dropdown with predefined options
- allow_manual_inputs (boolean): Whether users can input custom values
- See possible_values field for the list of options
radio: Radio button selection
- options (object): Map of values to tile configurations with label, description, icon, and coming_soon
- hide_check_bubble (boolean): Whether to hide the selection indicator

type

stringrequired

The input type identifier

enum:

"textbox""textarea""toggle""select""radio"

allow_manual_inputs

boolean

For select type only. Whether users can input custom values not in the predefined list.

options

object

For radio type only. Map of values to tile configuration objects.

property name *

object

additional property

label

string

description

string

icon

string

coming_soon

boolean

hide_check_bubble

boolean

For radio type only. Whether to hide the selection indicator.

example:

true

supports_warehouse_writeback

boolean

Indicates if this source type supports warehouse writeback.

{
  "status": "success",
  "pagination": {
    "total_records": 14,
    "per_page": 25,
    "prev_page": 1,
    "page": 2,
    "next_page": 3,
    "last_page": 10
  },
  "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",
            "show": true,
            "conditionally_required": {
              "if": {
                "auth_type": {
                  "eq": "system_user"
                }
              }
            },
            "input_type": {
              "type": "textbox"
            }
          }
        ]
      },
      "supports_warehouse_writeback": true
    }
  ]
}