List destination connect links

This endpoint returns details for all active and expired connect links in the current workspace. Read more on how to use Connect links in our Census Embedded How-to Guides.

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

GET /api/v1/destination_connect_links?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 connect links.

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

integerrequired

The unique ID associated with the Connect Link.

example:

469

type

string

The type of destination connection to be managed by this link. A valid type is the service_name of a connector returned from the /connectors endpoint, where the connector is marked as creatable_via_connect_link.

example:

hubspot

expiration

stringrequired

The date and time when the Connect Link will expire.

format:

date-time

example:

2023-07-22T23:42:47.239Z

expired

boolean

A boolean value indicating whether the Connect Link has expired or not. Expiration settings can be adjusted in the Organization Dashboard.

revoked

booleanrequired

A boolean value indicating whether the Connect Link has been revoked or not.

uri

stringrequired

The authorization url that you will provide to end-users that begins the Census-hosted flow to authorize a destination into your workspace.

format:

uri

example:

https://app.getcensus.com/pbc?auth=expiring_auth_key

redirect_uri

string | null

The redirect URI, if any, associated with the Connect Link. The URL that you'd like the end-user to be redirected to after authorizing the destination. We do not forward the OAuth code or token to this url. The redirect URI can be configured globally under your organization settings in the Census UI or on dynamically via the API when creating a Connect Link.

format:

uri

destination_id

integer | null

The ID of the destination, if any, created or updated from this connect link.

{
  "status": "success",
  "pagination": {
    "total_records": 14,
    "per_page": 25,
    "prev_page": 1,
    "page": 2,
    "next_page": 3,
    "last_page": 10
  },
  "data": [
    {
      "id": 469,
      "type": "hubspot",
      "expiration": "2023-07-22T23:42:47.239Z",
      "expired": false,
      "revoked": false,
      "uri": "https://app.getcensus.com/pbc?auth=expiring_auth_key",
      "redirect_uri": "http://example.com",
      "destination_id": 0
    }
  ]
}