Fetch source 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 source 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 source type's Census documentation, ie https://docs.getcensus.com/sources/available-sources/{documentation_slug}.

data.label

string

The name of this source type.

data.service_name

string

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

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.

Introduction

Organization APIs

Workspace APIs

Authorizations

Path Parameters

Response