Skip to main content
GET
/
organizations
/
self
Read session organization
curl --request GET \
  --url https://api.obselite.com/v0/organizations/self \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "userId": "<string>",
  "maxTasks": 123,
  "domain": "<string>",
  "defaultRoleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "avatarStyle": "ADVENTURER_NEUTRAL",
  "expectations": "<string>",
  "industry": "ACCOUNTING",
  "markets": "DOMESTIC",
  "revenue": 6,
  "services": "<string>",
  "size": 4,
  "tools": [
    "ACTIVECOLLAB"
  ],
  "lockedAt": "<string>",
  "user": {},
  "avatar": {},
  "domains": [
    {}
  ],
  "roles": [
    {}
  ],
  "users": [
    {}
  ],
  "comments": [
    {}
  ],
  "cyclePolicies": [
    {}
  ],
  "cycles": [
    {}
  ],
  "defaultRole": {},
  "files": [
    {}
  ],
  "labels": [
    {}
  ],
  "language": [
    {}
  ],
  "links": [
    {}
  ],
  "machine": {},
  "machineOutputs": [
    {}
  ],
  "policies": [
    {}
  ],
  "resources": [
    {}
  ],
  "statuses": [
    {}
  ],
  "statusGroups": [
    {}
  ],
  "tasks": [
    {}
  ],
  "teams": [
    {}
  ],
  "configuration": {},
  "metadata": [
    {}
  ],
  "activities": [
    {}
  ]
}

Authorizations

​
Authorization
string
header
required

The API token generated from the Obselite dashboard

Response

Successful response

​
id
string<uuid>
required

Organization UUID

​
name
string
required
Required string length: 3 - 255
​
maxTasks
integer
required
​
domain
string
required
Required string length: 3 - 67
​
avatarStyle
enum<string>
required
Available options:
ADVENTURER_NEUTRAL,
ADVENTURER,
AVATAAARS_NEUTRAL,
AVATAAARS,
BIG_EARS_NEUTRAL,
BIG_EARS,
BIG_SMILE,
BOTTTS_NEUTRAL,
BOTTTS,
CROODLES_NEUTRAL,
CROODLES,
FUN_EMOJI,
ICONS,
IDENTICON,
LORELEI_NEUTRAL,
LORELEI,
MICAH,
MINIAVS,
NOTIONISTS_NEUTRAL,
NOTIONISTS,
OPEN_PEEPS,
PERSONAS,
PIXEL_ART_NEUTRAL,
PIXEL_ART,
RINGS,
SHAPES,
THUMBS
​
tools
enum<string>[]
required
​
userId
string | null
​
defaultRoleId
string<uuid> | null

Default Role UUID

​
expectations
string | null
​
industry
enum<string> | null
Available options:
ACCOUNTING,
ADVERTISING,
AEROSPACE,
AGRICULTURE,
ARCHITECTURE,
ARTS,
AUTOMOTIVE,
BANKING,
BIOTECHNOLOGY,
BLOCKCHAIN,
CHEMICAL,
CONSTRUCTION,
CONSULTING,
CREATIVE_SERVICES,
DEFENSE,
DESIGN,
E_COMMERCE,
EDUCATION,
ELECTRONICS,
ENERGY,
ENGINEERING,
ENTERTAINMENT,
ENVIRONMENTAL,
ESPORTS,
FASHION,
FINANCE,
FOOD_AND_BEVERAGE,
GAMING,
GOVERNMENT,
HEALTHCARE,
HOSPITALITY,
HUMAN_RESOURCES,
INFORMATION_TECHNOLOGY,
INSURANCE,
LEGAL,
LOGISTICS,
MANUFACTURING,
MARKETING,
MEDIA,
MINING,
NONPROFIT,
PHARMACEUTICALS,
REAL_ESTATE,
RETAIL,
SCIENCE,
SECURITY,
SOFTWARE,
SPORTS,
TELECOMMUNICATIONS,
TEXTILES,
TRANSPORTATION,
TRAVEL,
UTILITIES,
WHOLESALE,
OTHER
​
markets
enum<string> | null
Available options:
DOMESTIC,
INTERNATIONAL,
GLOBAL
​
revenue
integer | null
Required range: 0 <= x <= 12
​
services
string | null
​
size
integer | null
Required range: 0 <= x <= 9
​
lockedAt
string | null
​
user
object | null

Primary user or owner associated with this organization, following the user schema

​
avatar
object | null

Organization's profile image and branding assets, following the file schema

​
domains
array
​
roles
array
​
users
array
​
comments
array
​
cyclePolicies
array
​
cycles
array
​
defaultRole
object | null

Default role assigned to new members in this organization, following the role schema

​
files
array
​
labels
array
​
language
array
​
links
array
​
machine
object | null

Automated systems and integrations configured for this organization, following the machine schema

​
machineOutputs
array
​
policies
array
​
resources
array
​
statuses
array
​
statusGroups
array
​
tasks
array
​
teams
array
​
configuration
object | null

Organization-wide settings and configuration, following the configuration schema

​
metadata
array
​
activities
array