Skip to main content
GET
/
teams
/
read
Read team by id or slugId
curl --request GET \
  --url https://api.obselite.com/v0/teams/read \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isEnabled": true,
  "name": "<string>",
  "statusId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "lockedAt": "<string>",
  "description": "<string>",
  "organization": {},
  "user": {},
  "status": {},
  "cyclePolicy": {},
  "cycles": [
    {}
  ],
  "comments": [
    {}
  ],
  "files": [
    {}
  ],
  "labels": [
    {}
  ],
  "language": [
    {}
  ],
  "links": [
    {}
  ],
  "machine": {},
  "machineOutputs": [
    {}
  ],
  "policies": [
    {}
  ],
  "resources": [
    {}
  ],
  "statusGroups": [
    {}
  ],
  "tasks": [
    {}
  ],
  "users": [
    {}
  ],
  "teams": [
    {}
  ],
  "parent": {},
  "configuration": {},
  "metadata": {},
  "activities": [
    {}
  ]
}

Authorizations

​
Authorization
string
header
required

The API token generated from the Obselite dashboard

Query Parameters

​
filter
string

Encoded JSON to search and refine lists, see filtering

​
include
string

Available options: status, cyclePolicy, cycles, comments, files, labels, language, links, machine, machineOutputs, policies, resources, statusGroups, tasks, users, teams, parent, configuration, metadata, activities

​
id
string<uuid>
​
slug
string

Response

Successful response

​
id
string<uuid>
required

Team UUID

​
isEnabled
boolean
required
​
name
string
required
​
description
required
​
statusId
string<uuid> | null

Status UUID

​
lockedAt
string | null
​
organization
object | null

Parent organization this team belongs to, following the organization schema

​
user
object | null

Team lead or primary contact, following the user schema

​
status
object | null

Current state and workflow status of this team, following the status schema

​
cyclePolicy
object | null

Development cycle rules and guidelines for this team, following the cycle policy schema

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

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

​
machineOutputs
array
​
policies
array
​
resources
array
​
statusGroups
array
​
tasks
array
​
users
array
​
teams
array
​
parent
object | null

Parent team in the organizational hierarchy, following the team schema

​
configuration
object | null

Team-specific settings and preferences, following the configuration schema

​
metadata
object | null

Custom properties and attributes for this team, following the metadata schema

​
activities
array