Skip to main content
GET
/
api
/
organization
/
current
Get current organization
curl --request GET \
  --url https://api.example.com/api/organization/current \
  --header 'Authorization: <authorization>' \
  --header 'organization-id: <organization-id>'
{
  "id": 1,
  "organizationId": "org_123456",
  "initializedAt": "2024-01-01T00:00:00.000Z",
  "seededAt": "2024-01-01T01:00:00.000Z",
  "builtAt": "2024-01-01T02:00:00.000Z",
  "metadata": [
    {
      "id": 1,
      "tenantId": 101,
      "name": "Acme Inc.",
      "location": "US",
      "baseCurrency": "USD",
      "language": "en-US",
      "timezone": "America/New_York",
      "dateFormat": "MM/DD/YYYY",
      "fiscalYear": "January",
      "industry": "Technology",
      "taxNumber": "12-3456789",
      "primaryColor": "#4285F4",
      "logoKey": "organizations/acme-logo-123456.png",
      "logoUri": "https://...",
      "address": "123 Main St, New York, NY"
    }
  ],
  "isReady": true,
  "isBuildRunning": false,
  "isUpgradeRunning": false,
  "databaseBatch": "batch_001"
}

Documentation Index

Fetch the complete documentation index at: https://docs.bigcapital.app/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string
required

Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Response

200 - application/json

Returns the current organization

​
id
number
required

Internal numeric ID of the organization

Example:

1

​
organizationId
string
required

Unique string identifier for the organization

Example:

"org_123456"

​
initializedAt
string<date-time>
required

Date when the organization was initialized

Example:

"2024-01-01T00:00:00.000Z"

​
seededAt
string<date-time>
required

Date when the organization was seeded

Example:

"2024-01-01T01:00:00.000Z"

​
builtAt
string<date-time>
required

Date when the organization was built

Example:

"2024-01-01T02:00:00.000Z"

​
metadata
object[]
required

Organization metadata

​
isReady
boolean
required

Whether the organization is ready

Example:

true

​
isBuildRunning
boolean
required

Whether a build process is currently running

Example:

false

​
isUpgradeRunning
boolean
required

Whether an upgrade process is currently running

Example:

false

​
databaseBatch
string | null

Database batch identifier, if any

Example:

"batch_001"