curl --request GET \
--url https://api.baselayer.com/organizations/{organization_id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.baselayer.com/organizations/{organization_id}"
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.baselayer.com/organizations/{organization_id}', 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.baselayer.com/organizations/{organization_id}",
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.baselayer.com/organizations/{organization_id}"
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.baselayer.com/organizations/{organization_id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.baselayer.com/organizations/{organization_id}")
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{
"id": "a3d9af02-e679-4c12-a9b2-220b6eb78e2d",
"name": "The Avengers",
"domain_name": "avengers.com",
"type": "neobank",
"external_id": "b2e3a6ff-2734-47ed-ba87-54647e3550bd",
"webhooks_version": "2.0",
"federation": {
"id": "6d54d5fe-2fcd-4b83-891b-32e9e99656d6",
"name": "Stan Lee"
},
"applications": {
"enabled": true,
"external_id": null,
"id": "865a6f00-b7d7-4451-a787-6b89ac935f92",
"name": "Avengers - Sandbox",
"type": "sandbox"
},
"lien_filing_correspondence_email": "lien-filing-email@example.com",
"lien_filing_secured_party": {
"type": "ORGANIZATION",
"mailing_address": "123 Main St",
"city": "Springfield",
"state": "AL",
"postal_code": "62701",
"masked": true,
"is_assignor": true,
"organization_name": "Acme Inc",
"organization_type": "SOLE_PROPRIETORSHIP"
},
"lien_filing_collateral_statement": "<string>",
"lien_filing_collateral_statement_templates": [
{
"title": "<string>",
"text": "<string>"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Get Organization
Gets and returns the Organization profile of a specific Organization. The authenticated user must have the ‘organizations:read’ permission. If the authenticated user is an Operator, they can access any Organizations’ profile. If the authenticated user is a User or an Organization, they can only access the profile of their own Organization.
Args: organization_id (uuid.UUID): The unique identifier of the Organization. auth_context (BaseAuthContext): The authentication context of the request.
Returns: The Organization’s profile.
curl --request GET \
--url https://api.baselayer.com/organizations/{organization_id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.baselayer.com/organizations/{organization_id}"
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.baselayer.com/organizations/{organization_id}', 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.baselayer.com/organizations/{organization_id}",
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.baselayer.com/organizations/{organization_id}"
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.baselayer.com/organizations/{organization_id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.baselayer.com/organizations/{organization_id}")
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{
"id": "a3d9af02-e679-4c12-a9b2-220b6eb78e2d",
"name": "The Avengers",
"domain_name": "avengers.com",
"type": "neobank",
"external_id": "b2e3a6ff-2734-47ed-ba87-54647e3550bd",
"webhooks_version": "2.0",
"federation": {
"id": "6d54d5fe-2fcd-4b83-891b-32e9e99656d6",
"name": "Stan Lee"
},
"applications": {
"enabled": true,
"external_id": null,
"id": "865a6f00-b7d7-4451-a787-6b89ac935f92",
"name": "Avengers - Sandbox",
"type": "sandbox"
},
"lien_filing_correspondence_email": "lien-filing-email@example.com",
"lien_filing_secured_party": {
"type": "ORGANIZATION",
"mailing_address": "123 Main St",
"city": "Springfield",
"state": "AL",
"postal_code": "62701",
"masked": true,
"is_assignor": true,
"organization_name": "Acme Inc",
"organization_type": "SOLE_PROPRIETORSHIP"
},
"lien_filing_collateral_statement": "<string>",
"lien_filing_collateral_statement_templates": [
{
"title": "<string>",
"text": "<string>"
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Path Parameters
Response
Response
An Organization plus its lien-filing configuration.
Served by the standalone GET /organization (and its PATCH/PUT),
the org-management endpoints, the federation organization list, and the
admin organization endpoints. The nested-in-user view (/me,
/users/{id}) and the federation summary use the lean
OrganizationResponse instead — only the single-resource org views carry
the lien-filing fields. (webhooks_version lives on the lean base: the
console reads it off the nested org.)
The unique identifier of the Organization.
"a3d9af02-e679-4c12-a9b2-220b6eb78e2d"
The name of the Organization.
"The Avengers"
The domain name of the Organization.
"avengers.com"
The type of the organization.
neobank, community_bank, credit_union, regional_bank, national_bank, fintech, smb_lender, merchant_cash_advanced, processor, infrastructure, other An external identifier for referencing the Organization using the ID from a namespace in an external system.
"b2e3a6ff-2734-47ed-ba87-54647e3550bd"
The version of Baselayer Webhooks the Organization utilizies.
0.8, 1.0, 2.0, 2.0 "2.0"
Represents a federation response.
Show child attributes
Show child attributes
{
"id": "6d54d5fe-2fcd-4b83-891b-32e9e99656d6",
"name": "Stan Lee"
}
The Applications belonging to the Organization.
Show child attributes
Show child attributes
{
"enabled": true,
"external_id": null,
"id": "865a6f00-b7d7-4451-a787-6b89ac935f92",
"name": "Avengers - Sandbox",
"type": "sandbox"
}
{
"enabled": false,
"external_id": null,
"id": "aee180c8-ad54-474d-8046-87fd2ec176c6",
"name": "Avengers - Production",
"type": "production"
}
The email address for lien filing correspondence.
"lien-filing-email@example.com"
An organization's stored default secured party for lien filings.
This is the template applied to newly created drafts — not a persisted lien party row — so unlike the submission list item it carries no party id.
Show child attributes
Show child attributes
The collateral statement for lien filing.
The list of collateral statement templates for lien filing.
Show child attributes
Show child attributes