Skip to main content
API docs by Redocly

PostgREST API (12.2.11)

Download OpenAPI specification:Download

This is a dynamic API generated by PostgREST

PostgREST Documentation

Introspection

OpenAPI description (this document)

Responses

table_history

/table_history

query Parameters
id
string
tenant_id
string
dataset_id
string
name
string
schema
string
created_at
string
changed_at
string
action
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/table_history

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

table_history

id
required
string <uuid>
tenant_id
required
string <uuid>
dataset_id
required
string <uuid>
name
required
string <text>
schema
required
any <jsonb>
created_at
string <timestamp without time zone>
changed_at
string <timestamp without time zone>
Default: "now()"
action
required
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0",
  • "name": "string",
  • "schema": null,
  • "created_at": "string",
  • "changed_at": "now()",
  • "action": "string"
}

/table_history

query Parameters
id
string
tenant_id
string
dataset_id
string
name
string
schema
string
created_at
string
changed_at
string
action
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/table_history

query Parameters
id
string
tenant_id
string
dataset_id
string
name
string
schema
string
created_at
string
changed_at
string
action
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

table_history

id
required
string <uuid>
tenant_id
required
string <uuid>
dataset_id
required
string <uuid>
name
required
string <text>
schema
required
any <jsonb>
created_at
string <timestamp without time zone>
changed_at
string <timestamp without time zone>
Default: "now()"
action
required
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0",
  • "name": "string",
  • "schema": null,
  • "created_at": "string",
  • "changed_at": "now()",
  • "action": "string"
}

dataset_history

/dataset_history

query Parameters
id
string
tenant_id
string
project_id
string
name
string
description
string
created_at
string
changed_at
string
action
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/dataset_history

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

dataset_history

id
required
string <uuid>
tenant_id
required
string <uuid>
project_id
required
string <uuid>
name
required
string <text>
description
string <text>
created_at
string <timestamp without time zone>
changed_at
string <timestamp without time zone>
Default: "now()"
action
required
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "name": "string",
  • "description": "string",
  • "created_at": "string",
  • "changed_at": "now()",
  • "action": "string"
}

/dataset_history

query Parameters
id
string
tenant_id
string
project_id
string
name
string
description
string
created_at
string
changed_at
string
action
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/dataset_history

query Parameters
id
string
tenant_id
string
project_id
string
name
string
description
string
created_at
string
changed_at
string
action
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

dataset_history

id
required
string <uuid>
tenant_id
required
string <uuid>
project_id
required
string <uuid>
name
required
string <text>
description
string <text>
created_at
string <timestamp without time zone>
changed_at
string <timestamp without time zone>
Default: "now()"
action
required
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "name": "string",
  • "description": "string",
  • "created_at": "string",
  • "changed_at": "now()",
  • "action": "string"
}

export_job_history

/export_job_history

query Parameters
id
string
tenant_id
string
table_id
string
status
string
created_at
string
changed_at
string
action
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/export_job_history

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

export_job_history

id
required
string <uuid>
tenant_id
required
string <uuid>
table_id
required
string <uuid>
status
required
string <text>
created_at
string <timestamp without time zone>
changed_at
string <timestamp without time zone>
Default: "now()"
action
required
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "table_id": "ac92386a-00cc-4818-bf43-1a666d5a5e67",
  • "status": "string",
  • "created_at": "string",
  • "changed_at": "now()",
  • "action": "string"
}

/export_job_history

query Parameters
id
string
tenant_id
string
table_id
string
status
string
created_at
string
changed_at
string
action
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/export_job_history

query Parameters
id
string
tenant_id
string
table_id
string
status
string
created_at
string
changed_at
string
action
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

export_job_history

id
required
string <uuid>
tenant_id
required
string <uuid>
table_id
required
string <uuid>
status
required
string <text>
created_at
string <timestamp without time zone>
changed_at
string <timestamp without time zone>
Default: "now()"
action
required
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "table_id": "ac92386a-00cc-4818-bf43-1a666d5a5e67",
  • "status": "string",
  • "created_at": "string",
  • "changed_at": "now()",
  • "action": "string"
}

table

/table

query Parameters
id
string
tenant_id
string
dataset_id
string
name
string
schema
string
created_at
string
archived_at
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/table

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

table

id
required
string <uuid>
Default: "gen_random_uuid()"

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Note: This is a Foreign Key to tenant.id.

