List destination types

Use this endpoint to list out the types of destination connections that can be created in the current workspace. This is particularly useful for Activations in Powered by Fivetran solutions when determining the required values to authorize a new destination connection.

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/connectors

GET /api/v1/connectors?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 destination 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 destination type's Census documentation, ie https://docs.getcensus.com/destinations/available-destinations/{documentation_slug}.

example:

braze

label

string

The name of this destination type.

example:

Braze

service_name

stringrequired

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

example:

braze

auth_method

string

How to authorize a destination of this type of destination type.

enum:

"credentials""oauth""other"

creatable_via_api

boolean

Whether you can create connections of this type using the Create Destination API. If you'd like to create a destination via API that isn't marked as creatable_via_api, check out the docs for our Destination Connect Links if the destination is marked as creatable_via_connect_link, or 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 destination via Connect Link that isn't currently supported, please reach out to us.

source_creatable_via_connect_link

boolean

Whether you can create source connections of this type using Census Source Connect Links, for building SaaS Datasets on top of.

configuration_fields

object

Top level object containing a list of fields needed to create a destination 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)

In Facebook Ads with string-based auth type:

"show": {"if": {"auth_type": {"eq": "oauth"}}} - shown only when auth_type equals "oauth" (string)

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.

For example, in Facebook Ads, auth_type controls which authentication flow is used:

When auth_type is "oauth", the oauth_token field is conditionally required: {"if": {"auth_type": {"eq": "oauth"}}} (string)
When auth_type is "system_user", the system_user_token field is conditionally required: {"if": {"auth_type": {"eq": "system_user"}}} (string)

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
oauth: Retrieved from OAuth authentication flow
readonlytextbox: Read-only text display

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
keyvaluepairs: Key-value pair editor
- key_label (string, optional): Label for the key field (default: "Header")

type

stringrequired

The input type identifier

enum:

"textbox""textarea""toggle""select""radio""keyvaluepairs""oauth""readonlytextbox"

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

key_label

string

For keyvaluepairs type only. Label for the key field. Defaults to "Header" if not provided.

example:

Header

user_selectable_field_types

array

A list of field types that can be used when creating custom fields on this connector type. This field is deprecated in favor of supported_custom_field_types at the destination object level, please refer to any of the endpoints that return object information, such as listing destination objects, instead.

type

stringrequired

The data type of the field.

example:

String

array

booleanrequired

Whether this is an array type.

{
  "status": "success",
  "pagination": {
    "total_records": 14,
    "per_page": 25,
    "prev_page": 1,
    "page": 2,
    "next_page": 3,
    "last_page": 10
  },
  "data": [
    {
      "documentation_slug": "braze",
      "label": "Braze",
      "service_name": "braze",
      "auth_method": "credentials",
      "creatable_via_api": true,
      "creatable_via_connect_link": true,
      "source_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"
            }
          }
        ]
      },
      "user_selectable_field_types": [
        {
          "type": "String",
          "array": false
        }
      ]
    }
  ]
}