List your companies - filterable, sortable, cursor-paged
curl --request GET \
--url https://api.clemta.com/v1/companies \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.clemta.com/v1/companies"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.clemta.com/v1/companies', 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.clemta.com/v1/companies",
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://api.clemta.com/v1/companies"
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://api.clemta.com/v1/companies")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clemta.com/v1/companies")
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{
"object": "list",
"page": {
"start_cursor": "<string>",
"end_cursor": "<string>",
"has_next_page": true,
"has_prev_page": true,
"limit": 50,
"total": 1
},
"items": [
{
"object": "company",
"id": "cmp_0346sFPEvSkJvY8vt14NNw",
"account_id": "acct_0346sFPEvSkJvY8vt14NNw",
"livemode": true,
"name": "<string>",
"state": "DE",
"entity_type": "llc",
"status": "requires_information",
"verification": "pending",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"external_id": "<string>",
"account": {
"object": "account",
"id": "acct_0346sFPEvSkJvY8vt14NNw",
"livemode": true,
"first_name": "<string>",
"last_name": "<string>",
"email": "[email protected]",
"created_at": "2023-11-07T05:31:56Z",
"external_id": "<string>",
"phone": "<string>",
"metadata": {}
},
"ending": "<string>",
"industry": "<string>",
"industry_description": "<string>",
"custom_industry": "<string>",
"timezone": "<string>",
"name_style": "plain",
"legal_name": "<string>",
"owner_privacy": "public",
"pre_existing": true,
"ein": "<string>",
"verified_at": "2023-11-07T05:31:56Z",
"dissolved_at": "2023-11-07T05:31:56Z",
"incorporated_at": "2023-11-07T05:31:56Z",
"ein_assigned_at": "2023-11-07T05:31:56Z",
"stage": "preparing_documents",
"incorporation_date": "<string>",
"address": {
"country": "<string>",
"line1": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"line2": "<string>"
},
"foreign_qualifications": [
{
"state": "DE",
"line1": "<string>",
"city": "<string>",
"postal_code": "<string>",
"line2": "<string>"
}
],
"entitlements": {
"federal_tax_filing": 1,
"state_tax_filing": 0
},
"open_requirements": 123,
"service_orders": [
{
"object": "service_order",
"id": "so_0346sFPEvSkJvY8vt14NNw",
"company": "<string>",
"product_key": "ein",
"status": "received",
"unit_amount": 7900,
"currency": "usd",
"created_at": "2023-11-07T05:31:56Z",
"interval": "one_time",
"options": {
"llc_members": "multi_member"
},
"form_required": true,
"workflow_status": "<string>",
"form": {
"fields": [
{
"field_name": "<string>",
"field_type": "text",
"key": "<string>",
"required": true,
"options": [
"<string>"
],
"guidance": "<string>",
"help": "<string>",
"note": "<string>",
"placeholder": "<string>",
"info_points": [
"<string>"
],
"conditional": {
"field": "<string>",
"values": [
"<string>"
]
},
"validation": {
"pattern": "<string>",
"min_length": 123,
"max_length": 123,
"min": 123,
"max": 123
},
"file": {
"accepted_types": [
"<string>"
],
"max_size_bytes": 123
}
}
],
"title": "<string>",
"warning": "<string>"
},
"quote": {
"state": "pending",
"unit_amount": 123,
"currency": "<string>",
"quoted_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"accepted_at": "2023-11-07T05:31:56Z"
},
"shareholder": "<string>",
"outcome": "<string>",
"included_in": "<string>",
"fees": [
{
"kind": "state_fee",
"unit_amount": 30000,
"currency": "usd"
}
],
"next_renewal_at": "2023-11-07T05:31:56Z",
"renewal_cancel_requested_at": "2023-11-07T05:31:56Z",
"renewal_canceled_at": "2023-11-07T05:31:56Z",
"renewal_ends_at": "2023-11-07T05:31:56Z",
"canceled_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z"
}
],
"requirements": [
{
"object": "requirement",
"id": "rqmt_0346sFPEvSkJvY8vt14NNw",
"company": "<string>",
"type": "document",
"status": "open",
"requested_by": "system",
"livemode": true,
"created_at": "2023-11-07T05:31:56Z",
"service_order": "<string>",
"shareholder": "<string>",
"purpose": "identity_document",
"document_name": "<string>",
"signers": [
{
"ref": "<string>",
"status": "pending_email",
"email": "<string>",
"name": "<string>",
"viewed_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"signed_at": "2023-11-07T05:31:56Z",
"declined_at": "2023-11-07T05:31:56Z"
}
],
"message": "<string>",
"cancel_reason": "<string>",
"form": {
"fields": [
{
"field_name": "<string>",
"field_type": "text",
"key": "<string>",
"required": true,
"options": [
"<string>"
],
"guidance": "<string>",
"help": "<string>",
"note": "<string>",
"placeholder": "<string>",
"info_points": [
"<string>"
],
"conditional": {
"field": "<string>",
"values": [
"<string>"
]
},
"validation": {
"pattern": "<string>",
"min_length": 123,
"max_length": 123,
"min": 123,
"max": 123
},
"file": {
"accepted_types": [
"<string>"
],
"max_size_bytes": 123
}
}
],
"title": "<string>",
"warning": "<string>"
},
"response": [
{
"value": "<unknown>",
"key": "<string>",
"field_name": "<string>"
}
],
"attachments": [
{
"filename": "<string>",
"field": "<string>",
"field_name": "<string>",
"content_type": "<string>",
"size": 123
}
],
"resolved_at": "2023-11-07T05:31:56Z"
}
],
"shareholders": [
{
"object": "shareholder",
"id": "<string>",
"type": "individual",
"relationship": {
"title": "sole_owner",
"custom_title": "<string>",
"percent_ownership": 99,
"representative": true,
"director": true
},
"document": {
"status": "required"
},
"first_name": "<string>",
"last_name": "<string>",
"name": "<string>",
"representative_name": "<string>",
"email": "<string>",
"phone": "<string>",
"phone_country": "<string>",
"tax_id_type": "ssn",
"address": {
"country": "<string>",
"line1": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"line2": "<string>"
}
}
],
"officers": [
{
"object": "officer",
"id": "off_0346sFPEvSkJvY8vt14NNw",
"roles": [
"member"
],
"shareholder": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"title": "<string>",
"source": "onboarding",
"address": {
"country": "<string>",
"line1": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"line2": "<string>"
}
}
],
"management_type": "member_managed",
"officers_settled": true,
"metadata": {}
}
]
}{
"type": "https://docs.clemta.com/partner/errors#resource_already_exists",
"title": "<string>",
"status": 349,
"code": "api_key_invalid",
"detail": "<string>",
"request_id": "<string>",
"errors": [
{
"reason": "<string>",
"location": "<string>",
"validation_type": "<string>",
"how_to_fix": "<string>"
}
]
}{
"type": "https://docs.clemta.com/partner/errors#resource_already_exists",
"title": "<string>",
"status": 349,
"code": "api_key_invalid",
"detail": "<string>",
"request_id": "<string>",
"errors": [
{
"reason": "<string>",
"location": "<string>",
"validation_type": "<string>",
"how_to_fix": "<string>"
}
]
}{
"type": "https://docs.clemta.com/partner/errors#resource_already_exists",
"title": "<string>",
"status": 349,
"code": "api_key_invalid",
"detail": "<string>",
"request_id": "<string>",
"errors": [
{
"reason": "<string>",
"location": "<string>",
"validation_type": "<string>",
"how_to_fix": "<string>"
}
]
}Companies
List your companies - filterable, sortable, cursor-paged
Sort by created_at or name. Filter by any company field, external_id and state included.
GET
/
companies
List your companies - filterable, sortable, cursor-paged
curl --request GET \
--url https://api.clemta.com/v1/companies \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.clemta.com/v1/companies"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.clemta.com/v1/companies', 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.clemta.com/v1/companies",
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://api.clemta.com/v1/companies"
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://api.clemta.com/v1/companies")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clemta.com/v1/companies")
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{
"object": "list",
"page": {
"start_cursor": "<string>",
"end_cursor": "<string>",
"has_next_page": true,
"has_prev_page": true,
"limit": 50,
"total": 1
},
"items": [
{
"object": "company",
"id": "cmp_0346sFPEvSkJvY8vt14NNw",
"account_id": "acct_0346sFPEvSkJvY8vt14NNw",
"livemode": true,
"name": "<string>",
"state": "DE",
"entity_type": "llc",
"status": "requires_information",
"verification": "pending",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"external_id": "<string>",
"account": {
"object": "account",
"id": "acct_0346sFPEvSkJvY8vt14NNw",
"livemode": true,
"first_name": "<string>",
"last_name": "<string>",
"email": "[email protected]",
"created_at": "2023-11-07T05:31:56Z",
"external_id": "<string>",
"phone": "<string>",
"metadata": {}
},
"ending": "<string>",
"industry": "<string>",
"industry_description": "<string>",
"custom_industry": "<string>",
"timezone": "<string>",
"name_style": "plain",
"legal_name": "<string>",
"owner_privacy": "public",
"pre_existing": true,
"ein": "<string>",
"verified_at": "2023-11-07T05:31:56Z",
"dissolved_at": "2023-11-07T05:31:56Z",
"incorporated_at": "2023-11-07T05:31:56Z",
"ein_assigned_at": "2023-11-07T05:31:56Z",
"stage": "preparing_documents",
"incorporation_date": "<string>",
"address": {
"country": "<string>",
"line1": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"line2": "<string>"
},
"foreign_qualifications": [
{
"state": "DE",
"line1": "<string>",
"city": "<string>",
"postal_code": "<string>",
"line2": "<string>"
}
],
"entitlements": {
"federal_tax_filing": 1,
"state_tax_filing": 0
},
"open_requirements": 123,
"service_orders": [
{
"object": "service_order",
"id": "so_0346sFPEvSkJvY8vt14NNw",
"company": "<string>",
"product_key": "ein",
"status": "received",
"unit_amount": 7900,
"currency": "usd",
"created_at": "2023-11-07T05:31:56Z",
"interval": "one_time",
"options": {
"llc_members": "multi_member"
},
"form_required": true,
"workflow_status": "<string>",
"form": {
"fields": [
{
"field_name": "<string>",
"field_type": "text",
"key": "<string>",
"required": true,
"options": [
"<string>"
],
"guidance": "<string>",
"help": "<string>",
"note": "<string>",
"placeholder": "<string>",
"info_points": [
"<string>"
],
"conditional": {
"field": "<string>",
"values": [
"<string>"
]
},
"validation": {
"pattern": "<string>",
"min_length": 123,
"max_length": 123,
"min": 123,
"max": 123
},
"file": {
"accepted_types": [
"<string>"
],
"max_size_bytes": 123
}
}
],
"title": "<string>",
"warning": "<string>"
},
"quote": {
"state": "pending",
"unit_amount": 123,
"currency": "<string>",
"quoted_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"accepted_at": "2023-11-07T05:31:56Z"
},
"shareholder": "<string>",
"outcome": "<string>",
"included_in": "<string>",
"fees": [
{
"kind": "state_fee",
"unit_amount": 30000,
"currency": "usd"
}
],
"next_renewal_at": "2023-11-07T05:31:56Z",
"renewal_cancel_requested_at": "2023-11-07T05:31:56Z",
"renewal_canceled_at": "2023-11-07T05:31:56Z",
"renewal_ends_at": "2023-11-07T05:31:56Z",
"canceled_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z"
}
],
"requirements": [
{
"object": "requirement",
"id": "rqmt_0346sFPEvSkJvY8vt14NNw",
"company": "<string>",
"type": "document",
"status": "open",
"requested_by": "system",
"livemode": true,
"created_at": "2023-11-07T05:31:56Z",
"service_order": "<string>",
"shareholder": "<string>",
"purpose": "identity_document",
"document_name": "<string>",
"signers": [
{
"ref": "<string>",
"status": "pending_email",
"email": "<string>",
"name": "<string>",
"viewed_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"signed_at": "2023-11-07T05:31:56Z",
"declined_at": "2023-11-07T05:31:56Z"
}
],
"message": "<string>",
"cancel_reason": "<string>",
"form": {
"fields": [
{
"field_name": "<string>",
"field_type": "text",
"key": "<string>",
"required": true,
"options": [
"<string>"
],
"guidance": "<string>",
"help": "<string>",
"note": "<string>",
"placeholder": "<string>",
"info_points": [
"<string>"
],
"conditional": {
"field": "<string>",
"values": [
"<string>"
]
},
"validation": {
"pattern": "<string>",
"min_length": 123,
"max_length": 123,
"min": 123,
"max": 123
},
"file": {
"accepted_types": [
"<string>"
],
"max_size_bytes": 123
}
}
],
"title": "<string>",
"warning": "<string>"
},
"response": [
{
"value": "<unknown>",
"key": "<string>",
"field_name": "<string>"
}
],
"attachments": [
{
"filename": "<string>",
"field": "<string>",
"field_name": "<string>",
"content_type": "<string>",
"size": 123
}
],
"resolved_at": "2023-11-07T05:31:56Z"
}
],
"shareholders": [
{
"object": "shareholder",
"id": "<string>",
"type": "individual",
"relationship": {
"title": "sole_owner",
"custom_title": "<string>",
"percent_ownership": 99,
"representative": true,
"director": true
},
"document": {
"status": "required"
},
"first_name": "<string>",
"last_name": "<string>",
"name": "<string>",
"representative_name": "<string>",
"email": "<string>",
"phone": "<string>",
"phone_country": "<string>",
"tax_id_type": "ssn",
"address": {
"country": "<string>",
"line1": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"line2": "<string>"
}
}
],
"officers": [
{
"object": "officer",
"id": "off_0346sFPEvSkJvY8vt14NNw",
"roles": [
"member"
],
"shareholder": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"title": "<string>",
"source": "onboarding",
"address": {
"country": "<string>",
"line1": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"line2": "<string>"
}
}
],
"management_type": "member_managed",
"officers_settled": true,
"metadata": {}
}
]
}{
"type": "https://docs.clemta.com/partner/errors#resource_already_exists",
"title": "<string>",
"status": 349,
"code": "api_key_invalid",
"detail": "<string>",
"request_id": "<string>",
"errors": [
{
"reason": "<string>",
"location": "<string>",
"validation_type": "<string>",
"how_to_fix": "<string>"
}
]
}{
"type": "https://docs.clemta.com/partner/errors#resource_already_exists",
"title": "<string>",
"status": 349,
"code": "api_key_invalid",
"detail": "<string>",
"request_id": "<string>",
"errors": [
{
"reason": "<string>",
"location": "<string>",
"validation_type": "<string>",
"how_to_fix": "<string>"
}
]
}{
"type": "https://docs.clemta.com/partner/errors#resource_already_exists",
"title": "<string>",
"status": 349,
"code": "api_key_invalid",
"detail": "<string>",
"request_id": "<string>",
"errors": [
{
"reason": "<string>",
"location": "<string>",
"validation_type": "<string>",
"how_to_fix": "<string>"
}
]
}Authorizations
Your API key, e.g. Authorization: Bearer clmt_test_. Live keys use the clmt_live_ prefix.
Query Parameters
Filter by status. A bare value is an exact match (status=active), operators go in brackets: status[neq]=cancelled, status[in]=in_progress,active.
Available options:
requires_information, in_progress, active, cancelled Filter by the account (the incorporator) that owns the company. A bare value is an exact match (account_id=acct_...). Operators go in brackets (account_id[in]=acct_a,acct_b). The Clemta-Account header resolves to this same filter and overrides any value sent here.
Pattern:
^acct_[0-9A-Za-z]{22}$Relations to embed. Expandable: account, requirements (the open requirements behind open_requirements), service_orders (every order on the company, auto-attached mandatory products included).
Available options:
account, requirements, service_orders Comma-separated fields to sort by, a minus prefix for descending (for example -created_at). Each endpoint's sortable fields are in its description; an unsupported one is rejected with a suggestion.
Example:
"-created_at,name"
Required range:
1 <= x <= 100Use the page's end_cursor as the after value to fetch the next page. Cursors are opaque and only valid for the listing that minted them.
Use the page's start_cursor as the before value to fetch the previous page. Cannot be combined with after.
⌘I