dataset_id
required
string <uuid>

Note: This is a Foreign Key to dataset.id.

name
required
string <text>
schema
required
any <jsonb>
created_at
string <timestamp without time zone>
Default: "now()"
archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0",
  • "name": "string",
  • "schema": null,
  • "created_at": "now()",
  • "archived_at": "string"
}

/table

query Parameters
id
string
tenant_id
string
dataset_id
string
name
string
schema
string
created_at
string
archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/table

query Parameters
id
string
tenant_id
string
dataset_id
string
name
string
schema
string
created_at
string
archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

table

id
required
string <uuid>
Default: "gen_random_uuid()"

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Note: This is a Foreign Key to tenant.id.

dataset_id
required
string <uuid>

Note: This is a Foreign Key to dataset.id.

name
required
string <text>
schema
required
any <jsonb>
created_at
string <timestamp without time zone>
Default: "now()"
archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "dataset_id": "8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0",
  • "name": "string",
  • "schema": null,
  • "created_at": "now()",
  • "archived_at": "string"
}

import_job_history

/import_job_history

query Parameters
id
string
tenant_id
string
table_id
string
status
string
created_at
string
changed_at
string
action
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/import_job_history

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

import_job_history

id
required
string <uuid>
tenant_id
required
string <uuid>
table_id
required
string <uuid>
status
required
string <text>
created_at
string <timestamp without time zone>
changed_at
string <timestamp without time zone>
Default: "now()"
action
required
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "table_id": "ac92386a-00cc-4818-bf43-1a666d5a5e67",
  • "status": "string",
  • "created_at": "string",
  • "changed_at": "now()",
  • "action": "string"
}

/import_job_history

query Parameters
id
string
tenant_id
string
table_id
string
status
string
created_at
string
changed_at
string
action
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/import_job_history

query Parameters
id
string
tenant_id
string
table_id
string
status
string
created_at
string
changed_at
string
action
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

import_job_history

id
required
string <uuid>
tenant_id
required
string <uuid>
table_id
required
string <uuid>
status
required
string <text>
created_at
string <timestamp without time zone>
changed_at
string <timestamp without time zone>
Default: "now()"
action
required
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "table_id": "ac92386a-00cc-4818-bf43-1a666d5a5e67",
  • "status": "string",
  • "created_at": "string",
  • "changed_at": "now()",
  • "action": "string"
}

query_job

/query_job

query Parameters
id
string
tenant_id
string
query_id
string
bigquery_job_id
string
status
string
error_result
string
error_details
string
created
string
started
string
ended
string
total_rows
string
total_bytes_processed
string
total_slot_ms
string
cache_hit
string
dml_stats
string
query_plan
string
timeline
string
destination_table
string
num_dml_affected_rows
string
script_statistics
string
session_info
string
transaction_info
string
reservation_usage
string
created_at
string
updated_at
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/query_job

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

query_job

id
required
string <uuid>
Default: "gen_random_uuid()"

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Note: This is a Foreign Key to tenant.id.

query_id
required
string <uuid>

Note: This is a Foreign Key to query.id.

bigquery_job_id
required
string <text>
status
required
string <text>
error_result
any <jsonb>
error_details
any <jsonb>
created
string <timestamp without time zone>
started
string <timestamp without time zone>
ended
string <timestamp without time zone>
total_rows
integer <bigint>
total_bytes_processed
integer <bigint>
total_slot_ms
integer <bigint>
cache_hit
boolean <boolean>
dml_stats
any <jsonb>
query_plan
any <jsonb>
timeline
any <jsonb>
destination_table
any <jsonb>
num_dml_affected_rows
integer <bigint>
script_statistics
any <jsonb>
session_info
any <jsonb>
transaction_info
any <jsonb>
reservation_usage
any <jsonb>
created_at
string <timestamp without time zone>
Default: "now()"
updated_at
string <timestamp without time zone>
Default: "now()"

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "query_id": "6fa29c22-6bab-424a-859e-a13a5c607e72",
  • "bigquery_job_id": "string",
  • "status": "string",
  • "error_result": null,
  • "error_details": null,
  • "created": "string",
  • "started": "string",
  • "ended": "string",
  • "total_rows": 0,
  • "total_bytes_processed": 0,
  • "total_slot_ms": 0,
  • "cache_hit": true,
  • "dml_stats": null,
  • "query_plan": null,
  • "timeline": null,
  • "destination_table": null,
  • "num_dml_affected_rows": 0,
  • "script_statistics": null,
  • "session_info": null,
  • "transaction_info": null,
  • "reservation_usage": null,
  • "created_at": "now()",
  • "updated_at": "now()"
}

