Skip to main content
POST
List the fields a synced action's data can be queried by

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id
string
required

The account identifier

Body

application/json
action
string
required

The synced action to list queryable fields for

Example:

"hris_list_employees"

Response

The queryable fields and the readable syncs of the action.

action_id
string
required

The action the fields belong to.

fields
object[]
required

Fields discovered from this account's synced records. Empty when the action has no readable sync yet.

syncs
object[]
required

Each readable sync of the action, with its freshness.

synced_at
string | null

Present only when there is exactly one readable sync: when it was synced.

expires_at
string | null

Present only when there is exactly one readable sync: when it expires.