table-sources

Create a table fed by an integration

Create the table, its imported-record column and a few extracted columns, then start loading rows in the background.

The table exists as soon as this returns, so the client can navigate to it immediately and watch rows arrive. Poll the run to follow progress.

Every record lands whole in one Object column. The extracted columns are formulas reading paths out of it, so a refresh updates them for free, and any field the import brought back can be given its own column later without re-fetching anything.

identity_field picks which of the preview's identity_field_choices rows are matched on across refreshes; left out, the preview's recommended one is used. A key some records lack or records share is refused with a 422.

post/table-sources/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/table-sources/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Request body

folder_idstring uuid nullable

The folder to make the table in, as when the import starts from inside one on the Tables list. Leave it out for the top level.

identity_fieldstring nullable

Which id key to match rows on, one of the preview's identity_field_choices. Null takes the preview's recommended identity_field. A key some records lack, or one records share, is refused.

integration_idstring uuid required

The connected integration to import from.

promote_pathsstring[] nullable

Fields to give their own column, in this order. Null uses the preview's suggestions; an empty list promotes nothing. Unknown paths are skipped; the table's column limit is the only ceiling.

record_typestring required

Which object to import.

row_limitinteger nullable

Most rows one run may pull; null for everything. A limited source can never sweep deletions: it cannot tell a record it chose not to fetch from one that is gone.

table_namestring required

Name for the new table.

Response

Successful Response

table_idstring uuid required

Navigate here immediately; rows arrive behind you.

Changes

No recorded changes to this operation across all 1 revision of this API.