/query_job

query Parameters
id
string
tenant_id
string
query_id
string
bigquery_job_id
string
status
string
error_result
string
error_details
string
created
string
started
string
ended
string
total_rows
string
total_bytes_processed
string
total_slot_ms
string
cache_hit
string
dml_stats
string
query_plan
string
timeline
string
destination_table
string
num_dml_affected_rows
string
script_statistics
string
session_info
string
transaction_info
string
reservation_usage
string
created_at
string
updated_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/query_job

query Parameters
id
string
tenant_id
string
query_id
string
bigquery_job_id
string
status
string
error_result
string
error_details
string
created
string
started
string
ended
string
total_rows
string
total_bytes_processed
string
total_slot_ms
string
cache_hit
string
dml_stats
string
query_plan
string
timeline
string
destination_table
string
num_dml_affected_rows
string
script_statistics
string
session_info
string
transaction_info
string
reservation_usage
string
created_at
string
updated_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

query_job

id
required
string <uuid>
Default: "gen_random_uuid()"

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Note: This is a Foreign Key to tenant.id.

query_id
required
string <uuid>

Note: This is a Foreign Key to query.id.

bigquery_job_id
required
string <text>
status
required
string <text>
error_result
any <jsonb>
error_details
any <jsonb>
created
string <timestamp without time zone>
started
string <timestamp without time zone>
ended
string <timestamp without time zone>
total_rows
integer <bigint>
total_bytes_processed
integer <bigint>
total_slot_ms
integer <bigint>
cache_hit
boolean <boolean>
dml_stats
any <jsonb>
query_plan
any <jsonb>
timeline
any <jsonb>
destination_table
any <jsonb>
num_dml_affected_rows
integer <bigint>
script_statistics
any <jsonb>
session_info
any <jsonb>
transaction_info
any <jsonb>
reservation_usage
any <jsonb>
created_at
string <timestamp without time zone>
Default: "now()"
updated_at
string <timestamp without time zone>
Default: "now()"

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "query_id": "6fa29c22-6bab-424a-859e-a13a5c607e72",
  • "bigquery_job_id": "string",
  • "status": "string",
  • "error_result": null,
  • "error_details": null,
  • "created": "string",
  • "started": "string",
  • "ended": "string",
  • "total_rows": 0,
  • "total_bytes_processed": 0,
  • "total_slot_ms": 0,
  • "cache_hit": true,
  • "dml_stats": null,
  • "query_plan": null,
  • "timeline": null,
  • "destination_table": null,
  • "num_dml_affected_rows": 0,
  • "script_statistics": null,
  • "session_info": null,
  • "transaction_info": null,
  • "reservation_usage": null,
  • "created_at": "now()",
  • "updated_at": "now()"
}

dataset

/dataset

query Parameters
id
string
tenant_id
string
project_id
string
name
string
description
string
created_at
string
archived_at
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/dataset

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

dataset

id
required
string <uuid>
Default: "gen_random_uuid()"

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Note: This is a Foreign Key to tenant.id.

project_id
required
string <uuid>

Note: This is a Foreign Key to project.id.

name
required
string <text>
description
string <text>
created_at
string <timestamp without time zone>
Default: "now()"
archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "name": "string",
  • "description": "string",
  • "created_at": "now()",
  • "archived_at": "string"
}

/dataset

query Parameters
id
string
tenant_id
string
project_id
string
name
string
description
string
created_at
string
archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/dataset

query Parameters
id
string
tenant_id
string
project_id
string
name
string
description
string
created_at
string
archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

dataset

id
required
string <uuid>
Default: "gen_random_uuid()"

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Note: This is a Foreign Key to tenant.id.

project_id
required
string <uuid>

Note: This is a Foreign Key to project.id.

name
required
string <text>
description
string <text>
created_at
string <timestamp without time zone>
Default: "now()"
archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "name": "string",
  • "description": "string",
  • "created_at": "now()",
  • "archived_at": "string"
}

query

/query

query Parameters
id
string
tenant_id
string
project_id
string
query_text
string
created_at
string
archived_at
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/query

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

query

