---
title: "Get a company"
method: GET
path: "/companies/{companyId}"
tags: ["Partner API"]
---

# Get a company

`GET /companies/{companyId}`

## Request

- Base URL: `https://ledgerhq.pro/api/v1`
- URL: `https://ledgerhq.pro/api/v1/companies/{companyId}`
- Auth: one of:
  - HTTP bearer and API key in header `x-organization-id`
  - HTTP bearer and API key in header `x-organization-id`

## Path parameters

- `companyId` string, uuid, required

## Response `200`

Company

- object
  - `data` PartnerCompany
    - `id` string, uuid
    - `name` string
    - `slug` string
    - `type` 'company' | 'firm'
    - `firmId` string, uuid, nullable
    - `defaultCurrency` string
    - `country` string, nullable
    - `countryCode` string, nullable
    - `ytdRevenue` integer: Integer cents. Example: 1250 means $12.50.
    - `ytdProfit` integer: Integer cents. Example: 1250 means $12.50.
    - `unpostedFeedCount` integer
    - `unpostedFeedTotal` integer: Integer cents. Example: 1250 means $12.50.
    - `uncodedFeedCount` integer
    - `uncodedFeedTotal` integer: Integer cents. Example: 1250 means $12.50.
    - `disconnectedItemCount` integer: Live Plaid Items for this company that are disconnected or have broken/disconnected health. Demo Items are excluded.
    - `unmappedAccountCount` integer: Import-enabled live Plaid accounts not mapped to a ledger bank account. Demo Items are excluded.
    - `bankFeedAlert` boolean: True when disconnectedItemCount or unmappedAccountCount is greater than zero.
    - `status` 'active'
    - `createdAt` string, date-time
    - `updatedAt` string, date-time

## Other responses

- `default`: Structured partner API error

---

[API](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api.md) · [All operations](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ledgerhq-pro/apis/ledgerhq-bookkeeping-api/revisions/9a8269f0a586?raw)