PIpipeshub-ai
Organizations

Get current organization

Changed on

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

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/org
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /api/v1/oauth2/authorize
      Client credentials
      Token URL: /api/v1/oauth2/token scopes: org:read

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)

signupChannelstring

Where the signup came from: the ref tag it was made with, or direct. Absent on organizations created before it was recorded.

signupReferrerDomainstring

For a direct signup, the referring site's domain, when there was one.

Changes

  • dbb5e203b445Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • bb0c59adf026Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status