id
required
string <uuid>
Default: "gen_random_uuid()"

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Note: This is a Foreign Key to tenant.id.

project_id
required
string <uuid>

Note: This is a Foreign Key to project.id.

query_text
required
string <text>
created_at
string <timestamp without time zone>
Default: "now()"
archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "query_text": "string",
  • "created_at": "now()",
  • "archived_at": "string"
}

/query

query Parameters
id
string
tenant_id
string
project_id
string
query_text
string
created_at
string
archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/query

query Parameters
id
string
tenant_id
string
project_id
string
query_text
string
created_at
string
archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

query

id
required
string <uuid>
Default: "gen_random_uuid()"

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Note: This is a Foreign Key to tenant.id.

project_id
required
string <uuid>

Note: This is a Foreign Key to project.id.

query_text
required
string <text>
created_at
string <timestamp without time zone>
Default: "now()"
archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "query_text": "string",
  • "created_at": "now()",
  • "archived_at": "string"
}

query_history

/query_history

query Parameters
id
string
tenant_id
string
project_id
string
query_text
string
created_at
string
changed_at
string
action
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/query_history

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

query_history

id
required
string <uuid>
tenant_id
required
string <uuid>
project_id
required
string <uuid>
query_text
required
string <text>
created_at
string <timestamp without time zone>
changed_at
string <timestamp without time zone>
Default: "now()"
action
required
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "query_text": "string",
  • "created_at": "string",
  • "changed_at": "now()",
  • "action": "string"
}

/query_history

query Parameters
id
string
tenant_id
string
project_id
string
query_text
string
created_at
string
changed_at
string
action
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/query_history

query Parameters
id
string
tenant_id
string
project_id
string
query_text
string
created_at
string
changed_at
string
action
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

query_history

id
required
string <uuid>
tenant_id
required
string <uuid>
project_id
required
string <uuid>
query_text
required
string <text>
created_at
string <timestamp without time zone>
changed_at
string <timestamp without time zone>
Default: "now()"
action
required
string <text>

Responses

Request samples

Content type
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  • "query_text": "string",
  • "created_at": "string",
  • "changed_at": "now()",
  • "action": "string"
}

project

/project

query Parameters
id
string
tenant_id
string
name
string
description
string
created_at
string
archived_at
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/project

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

project

id
required
string <uuid>
Default: "gen_random_uuid()"

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Note: This is a Foreign Key to tenant.id.

name
required
string <text>
description
string <text>
created_at
string <timestamp without time zone>
Default: "now()"
archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "name": "string",
  • "description": "string",
  • "created_at": "now()",
  • "archived_at": "string"
}

/project

query Parameters
id
string
tenant_id
string
name
string
description
string
created_at
string
archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/project

query Parameters
id
string
tenant_id
string
name
string
description
string
created_at
string
archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

project

id
required
string <uuid>
Default: "gen_random_uuid()"

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Note: This is a Foreign Key to tenant.id.

name
required
string <text>
description
string <text>
created_at
string <timestamp without time zone>
Default: "now()"
archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "name": "string",
  • "description": "string",
  • "created_at": "now()",
  • "archived_at": "string"
}

tenant

/tenant

query Parameters
id
string
name
string
auth0_org_id
string
created_at
string
archived_at
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/tenant

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

tenant

id
required
string <uuid>
Default: "gen_random_uuid()"

Note: This is a Primary Key.

name
required
string <text>
auth0_org_id
string <text>
created_at
string <timestamp without time zone>
Default: "now()"
archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "name": "string",
  • "auth0_org_id": "string",
  • "created_at": "now()",
  • "archived_at": "string"
}

/tenant

query Parameters
id
string
name
string
auth0_org_id
string
created_at
string
archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/tenant

query Parameters
id
string
name
string
auth0_org_id
string
created_at
string
archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

tenant

id
required
string <uuid>
Default: "gen_random_uuid()"

Note: This is a Primary Key.

name
required
string <text>
auth0_org_id
string <text>
created_at
string <timestamp without time zone>
Default: "now()"
archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "name": "string",
  • "auth0_org_id": "string",
  • "created_at": "now()",
  • "archived_at": "string"
}

user

/user

query Parameters
id
string
tenant_id
string
auth0_id
string
email
string
name
string
role
string
created_at
string
archived_at
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/user

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

user

id
required
string <uuid>
Default: "gen_random_uuid()"

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Note: This is a Foreign Key to tenant.id.

