Skip to content

Create a team

Settings module

POST/teamsteams.create

A working group, distinct from canon teams. Creates a team. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requires the capability org.teams.manage.
  • OAuth scopes: org.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: TeamCreate

teams.create: TeamCreate
FieldTypeRequiredDescription
namestringYesTeam name.Constraints: length 1 to 300
{
  "name": "Show Control"
}

Response 201: Team

teams.create: Team
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the team.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
namestringYesTeam name.Constraints: length 1 to 300
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "name": "Show Control"
}

Code samples

curl -X POST "$XOS_BASE_URL/teams" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"name":"Show Control"}'
const { data } = await xos.teams.create({
    "name": "Show Control"
  });
response = xos.teams.create({"name": "Show Control"})
xos teams create --data '{"name":"Show Control"}'