List Topics

List Topics

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

{
  "status": "success",
  "pagination": {
    "total_records": 14,
    "per_page": 25,
    "prev_page": 1,
    "page": 2,
    "next_page": 3,
    "last_page": 10
  },
  "data": [
    {
      "id": 18,
      "name": "NewAppUsers",
      "description": "Users that have signed up for our product in the last week.",
      "created_at": "2021-10-20T02:43:07.120Z",
      "updated_at": "2021-10-20T02:50:35.477Z",
      "schema": {
        "name": "string",
        "id": "number",
        "email": "string"
      }
    }
  ]
}

GET

sources

{source_id}

topics

List Topics

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

{
  "status": "success",
  "pagination": {
    "total_records": 14,
    "per_page": 25,
    "prev_page": 1,
    "page": 2,
    "next_page": 3,
    "last_page": 10
  },
  "data": [
    {
      "id": 18,
      "name": "NewAppUsers",
      "description": "Users that have signed up for our product in the last week.",
      "created_at": "2021-10-20T02:43:07.120Z",
      "updated_at": "2021-10-20T02:50:35.477Z",
      "schema": {
        "name": "string",
        "id": "number",
        "email": "string"
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

source_id

integer

required

ID of the source

Response

Successfully retrieved the list of topics.

A successfully fetched list of results.

status

enum<string>

required

The outcome of the request

Available options:

success

Example:

"success"

pagination

object

required

An object to help you navigate the list of results.

Show child attributes

pagination.total_records

number

Total records in the collection.

Example:

14

pagination.per_page

number

default:25

Records on each page.

Example:

25

pagination.prev_page

number | null

The previous page number, or null for the first page.

Example:

1

pagination.page

number

default:1

The current page number.

Example:

2

pagination.next_page

number | null

The next page number, or null if it's the last page.

Example:

3

pagination.last_page

number

The number of the last page with records.

Example:

10

data

object[]

required

The list of results.

Show child attributes

data.id

integer

The id of this topic.

Example:

18

data.name

string

The name of this topic.

Example:

"NewAppUsers"

data.description

string

The description for this topic.

Example:

"Users that have signed up for our product in the last week."

data.created_at

string<date-time>

When this topic was created.

Example:

"2021-10-20T02:43:07.120Z"

data.updated_at

string<date-time>

When this topic was last updated.

Example:

"2021-10-20T02:50:35.477Z"

data.schema

object

The fields available to be used in syncs, extracted from the sample message along with their respective types

Example:

{
  "name": "string",
  "id": "number",
  "email": "string"
}

Check column refresh Create a new topic

⌘I

Introduction

Organization APIs

Workspace APIs

Authorizations

Path Parameters

Response