v3

latestSwagger 2.02026-08-067506752.0 MB
org

Return a particular org by id

get/v1/org/{orgId}

Path parameters

orgIdstring required

Org identifier (either id or slug)

Response

successful operation

idstring required

globally unique id

customerIdstring

customer for billing processing

namestring required

name of organization

slugstring required

unique slug of organization

type'PRIVATE' | 'PUBLIC' | 'EDU' | 'GOV' | 'NONPROFIT' | 'DEMO' | 'TEST' | 'PORTFOLIO'

type of organization

industrystring

industry

estEmployeesinteger

approximate number of employees

estRevenueinteger

approximate amount of revenue

foundedYearstring

year of founding

phonestring

company phone number in E.164 format

emailstring

primary contact email

urlstring uri

website URL

status'ACTIVE' | 'INACTIVE' | 'DISABLED'

current status of organization

imagePathstring

path to full-sized profile image in storage

currenciesstring[]

types of currencies in use, with the first currency the primary currency

localesstring[]

locales supported within the org based on user selection, with the first locale the primary locale (e.g., en_US, en_GB, fr_FR, fr_CA)

dataResidency'GLOBAL' | 'US' | 'EU'

data residency of the org - the db cluster where this org's data resides

stockstring

stock symbol

timezonestring

timezone in use

appTimesstring[]

approximate times of day in the org timezone for daily app syncs to run (if unset, syncs will run 2am-8am US Eastern Time)

fiscalStartinteger

number of months into the calendar year that the fiscal year starts (1 = February, 2 = March)

headJobIdstring

head of the organization

unassignedManagerJobIdstring

Job ID that all jobs with missing manager report to in the organization

portfolioParentOrgIdstring

portfolio parent org ID

startDatestring date

start date of history

onboardingboolean

current onboarding status of an organization, allowing clearing of org

selfServeImportingboolean

completion status of initial import for orgs signed up via self serve

headCountinteger

number of total headcount currently in the org

userCountinteger

number of non-ChartHop, non-app users in the org

activeUserCountinteger

number of non-ChartHop, non-app users in the org active in the past month

activeAtstring

last timestamp that any user was active in the org

createIdstring

created by user id

createBehalfIdstring

created on behalf of user id

createAtstring

created timestamp

updateIdstring

last updated by user id

updateBehalfIdstring

last updated on behalf of user id

updateAtstring

last updated timestamp

destroyAtstring

timestamp that the org is marked for data destruction

destroyIdstring

user who marked the org for data destruction

destroyedAtstring

date at which this org was destroyed, can not be modified