List destinations

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

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

`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 id of this destination.

example:

name

string

The name of this destination.

example:

Google Sheets

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

example:

true

last_tested_at

string | null

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

format:

date-time

connection_details

object

Connection details associated with this destination.

property name *

undefined

additional property

is_file_system_destination

boolean

Whether this destination is a file system destination (e.g., S3, SFTP, Google Cloud Storage). When true, please provide the file path as the object full name for sync creation. See an example of an API request to create a sync to a file system destination here.

{
  "status": "success",
  "pagination": {
    "total_records": 14,
    "per_page": 25,
    "prev_page": 1,
    "page": 2,
    "next_page": 3,
    "last_page": 10
  },
  "data": [
    {
      "id": 12,
      "name": "Google Sheets",
      "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_id": "7515011393,",
        "account_name": "Manager Account Test"
      },
      "is_file_system_destination": false
    }
  ]
}