Skip to main content
GET
/
models
List models
curl --request GET \
  --url https://api.prequel.co/models \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://api.prequel.co/models"

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.prequel.co/models', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.prequel.co/models",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.prequel.co/models"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-API-KEY", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.prequel.co/models")
.header("X-API-KEY", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.prequel.co/models")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "status": "<string>",
  "data": {
    "models": [
      {
        "model_name": "<string>",
        "columns": [
          {
            "name_in_source": "<string>",
            "name_in_destination": "<string>",
            "data_type": "<string>",
            "is_primary_key": true,
            "is_last_modified": true
          }
        ],
        "source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "description": "<string>",
        "source_table": "<string>",
        "source_query": "<string>",
        "destination_table_name": "<string>",
        "organization_column": "<string>",
        "skip_transfer_source_validation": false,
        "is_append_only": true,
        "model_validation_id_in_provider_system": "<string>",
        "model_validation_start_time_epoch": "2023-11-07T05:31:56Z",
        "model_validation_end_time_epoch": "2023-11-07T05:31:56Z",
        "model_validation_tags": {}
      }
    ]
  },
  "message": "<string>",
  "has_next": true,
  "next_url": "<string>"
}
{
"status": "<string>",
"message": "<string>",
"data": null
}
{
"status": "<string>",
"message": "<string>",
"data": null
}
{
"status": "<string>",
"message": "<string>",
"data": null
}
{
"status": "<string>",
"message": "<string>",
"data": null
}

Authorizations

X-API-KEY
string
header
required

Query Parameters

model_name
string

Model name. Multiple values can be provided as a comma-separated string.

product_name
string

Product name. Multiple values can be provided as a comma-separated string.

page_size
integer

Number of items to return per page.

order
enum<string>

Sort order for items

Available options:
asc,
desc
cursor
string

Used for pagination - represents last page seen. Value is included in response when there is a next page.

Response

OK

status
string
required
Allowed value: "success"
data
object
required
message
string
required
has_next
boolean
required

Whether there are more items beyond this page.

next_url
string

Full URL to fetch the next page. Only present when has_next is true.