auth0_id
required
string <text>
email
required
string <text>
name
required
string <text>
role
required
string <text>
created_at
string <timestamp without time zone>
Default: "now()"
archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "auth0_id": "string",
  • "email": "string",
  • "name": "string",
  • "role": "string",
  • "created_at": "now()",
  • "archived_at": "string"
}

/user

query Parameters
id
string
tenant_id
string
auth0_id
string
email
string
name
string
role
string
created_at
string
archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/user

query Parameters
id
string
tenant_id
string
auth0_id
string
email
string
name
string
role
string
created_at
string
archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

user

id
required
string <uuid>
Default: "gen_random_uuid()"

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Note: This is a Foreign Key to tenant.id.

auth0_id
required
string <text>
email
required
string <text>
name
required
string <text>
role
required
string <text>
created_at
string <timestamp without time zone>
Default: "now()"
archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "auth0_id": "string",
  • "email": "string",
  • "name": "string",
  • "role": "string",
  • "created_at": "now()",
  • "archived_at": "string"
}

import_job

/import_job

query Parameters
id
string
tenant_id
string
table_id
string
status
string
created_at
string
archived_at
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/import_job

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

import_job

id
required
string <uuid>
Default: "gen_random_uuid()"

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Note: This is a Foreign Key to tenant.id.

table_id
required
string <uuid>

Note: This is a Foreign Key to table.id.

status
required
string <text>
created_at
string <timestamp without time zone>
Default: "now()"
archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "table_id": "ac92386a-00cc-4818-bf43-1a666d5a5e67",
  • "status": "string",
  • "created_at": "now()",
  • "archived_at": "string"
}

/import_job

query Parameters
id
string
tenant_id
string
table_id
string
status
string
created_at
string
archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/import_job

query Parameters
id
string
tenant_id
string
table_id
string
status
string
created_at
string
archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

import_job

id
required
string <uuid>
Default: "gen_random_uuid()"

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Note: This is a Foreign Key to tenant.id.

table_id
required
string <uuid>

Note: This is a Foreign Key to table.id.

status
required
string <text>
created_at
string <timestamp without time zone>
Default: "now()"
archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "table_id": "ac92386a-00cc-4818-bf43-1a666d5a5e67",
  • "status": "string",
  • "created_at": "now()",
  • "archived_at": "string"
}

export_job

/export_job

query Parameters
id
string
tenant_id
string
table_id
string
status
string
created_at
string
archived_at
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

header Parameters
Range
string

Limiting and Pagination

Range-Unit
string
Default: items

Limiting and Pagination

Prefer
string
Value: "count=none"

Preference

Responses

Response samples

Content type
[
  • {
    }
]

/export_job

query Parameters
select
string

Filtering Columns

header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none" "resolution=ignore-duplicates" "resolution=merge-duplicates"

Preference

Request Body schema:

export_job

id
required
string <uuid>
Default: "gen_random_uuid()"

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Note: This is a Foreign Key to tenant.id.

table_id
required
string <uuid>

Note: This is a Foreign Key to table.id.

status
required
string <text>
created_at
string <timestamp without time zone>
Default: "now()"
archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "table_id": "ac92386a-00cc-4818-bf43-1a666d5a5e67",
  • "status": "string",
  • "created_at": "now()",
  • "archived_at": "string"
}

/export_job

query Parameters
id
string
tenant_id
string
table_id
string
status
string
created_at
string
archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Responses

/export_job

query Parameters
id
string
tenant_id
string
table_id
string
status
string
created_at
string
archived_at
string
header Parameters
Prefer
string
Enum: "return=representation" "return=minimal" "return=none"

Preference

Request Body schema:

export_job

id
required
string <uuid>
Default: "gen_random_uuid()"

Note: This is a Primary Key.

tenant_id
required
string <uuid>

Note: This is a Foreign Key to tenant.id.

table_id
required
string <uuid>

Note: This is a Foreign Key to table.id.

status
required
string <text>
created_at
string <timestamp without time zone>
Default: "now()"
archived_at
string <timestamp without time zone>

Responses

Request samples

Content type
{
  • "id": "gen_random_uuid()",
  • "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  • "table_id": "ac92386a-00cc-4818-bf43-1a666d5a5e67",
  • "status": "string",
  • "created_at": "now()",
  • "archived_at": "string"
}