BAbaselayer
Organization Management

Get All Organizations For Federation Within Scope

Gets and returns all Organizations' profiles within a specific Federation.

The authenticated user must have the 'federation:read' permission. If the authenticated user is an Operator, they can access any Organizations' profile within the Federation. If the authenticated user is a User or an Organization, they can only access the profiles of their own Organization within the Federation.

get/federations/{federation_id}/organizations

Request

Path parameters

federation_idstring uuid required

Query parameters

limitinteger
offsetinteger
qstring nullable

A search query to limit the Organizations returned by matching on ID, name, or external ID.

Example:Acme, Inc.

Response

Response

idstring uuid required

The unique identifier of the Organization.

namestring nullable required

The name of the Organization.

domain_namestring nullable required

The domain name of the Organization.

type'neobank' | 'community_bank' | 'credit_union' | 'regional_bank' | 'national_bank' | 'fintech' | 'smb_lender' | 'merchant_cash_advanced' | 'processor' | 'infrastructure' | 'other' required
external_idstring nullable required

An external identifier for referencing the Organization using the ID from a namespace in an external system.

webhooks_version'0.8' | '1.0' | '2.0' | '2.0' required
lien_filing_correspondence_emailstring email nullable

The email address for lien filing correspondence.

lien_filing_collateral_statementstring nullable

The collateral statement for lien filing.

Example response

[
  {
    "id": "83664b45-0a6c-48a4-8e20-3316c4ea3655",
    "name": "The Avengers",
    "domain_name": "avengers.com",
    "external_id": "c6bb13ea-a3a5-495d-b160-515272f5a205",
    "applications": [
      {
        "name": "The Avengers",
        "enabled": true
      }
    ],
    "lien_filing_correspondence_email": "lien-filing-email@example.com",
    "lien_filing_secured_party": {
      "mailing_address": "123 Main St",
      "city": "Springfield",
      "postal_code": "62701",
      "organization_name": "Acme Inc"
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.