Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Embat Companies API

A `Company` represents a legal entity configured in your Embat workspace. Its `id` is the `companyId` used throughout this API: almost every other endpoint is scoped by `companyId` and requires it as a path parameter.`Company` is the parent entity of the API: it has no dependency on any other entity, while every other entity (Payments, Operations, Transactions, Contacts, Accounting Accounts, etc.) belongs to one. A company also has `Users` with access to it, retrievable with `GET /companies/{companyId}/users`.**Typical flow:**1. **Resolve the `companyId`.** Call `GET /companies` to list the companies your credentials have access to and pick the `id` of the one you want to work with.2. **Use it everywhere.** Pass that `id` as `companyId` in the path of any other endpoint in this API.3. **Optionally inspect the company.** `GET /companies/{companyId}` returns its legal name, administrative contact, tags and configuration (e.g. accounting currency).

Embat Companies API is one of 22 APIs that Embat publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Companies. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 3 paths, and defines 11 schemas. It is described by OpenAPI 3.1.0, at version 2.120.3.

Requests are made against the base URL https://api.embat.io.

3 operations 3 paths 11 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.120.3
Base URL
https://api.embat.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Embat Companies API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer).

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Companies 3

A Company represents a legal entity configured in your Embat workspace. Its id is the companyId used throughout this API: almost every other endpoint is scoped by companyId and re…

GET
/companies
List user companies
list_companies_companies_get → 200401
GET
/companies/{companyId}
Retrieve company
retrieve_company_companies__companyId__get 1 param → 200401404422
GET
/companies/{companyId}/users
List company users
list_company_users_companies__companyId__users_get 1 param → 200401404422

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are CompanyResponseSchema (7 properties), CompanyUserSchema (6 properties), ValidationError (5 properties), app__schemas__companies__ContactSchema (4 properties). Each schema is shown below with its type and property counts.

ErrorResponse
object
Error payload returned by the API (FastAPI detail convention).
1 property 1 required
CurrencyEnum
string
HTTPValidationError
object
1 property
ValidationError
object
5 properties 3 required
CompanyResponseSchema
object
7 properties 2 required
CompanyUserSchema
object
6 properties 2 required
ListCompanyUsersResponseSchema
object
1 property 1 required
CompanyConfigSchema
object
1 property
TagsSchema
object
4 properties 2 required
app__schemas__companies__ContactSchema
object
4 properties
ListCompaniesResponseSchema
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

embat-companies-api-openapi.yml Raw ↑

Other APIs Embat publishes across the network.

Embat AccountingAccounts API
Embat AccountingEntries API
Embat Attributes API
Embat Authentication API
Embat Balances API
Embat Banks API
Embat Categories API
Embat Contacts API
Embat DebtScheduleConfigs API
Embat Files API
Embat Forecasts API
Embat ForeignExchangeRates API