> ## Documentation Index > Fetch the complete documentation index at: https://docs-v2.sortx.co.uk/llms.txt > Use this file to discover all available pages before exploring further. # Create team > Create a team ## OpenAPI ````yaml /openapi.json post /operational-catalogues/teams openapi: 3.1.0 info: title: SortX API version: 1.0.0 description: >- Reactive repairs, planned maintenance, compliance and the repairs desk for UK letting agents and property managers. servers: - url: https://api.sortx.co.uk description: Production security: [] tags: - name: tenants - name: entitlements - name: events - name: workspace-settings - name: operational-catalogues - name: money - name: contacts - name: properties - name: address-lookup - name: tenancies - name: contractor-invoices - name: keys - name: inspections - name: handovers - name: planned-maintenance - name: contractors - name: documents - name: compliance - name: activity - name: tasks - name: today - name: reports - name: workspace-search - name: calendar - name: telephony - name: maintenance-pro - name: front-desk - name: maintenance-pro-public - name: maintenance-pro-contractor paths: /operational-catalogues/teams: post: tags: - operational-catalogues summary: Create team description: Create a team operationId: operational-catalogues.createTeam parameters: [] requestBody: content: application/json: schema: type: object properties: requestId: type: string expectedRevision: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN name: type: string purpose: type: string branchId: anyOf: - type: string - type: 'null' leadStaffId: anyOf: - type: string - type: 'null' memberIds: type: array items: type: string active: type: boolean required: - requestId - expectedRevision - name - purpose - branchId - leadStaffId - memberIds - active additionalProperties: false required: true responses: '200': description: Success content: application/json: schema: type: object properties: revision: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN canManage: type: boolean staff: type: array items: type: object properties: id: type: string userId: type: string displayName: type: string email: type: string jobTitle: type: string workPhone: type: string branchId: anyOf: - type: string - type: 'null' brandId: anyOf: - type: string - type: 'null' timezone: anyOf: - type: string - type: 'null' active: type: boolean loginRole: anyOf: - type: string - type: 'null' banned: type: boolean eligible: type: boolean ineligibleReason: anyOf: - type: string - type: 'null' required: - id - userId - displayName - email - jobTitle - workPhone - branchId - brandId - timezone - active - loginRole - banned - eligible - ineligibleReason additionalProperties: false teams: type: array items: type: object properties: id: type: string name: type: string purpose: type: string branchId: anyOf: - type: string - type: 'null' leadStaffId: anyOf: - type: string - type: 'null' memberIds: type: array items: type: string active: type: boolean required: - id - name - purpose - branchId - leadStaffId - memberIds - active additionalProperties: false taskTypes: type: array items: type: object properties: id: type: string name: type: string description: type: string colour: type: string defaultPriority: type: string defaultDueDays: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' active: type: boolean required: - id - name - description - colour - defaultPriority - defaultDueDays - active additionalProperties: false matchingAreas: type: array items: type: object properties: id: type: string name: type: string towns: type: array items: type: string postcodes: type: array items: type: string notes: type: string active: type: boolean required: - id - name - towns - postcodes - notes - active additionalProperties: false serviceTemplates: type: array items: type: object properties: id: type: string name: type: string description: type: string category: type: string assetClass: type: string eventType: type: string statutory: type: boolean recurrenceInterval: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' recurrenceUnit: anyOf: - type: string - type: 'null' instructionLeadDays: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN instructions: type: string defaultCostCodeId: anyOf: - type: string - type: 'null' active: type: boolean required: - id - name - description - category - assetClass - eventType - statutory - recurrenceInterval - recurrenceUnit - instructionLeadDays - instructions - defaultCostCodeId - active additionalProperties: false costCodes: type: array items: type: object properties: id: type: string code: type: string name: type: string description: type: string scope: type: object properties: kind: type: string branchId: anyOf: - type: string - type: 'null' refId: anyOf: - type: string - type: 'null' label: type: string required: - kind - branchId - refId - label additionalProperties: false contractorPayableMinor: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' agencyReceivableMinor: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' currency: type: string active: type: boolean required: - id - code - name - description - scope - contractorPayableMinor - agencyReceivableMinor - currency - active additionalProperties: false required: - revision - canManage - staff - teams - taskTypes - matchingAreas - serviceTemplates - costCodes additionalProperties: false '400': description: >- TenantCreateRejected | ConfigMissing | IntegrationRejected | AuthRejected | RegistrationRejected | UnknownIntegration | WebhookUnroutable | RateUnavailable | WorkspaceSettingsRejected | StaffNotEligible content: application/json: schema: anyOf: - $ref: '#/components/schemas/TenantCreateRejectedEncoded' - $ref: '#/components/schemas/ConfigMissingEncoded' - $ref: '#/components/schemas/IntegrationRejectedEncoded' - $ref: '#/components/schemas/AuthRejectedEncoded' - $ref: '#/components/schemas/RegistrationRejectedEncoded' - $ref: '#/components/schemas/UnknownIntegrationEncoded' - $ref: '#/components/schemas/WebhookUnroutableEncoded' - $ref: '#/components/schemas/RateUnavailableEncoded' - $ref: '#/components/schemas/WorkspaceSettingsRejectedEncoded' - $ref: '#/components/schemas/StaffNotEligibleEncoded' '401': description: Unauthenticated | WebhookRejected | ApiKeyRejected content: application/json: schema: anyOf: - $ref: '#/components/schemas/UnauthenticatedEncoded' - $ref: '#/components/schemas/WebhookRejectedEncoded' - $ref: '#/components/schemas/ApiKeyRejectedEncoded' '402': description: TenantSuspended content: application/json: schema: $ref: '#/components/schemas/TenantSuspendedEncoded' '403': description: >- EntitlementMissing | NotAMember | ScopeUnknown | ScopeMissing | TenantMismatch | WorkspaceOwnerRequired | WorkspaceRoleRequired content: application/json: schema: anyOf: - $ref: '#/components/schemas/EntitlementMissingEncoded' - $ref: '#/components/schemas/NotAMemberEncoded' - $ref: '#/components/schemas/ScopeUnknownEncoded' - $ref: '#/components/schemas/ScopeMissingEncoded' - $ref: '#/components/schemas/TenantMismatchEncoded' - $ref: '#/components/schemas/WorkspaceOwnerRequiredEncoded' - $ref: '#/components/schemas/WorkspaceRoleRequiredEncoded' '404': description: TenantNotFound | ModuleRequestNotFound content: application/json: schema: anyOf: - $ref: '#/components/schemas/TenantNotFoundEncoded' - $ref: '#/components/schemas/ModuleRequestNotFoundEncoded' '409': description: >- WebhookDuplicate | RegistrationConflict | WorkspaceSettingsConflict | MoneyBusy content: application/json: schema: anyOf: - $ref: '#/components/schemas/WebhookDuplicateEncoded' - $ref: '#/components/schemas/RegistrationConflictEncoded' - $ref: '#/components/schemas/WorkspaceSettingsConflictEncoded' - $ref: '#/components/schemas/MoneyBusyEncoded' '429': description: RateLimited content: application/json: schema: $ref: '#/components/schemas/RateLimitedEncoded' '503': description: IntegrationUnavailable content: application/json: schema: $ref: '#/components/schemas/IntegrationUnavailableEncoded' security: - apiKey: [] components: schemas: TenantCreateRejectedEncoded: type: object properties: _tag: type: string enum: - TenantCreateRejected reason: type: string field: anyOf: - type: string - type: 'null' required: - _tag - reason additionalProperties: false ConfigMissingEncoded: type: object properties: _tag: type: string enum: - ConfigMissing key: type: string required: - _tag - key additionalProperties: false IntegrationRejectedEncoded: type: object properties: _tag: type: string enum: - IntegrationRejected integration: type: string reason: type: string required: - _tag - integration - reason additionalProperties: false AuthRejectedEncoded: type: object properties: _tag: type: string enum: - AuthRejected code: type: string message: type: string required: - _tag - code - message additionalProperties: false RegistrationRejectedEncoded: type: object properties: _tag: type: string enum: - RegistrationRejected message: type: string field: anyOf: - type: string - type: 'null' required: - _tag - message additionalProperties: false UnknownIntegrationEncoded: type: object properties: _tag: type: string enum: - UnknownIntegration integration: type: string required: - _tag - integration additionalProperties: false WebhookUnroutableEncoded: type: object properties: _tag: type: string enum: - WebhookUnroutable integration: type: string reason: type: string required: - _tag - integration - reason additionalProperties: false RateUnavailableEncoded: type: object properties: _tag: type: string enum: - RateUnavailable base: type: string quote: type: string 'on': type: string required: - _tag - base - quote - 'on' additionalProperties: false WorkspaceSettingsRejectedEncoded: type: object properties: _tag: type: string enum: - WorkspaceSettingsRejected message: type: string field: anyOf: - type: string - type: 'null' required: - _tag - message additionalProperties: false StaffNotEligibleEncoded: type: object properties: _tag: type: string enum: - StaffNotEligible message: type: string field: anyOf: - type: string - type: 'null' required: - _tag - message additionalProperties: false UnauthenticatedEncoded: type: object properties: _tag: type: string enum: - Unauthenticated required: - _tag additionalProperties: false WebhookRejectedEncoded: type: object properties: _tag: type: string enum: - WebhookRejected integration: type: string reason: type: string required: - _tag - integration - reason additionalProperties: false ApiKeyRejectedEncoded: type: object properties: _tag: type: string enum: - ApiKeyRejected required: - _tag additionalProperties: false TenantSuspendedEncoded: type: object properties: _tag: type: string enum: - TenantSuspended tenantId: type: string reason: type: string required: - _tag - tenantId - reason additionalProperties: false EntitlementMissingEncoded: type: object properties: _tag: type: string enum: - EntitlementMissing tenantId: type: string moduleId: type: string required: - _tag - tenantId - moduleId additionalProperties: false NotAMemberEncoded: type: object properties: _tag: type: string enum: - NotAMember userId: type: string slug: type: string required: - _tag - userId - slug additionalProperties: false ScopeUnknownEncoded: type: object properties: _tag: type: string enum: - ScopeUnknown scope: type: string required: - _tag - scope additionalProperties: false ScopeMissingEncoded: type: object properties: _tag: type: string enum: - ScopeMissing scope: type: string required: - _tag - scope additionalProperties: false TenantMismatchEncoded: type: object properties: _tag: type: string enum: - TenantMismatch header: type: string organizationId: type: string required: - _tag - header - organizationId additionalProperties: false WorkspaceOwnerRequiredEncoded: type: object properties: _tag: type: string enum: - WorkspaceOwnerRequired required: - _tag additionalProperties: false WorkspaceRoleRequiredEncoded: type: object properties: _tag: type: string enum: - WorkspaceRoleRequired role: anyOf: - type: string - type: 'null' required: type: array items: type: string message: type: string required: - _tag - role - required - message additionalProperties: false TenantNotFoundEncoded: type: object properties: _tag: type: string enum: - TenantNotFound slug: type: string required: - _tag - slug additionalProperties: false ModuleRequestNotFoundEncoded: type: object properties: _tag: type: string enum: - ModuleRequestNotFound id: type: string required: - _tag - id additionalProperties: false WebhookDuplicateEncoded: type: object properties: _tag: type: string enum: - WebhookDuplicate integration: type: string externalId: type: string required: - _tag - integration - externalId additionalProperties: false RegistrationConflictEncoded: type: object properties: _tag: type: string enum: - RegistrationConflict message: type: string field: anyOf: - type: string - type: 'null' required: - _tag - message additionalProperties: false WorkspaceSettingsConflictEncoded: type: object properties: _tag: type: string enum: - WorkspaceSettingsConflict message: type: string expectedRevision: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN actualRevision: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN required: - _tag - message - expectedRevision - actualRevision additionalProperties: false MoneyBusyEncoded: type: object properties: _tag: type: string enum: - MoneyBusy message: type: string required: - _tag - message additionalProperties: false RateLimitedEncoded: type: object properties: _tag: type: string enum: - RateLimited key: type: string retryAfterSeconds: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN message: type: string required: - _tag - key - retryAfterSeconds - message additionalProperties: false IntegrationUnavailableEncoded: type: object properties: _tag: type: string enum: - IntegrationUnavailable integration: type: string detail: anyOf: - type: string - type: 'null' required: - _tag - integration additionalProperties: false securitySchemes: apiKey: type: apiKey in: header name: x-api-key description: >- A workspace API key (Settings → API keys), scoped to `:read` / `:write`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.