Airbyte Configuration API
airbyte · Company
Airbyte Configuration API [https://airbyte.io](https://airbyte.io). This API is a collection of HTTP RPC-style methods. While it is not a REST API, those familiar with REST should find the conventions of this API recognizable. Here are some conventions that this API follows: * All endpoints are http POST methods. * All endpoints accept data via `application/json` request bodies. The API does not accept any data via query params. * The naming convention for endpoints is: localhost:8000/{VERSION
Authentication
Sample Requests
Health Check
Hover any highlighted part to learn what it does
curl -X GET "https://api.apis.guru/v2/specs/airbyte.local/config/1.0.0/v1/health"
import requests
response = requests.get(
"https://api.apis.guru/v2/specs/airbyte.local/config/1.0.0/v1/health",
)
print(response.json())const url = 'https://api.apis.guru/v2/specs/airbyte.local/config/1.0.0/v1/health'; const response = await fetch(url); const data = await response.json(); console.log(data);
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
targetURL := "https://api.apis.guru/v2/specs/airbyte.local/config/1.0.0/v1/health"
req, _ := http.NewRequest("GET", targetURL, nil)
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/airbyte.local/config/1.0.0/v1/health")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Get.new(uri)
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/airbyte.local/config/1.0.0/v1/health";
$opts = ["http" => [
"method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));Returns the openapi specification
Hover any highlighted part to learn what it does
curl -X GET "https://api.apis.guru/v2/specs/airbyte.local/config/1.0.0/v1/openapi"
import requests
response = requests.get(
"https://api.apis.guru/v2/specs/airbyte.local/config/1.0.0/v1/openapi",
)
print(response.json())const url = 'https://api.apis.guru/v2/specs/airbyte.local/config/1.0.0/v1/openapi'; const response = await fetch(url); const data = await response.json(); console.log(data);
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
targetURL := "https://api.apis.guru/v2/specs/airbyte.local/config/1.0.0/v1/openapi"
req, _ := http.NewRequest("GET", targetURL, nil)
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/airbyte.local/config/1.0.0/v1/openapi")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Get.new(uri)
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/airbyte.local/config/1.0.0/v1/openapi";
$opts = ["http" => [
"method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));For worker to set sync stats of a running attempt.
Hover any highlighted part to learn what it does
curl -X POST "https://api.apis.guru/v2/specs/airbyte.local/config/1.0.0/v1/attempt/save_stats"
import requests
response = requests.post(
"https://api.apis.guru/v2/specs/airbyte.local/config/1.0.0/v1/attempt/save_stats",
)
print(response.json())const url = 'https://api.apis.guru/v2/specs/airbyte.local/config/1.0.0/v1/attempt/save_stats';
const response = await fetch(url, {
method: 'POST',
});
const data = await response.json();
console.log(data);package main
import (
"fmt"
"io"
"net/http"
)
func main() {
targetURL := "https://api.apis.guru/v2/specs/airbyte.local/config/1.0.0/v1/attempt/save_stats"
req, _ := http.NewRequest("POST", targetURL, nil)
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require "net/http"
require "json"
uri = URI("https://api.apis.guru/v2/specs/airbyte.local/config/1.0.0/v1/attempt/save_stats")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
req = Net::HTTP::Post.new(uri)
res = http.request(req)
puts JSON.parse(res.body)<?php
$url = "https://api.apis.guru/v2/specs/airbyte.local/config/1.0.0/v1/attempt/save_stats";
$opts = ["http" => [
"method" => "POST",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));Postman Setup Guide
- See official documentation for authentication and setup.
What can you build with Airbyte Configuration API?
Airbyte Configuration API is a Company API. Developers commonly use company APIs for:
- enriching CRM records with company firmographics
- building lead-generation and prospecting tools
- verifying business identity and registration details
- monitoring competitors and market intelligence
- powering B2B data enrichment pipelines
No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. Airbyte Configuration API is free to use, making it a low-risk choice to experiment with.
New to APIs? Read our beginner's guide · Learn about API keys · What is REST?