Fetch destination connect link

curl --request GET \
  --url https://app.getcensus.com/api/v1/destination_connect_links/{connect_link_id} \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "data": {
    "id": 469,
    "expiration": "2023-07-22T23:42:47.239Z",
    "revoked": false,
    "uri": "https://app.getcensus.com/pbc?auth=expiring_auth_key",
    "type": "hubspot",
    "expired": false,
    "redirect_uri": "<string>",
    "destination_id": 123
  }
}

GET

destination_connect_links

{connect_link_id}

Fetch destination connect link

curl --request GET \
  --url https://app.getcensus.com/api/v1/destination_connect_links/{connect_link_id} \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "data": {
    "id": 469,
    "expiration": "2023-07-22T23:42:47.239Z",
    "revoked": false,
    "uri": "https://app.getcensus.com/pbc?auth=expiring_auth_key",
    "type": "hubspot",
    "expired": false,
    "redirect_uri": "<string>",
    "destination_id": 123
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

connect_link_id

integer

required

ID of the connect link

Response

Successfully retrieved destination connect link details.

status

enum<string>

required

The outcome of the fetch request

Available options:

success

Example:

"success"

data

object

required

Show child attributes

data.id

integer

required

The unique ID associated with the Connect Link.

Example:

469

data.expiration

string<date-time>

required

The date and time when the Connect Link will expire.

Example:

"2023-07-22T23:42:47.239Z"

data.revoked

boolean

required

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

Example:

false

data.uri

string<uri>

required

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

Example:

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

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

data.expired

boolean

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

Example:

false

data.redirect_uri

string<uri> | 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.

data.destination_id

integer | null

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

Create a new destination connect link Revoke a destination connect link

⌘I

Introduction

Organization APIs

Workspace APIs

Fetch destination connect link

Authorizations

Path Parameters

Response