List extracted filing forms
curl --request GET \
--url https://canary.effectiveai.app/api/v2/filings/{filingId}/forms \
--header 'Authorization: Bearer <token>'import requests
url = "https://canary.effectiveai.app/api/v2/filings/{filingId}/forms"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://canary.effectiveai.app/api/v2/filings/{filingId}/forms', 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://canary.effectiveai.app/api/v2/filings/{filingId}/forms",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://canary.effectiveai.app/api/v2/filings/{filingId}/forms"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://canary.effectiveai.app/api/v2/filings/{filingId}/forms")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://canary.effectiveai.app/api/v2/filings/{filingId}/forms")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"filingId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"forms": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"formNumber": "<string>",
"formName": "<string>",
"editionDate": "2023-12-25",
"formType": "<string>",
"formTypeNormalized": "<string>",
"formAction": "<string>",
"previousFilingNumber": "<string>",
"replacedFormNumber": "<string>",
"replacedEditionDate": "2023-12-25",
"applicableStates": [
"<string>"
],
"topicTags": [
"<string>"
],
"file": {
"fileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"versionId": "<string>"
}
}
],
"nextCursor": "<string>",
"availability": {
"sourceSupported": true,
"sourceCompleteness": "unknown"
}
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>"
}Filings
List extracted filing forms
Read stored SERFF form-schedule metadata in live row-ID order. No acquisition or extraction is started. Empty results do not establish that the filing has no forms. Keep filing ID and limit unchanged when continuing; cursors expire after 24 hours. Re-extraction can replace row IDs, so deduplicate or restart for a fresh view.
GET
/
filings
/
{filingId}
/
forms
List extracted filing forms
curl --request GET \
--url https://canary.effectiveai.app/api/v2/filings/{filingId}/forms \
--header 'Authorization: Bearer <token>'import requests
url = "https://canary.effectiveai.app/api/v2/filings/{filingId}/forms"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://canary.effectiveai.app/api/v2/filings/{filingId}/forms', 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://canary.effectiveai.app/api/v2/filings/{filingId}/forms",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://canary.effectiveai.app/api/v2/filings/{filingId}/forms"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://canary.effectiveai.app/api/v2/filings/{filingId}/forms")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://canary.effectiveai.app/api/v2/filings/{filingId}/forms")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"filingId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"forms": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"formNumber": "<string>",
"formName": "<string>",
"editionDate": "2023-12-25",
"formType": "<string>",
"formTypeNormalized": "<string>",
"formAction": "<string>",
"previousFilingNumber": "<string>",
"replacedFormNumber": "<string>",
"replacedEditionDate": "2023-12-25",
"applicableStates": [
"<string>"
],
"topicTags": [
"<string>"
],
"file": {
"fileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"versionId": "<string>"
}
}
],
"nextCursor": "<string>",
"availability": {
"sourceSupported": true,
"sourceCompleteness": "unknown"
}
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"details": [
{
"location": "path",
"path": [
"<string>"
],
"code": "required",
"message": "<string>"
}
],
"requestId": "<string>"
}Authorizations
Effective API key. Send Authorization: Bearer sk-eai-...
Path Parameters
Query Parameters
Required range:
1 <= x <= 200Required string length:
1 - 128