List sources

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

GET /api/v1/sources?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 sources.

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

integer

The unique identifier of the source.

example:

name

string

An optional label that can be assigned to the source for better categorization or identification.

example:

Acme Inc. Snowflake

label

string | null

DEPRECATED: Use 'name' instead. An optional label that can be assigned to the source for better categorization or identification.

example:

Acme Inc. Snowflake

type

string

The type of the data source. A valid type is the service_name of a source type returned from the /source_types endpoint, where the source type is marked as creatable_via_api.

example:

snowflake

sync_engine

string

The sync engine type for this source.

enum:

"basic""advanced"

created_at

string

When the connection was created

format:

date-time

example:

2023-07-22T23:42:47.239Z

last_test_results

object

steps

array

An ordered array of steps representing the results of the last connection test. If one step fails then we won't surface details on later steps.

step

stringrequired

The name of the step in the connection test process.

example:

Verify connectivity

error

object

message

string | null

The error message associated with the step, if any.

status

stringrequired

The status of the step.

enum:

"running""success""failed""warning"

last_test_succeeded

boolean | null

Indicates if the last connection test to this source was successful.

example:

true

last_tested_at

string | null

Timestamp of when the last connection test was conducted on this source.

format:

date-time

connection_details

undefined

Detailed configuration and information for connecting to this source.

property name *

undefined

additional property

warehouse_writeback_retention_in_days

integer

Number of days to retain warehouse writeback data. When set, automatically enables sync logs for this source. Only supported for certain source types, see supports_warehouse_writeback field in the Source Types endpoint. Only supported for sources with Advanced sync engine. Requires the sync logs feature to be included in your organization's plan.

minimum:

example:

{
  "status": "success",
  "pagination": {
    "total_records": 14,
    "per_page": 25,
    "prev_page": 1,
    "page": 2,
    "next_page": 3,
    "last_page": 10
  },
  "data": [
    {
      "id": 4,
      "name": "Acme Inc. Snowflake",
      "label": "Acme Inc. Snowflake",
      "type": "snowflake",
      "sync_engine": "basic",
      "created_at": "2023-07-22T23:42:47.239Z",
      "last_test_results": {
        "steps": [
          {
            "step": "Verify connectivity",
            "error": {
              "message": "string"
            },
            "status": "success"
          }
        ]
      },
      "last_test_succeeded": true,
      "last_tested_at": "2019-08-24T14:15:22Z",
      "connection_details": {
        "account": "xxxxxxx.us-east-1,",
        "user": "DEV,",
        "warehouse": "TEST,",
        "use_keypair": false
      },
      "warehouse_writeback_retention_in_days": 7
    }
  ]
}