Organization object

Internal organization object with comprehensive administrative and operational details

_id

string

required

Unique identifier for the organization (MongoDB ObjectId). Example: 61a712ddec0441328052f262

user

object

required

Primary user information associated with the organization

Show child attributes

user.name

string

Primary user name or organization name. Example: sofia@paket.id

user.email

string<email>

Primary user email address. Example: sofia@paket.id

user.country

string

Country code. Example: IDN

user.phoneNumber

string

Contact phone number. Example: +62 812345678

user.numberOfUsers

string

Expected number of users range. Example: 1-50

user.industry

string

Industry type. Example: Distribution

user.position

string

User position in organization. Example: Owner/Director

user.companyName

string

Company name. Example: Paketid

user.testemail

string

Test email address for development/testing. Example: grady@example.com

user.hub

object

Default hub information

Show child attributes

user.hub.name

string

Hub name

user.hub.displayName

string

Hub display name

user.hub.address

string

Hub address

user.hub.lat

string

Hub latitude

user.hub.lng

string

Hub longitude

user.flows

string[]

List of flow IDs associated with organization

user.updatedAt

string<date-time>

User information last update timestamp

status

enum<string>

required

Current organization status. Example: verified

Available options:

pending,

active,

suspended,

inactive,

verified

productId

string

required

Product ID for the organization's subscription. Example: prod_free or prod_OaZOlUL01AiiNl

eligible

boolean

required

Whether organization is eligible for certain features or benefits. Example: true

createdTime

string<date-time>

required

ISO 8601 timestamp when the organization was created. Example: 2021-12-01T06:14:53.684Z

updatedTime

string<date-time>

required

ISO 8601 timestamp when the organization was last updated. Example: 2024-09-13T08:29:24.650Z

billingMode

enum<string>

Billing mode for the organization. Example: INTL

Available options:

LOCAL,

INTL

productName

string

Name of the subscribed product/plan. Example: Free Plan

licenseCode

string

License code identifier for organization features. Example: task-demo

customerId

object

Payment gateway customer identifiers

Show child attributes

customerId.idr

string | null

Stripe customer ID for IDR currency. Example: cus_QqBFI91fqWd1jJ

customerId.usd

string | null

Stripe customer ID for USD currency

curPeriodStartTime

string<date-time> | null

Current billing period start time. Example: 2025-01-01T00:00:00+00:00

curPeriodEndTime

string<date-time> | null

Current billing period end time. Example: 2025-02-01T00:00:00+00:00

useBigData

boolean

Whether organization has access to big data features. Example: true

isDoTask

boolean

Flag indicating if organization can perform tasks. Example: true

configuration

object

Organization-specific configuration settings

Show child attributes

configuration.filesAccessPermission

enum<string>

Default file access permission. Example: private

Available options:

public,

private

configuration.filesServerProvider

string

File storage provider. Example: milesto

configuration.enableDataSource

boolean

Whether data source features are enabled

configuration.enableCustomModule

boolean

Whether custom modules are enabled

configuration.enableAutomation

boolean

Whether automation features are enabled

configuration.enableRouting

boolean

Whether routing features are enabled

country

object

Country information for the organization

Show child attributes

country._id

string

Country record identifier

country.code

string

ISO country code

country.name

string

Country name

country.phoneCode

string

Country phone prefix

country.alpha2Code

string

ISO 3166-1 alpha-2 country code

country.isActive

boolean

Whether country is active in system

country.enableLanguage

boolean

Whether language support is enabled

country.language

string

Default language code

country.languageName

string

Default language name

verifiedTime

string<date-time> | null

Timestamp when organization was verified. Example: 2021-12-01T06:15:55+00:00

isDeleted

boolean

Soft delete flag for data retention. Default: false

deletedTime

string<date-time> | null

Timestamp when the organization was soft deleted

limits

object

Organization usage limits based on subscription

Show child attributes

limits.userLimit

integer

Maximum number of users allowed

limits.taskLimit

integer

Monthly task limit

limits.vehicleLimit

integer

Maximum number of vehicles

limits.hubLimit

integer

Maximum number of hubs

limits.dataSourceLimit

integer

Maximum number of data sources

limits.automationLimit

integer

Maximum number of automations

limits.storageLimit

integer

Storage limit in bytes

limits.apiCallLimit

integer

Monthly API call limit

usage

object

Current usage statistics

Show child attributes

usage.totalUsers

integer

Current number of active users

usage.totalTasks

integer

Tasks created this month

usage.totalVehicles

integer

Current number of vehicles

usage.totalHubs

integer

Current number of hubs

usage.totalDataSources

integer

Current number of data sources

usage.totalAutomations

integer

Current number of automations

usage.storageUsed

integer

Current storage usage in bytes

usage.apiCallsMonth

integer

API calls made this month

subscription

object

Subscription information from payment gateway

Show child attributes

subscription.subscriptionId

string

Stripe subscription ID

subscription.status

enum<string>

Subscription status

Available options:

trialing,

active,

past_due,

canceled,

unpaid

subscription.cancelAtPeriodEnd

boolean

Whether subscription will cancel at period end

subscription.trialEnd

string<date-time> | null

Trial period end date

subscription.canceledAt

string<date-time> | null

Cancellation timestamp

billing

object

Billing information

Show child attributes

billing.paymentMethod

string

Default payment method

billing.billingEmail

string

Email for billing notifications

billing.taxId

string

Tax identification number

billing.billingAddress

object

Show child attributes

billing.billingAddress.street

string

billing.billingAddress.city

string

billing.billingAddress.state

string

billing.billingAddress.zipCode

string

billing.billingAddress.country

string

integrations

object

Third-party integrations

Show child attributes

integrations.slack

object

Show child attributes

integrations.slack.enabled

boolean

integrations.slack.webhookUrl

string

integrations.whatsapp

object

Show child attributes

integrations.whatsapp.enabled

boolean

integrations.whatsapp.phoneNumber

string

integrations.email

object

Show child attributes

integrations.email.enabled

boolean

integrations.email.smtpConfig

object

metadata

object

Additional metadata for internal use

failedCode

enum<string>

Oraganization Module business failedCode that indicate specific failure conditions or business rule violations during organization module operations. These codes help identify the failed operation of organization-related and provide standardized failure identification across the system.

Possible values:

org-031: Duplicate entry - Organization name already exists
org-032: Invalid state/condition - Organization state invalid
org-033: Organization not found - Organization does not exist
org-034: Verification failed - Organization verification error
org-035: Access forbidden - User lacks organization permission
org-036: Organization creation failed - Failed to create organization
org-037: Organization update failed - Failed to update organization
org-038: Organization delete failed - Failed to delete organization
org-039: Subscription error - Organization subscription issue
org-040: Limit exceeded - Organization usage limit reached
org-041: Payment error - Organization billing/payment failure
org-042: License error - Organization license validation failed
org-043: Integration error - External service integration failure
org-044: Compliance error - Regulatory compliance violation
org-045: Server error - Internal server failure

Available options:

org-031,

org-032,

org-033,

org-034,

org-035,

org-036,

org-037,

org-038,

org-039,

org-040,

org-041,

org-042,

org-043,

org-044,

org-045

Getting Started

Webhook

Task

Routing

Flow

Data

Setting

File

Billing

Dashboard

Authentication

Reference

Internal Tools

Objects