List columns

This endpoint returns the paginated list of columns for a table identified by catalog, schema, and table name.

Cached columns will be returned if they exist, along with the timestamp of when they were last refreshed from the source.

Columns can be refreshed from the source using the refresh_columns endpoint.

Request schema

Path parameters

source_id

integerrequired

ID of the source

Query parameters

table_catalog

stringrequired

The catalog name of the table (e.g., database name in some systems).

table_schema

stringrequired

The schema name of the table.

table_name

stringrequired

The table name.

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/{source_id}/tables/columns

GET /api/v1/sources/{source_id}/tables/columns?table_catalog=SOME_STRING_VALUE&table_schema=SOME_STRING_VALUE&table_name=SOME_STRING_VALUE&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 columns.

202

Columns have not been loaded yet. Kicking off a job to fetch them.

400

Failed to refresh source table columns.

`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

List of columns in the table

name

stringrequired

The name of the column

example:

data_type

stringrequired

The data type of the column

example:

string

can_be_upsert_key

booleanrequired

Indicates if the column can be used as an upsert key

example:

true

last_refreshed_at

string

Timestamp of when the columns were last refreshed from the source table

format:

date-time

example:

2025-10-30T21:38:51.424Z

`202`

status

string

example:

processing

`400`

status

string

example:

error

message

string

example:

Failed to refresh source table columns

{
  "status": "success",
  "pagination": {
    "total_records": 14,
    "per_page": 25,
    "prev_page": 1,
    "page": 2,
    "next_page": 3,
    "last_page": 10
  },
  "data": [
    {
      "name": "email",
      "data_type": "string",
      "can_be_upsert_key": true
    }
  ],
  "last_refreshed_at": "2025-10-30T21:38:51.424Z"
}