v10

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-0582185581.9 KB
Organizations

Get current organization

Retrieve details about the authenticated user's organization.

Overview:

This endpoint returns the organization document for the current user's org, including profile data and configuration.

Response Includes:

  • Organization profile (registeredName, shortName, contactEmail, domain)
  • Account type
  • Onboarding status
  • Permanent address
  • Creation and modification timestamps

Use Cases:

  • Organization profile pages
  • Settings and configuration screens
get/org

Response

Organization details retrieved successfully

_idstring ObjectId required

Unique organization identifier

slugstring required

Unique slug for the organization

registeredNamestring required

Registered name

shortNamestring

Short name or display name

domainstring required

Organization domain

contactEmailstring email required

Contact email address

accountType'individual' | 'business' required

Type of account

onBoardingStatus'configured' | 'notConfigured' | 'skipped' required

Onboarding status

isDeletedboolean required

Soft delete flag

__vinteger required

Document version (MongoDB)

createdAtstring date-time required

Creation timestamp (ISO 8601)

updatedAtstring date-time required

Last update timestamp (ISO 8601)