Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Census Syncs API

The Syncs API from Census — 3 operation(s) for syncs.

Census Syncs API is one of 7 APIs that Census publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Syncs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 3 paths, and defines 9 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://app.getcensus.com/api/v1.

6 operations 3 paths 9 schemas 1 DELETE2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://app.getcensus.com/api/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Census Syncs API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Workspace API access token passed as a Bearer token.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Syncs 6
GET
/syncs
List syncs
listSyncs 3 params → 200
POST
/syncs
Create a sync
createSync body → 201
GET
/syncs/{sync_id}
Fetch a sync
getSync 1 param → 200
PATCH
/syncs/{sync_id}
Update a sync
updateSync 1 param body → 200
DELETE
/syncs/{sync_id}
Delete a sync
deleteSync 1 param → 200
POST
/syncs/{sync_id}/trigger
Trigger a sync run
triggerSync 1 param body → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Sync (9 properties), SyncCreate (6 properties), SyncUpdate (4 properties), SyncList (3 properties). Each schema is shown below with its type and property counts.

SyncUpdate
object
4 properties
TriggerResponse
object
2 properties
FieldMapping
object
3 properties
StatusResponse
object
1 property
SyncList
object
3 properties
Sync
object
9 properties
SyncCreate
object
6 properties 4 required
SyncResponse
object
2 properties
Pagination
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

census-ci-syncs-api-openapi.yml Raw ↑

Other APIs Census publishes across the network.

Census Connectors API
Census Datasets and Models API
Census Destinations API
Census Segments API
Census Sources API
Census Sync Runs API