GET
/
sources
/
{source_id}
/
objects
curl --request GET \
  --url https://app.getcensus.com/api/v1/sources/{source_id}/objects \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "columns": [
        {
          "name": "user_id",
          "type": "character varying (256)"
        },
        {
          "name": "full_name",
          "type": "character varying (256)"
        }
      ],
      "compiled_query": "null",
      "created_at": "2021-10-20T02:43:07.120Z",
      "description": "Users that have signed up for our product in the last week.",
      "id": 18,
      "name": "New App Users",
      "query": "SELECT * FROM \"users\"",
      "source_object_id": 20,
      "type": "model",
      "updated_at": "2021-10-20T02:50:35.477Z"
    }
  ],
  "pagination": {
    "last_page": 10,
    "next_page": 3,
    "page": 2,
    "per_page": 25,
    "prev_page": 1,
    "total_records": 14
  },
  "status": "success"
}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

source_id
integer
required

ID of the source

Query Parameters

page
number
default: 1

Designates which page of results to return. Always starts at 1. If 0 is specified, it defaults to 1.

per_page
number
default: 25

Determines the number of results on each page. It can't exceed 100.

order
enum<string>
default: desc

Organizes the results based on their creation time, either ascending or descending.

Available options:
asc,
desc

Response

200 - application/json
data
object[]
required

A list of source objects that this connection contains. May be either a Model, Segment, or Table.

  • Option 1

  • Option 2

  • Option 3

pagination
object
required

An object to help you navigate the list of results.

status
enum<string>
required

The outcome of the request

Available options:
success