API Reference

Teams API

Team directory API.

Overview

Manage team structure and membership via API.

Use organization-scoped API keys with Bearer authentication. All responses are JSON unless downloading binary report artifacts. List endpoints support cursor pagination; mutating operations accept Idempotency-Key headers.

Who should read this

  • Engineers building automation against Zof for CMDB sync, CI gates, reporting, and integration health checks.

Prerequisites

  • API key with read access minimum; write operations require appropriate role
  • Familiarity with REST and JSON

Teams workflow

Teams workflow

Typical integration pattern

Best practices

  • Test mutations in staging before production automation
  • Cache resource IDs from list responses; avoid hard-coding in multiple services
  • Subscribe to webhooks for run completion instead of polling where possible

API operations

GET
/teams
List teams in organization directory.
POST
/teams
Create team with name and ownership metadata.
GET
/teams/{id}
Get team members and linked applications.
PATCH
/teams/{id}
Update team name or description.
GET
/teams/{id}/members
List members with roles.
POST
/teams/{id}/invite
Send invitation with role assignment.

Was this page helpful?