Fetch destination type

Authorizations

Authorization

string

headerrequired

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

Path Parameters

service_name

string

required

Name of the destination type to retrieve

Response

200 - application/json

status

enum<string>

required

The outcome of the fetch request

Available options:

success

data

object

required

data.documentation_slug

string

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

data.label

string

The name of this destination type.

data.service_name

string

required

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

data.auth_method

enum<string>

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

Available options:

credentials,

oauth,

other

data.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.

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 destination 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.

Introduction

Organization APIs

Workspace APIs

Authorizations

Path Parameters

Response