Create User

POST

https://api.fortresstech.io/v1/users

POST

/v1/users

curl -X POST https://api.fortresstech.io/v1/users \
     -H "x-api-key: <apiKey>"

200Successful

{
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "username": "string",
  "status": "ACTIVE",
  "hasAllProperties": true,
  "id": "string",
  "readableId": "string",
  "idempotencyId": "string",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "deletedAt": "2024-01-15T09:30:00Z",
  "organizationId": "string",
  "propertyIds": "string",
  "workOrders": [
    {
      "status": "OPEN",
      "priority": "LOW",
      "hasPetAlert": true,
      "completedAt": "2024-01-15T09:30:00Z",
      "requestorPhone": "string",
      "requestorEmail": "string",
      "requestedStartDateFrom": "2023-01-15",
      "requestedStartDateTo": "2023-01-15",
      "requestedStartTimeFrom": "string",
      "requestedStartTimeTo": "string",
      "dueDate": "2023-01-15",
      "description": "string",
      "serviceNotes": "string",
      "vendorNotes": "string",
      "entryNotes": "string",
      "entryPreference": "24_HOUR_NOTICE",
      "isDoorCodeActive": true,
      "isAlarmActive": true,
      "doorCode": "string",
      "alarmCode": "string",
      "holdReason": "string",
      "otherLocationDetail": "string",
      "attachmentIds": "string",
      "technicianNotes": "string",
      "previouslyReported": true,
      "id": "string",
      "readableId": "string",
      "idempotencyId": "string",
      "createdAt": "string",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "assignedUserId": "string",
      "householdId": "string",
      "customerId": "string",
      "unitId": "string",
      "maintenanceIssueId": "string",
      "maintenanceLocationId": "string",
      "propertyId": "string",
      "organizationId": "string",
      "totalCostOfMaterialsUsed": 1.1,
      "totalAmountOwedByResident": 1.1,
      "totalAmountOwedByProperty": 1.1,
      "hourlyServiceRate": 1.1,
      "totalLaborCost": 1.1
    }
  ],
  "applications": [
    {
      "notes": "string",
      "status": "APPROVED",
      "submittedAt": "2024-01-15T09:30:00Z",
      "id": "string",
      "readableId": "string",
      "idempotencyId": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z",
      "primaryFormCompletedAt": "2024-01-15T09:30:00Z",
      "secondaryFormCompletedAt": "2024-01-15T09:30:00Z",
      "assignedUserId": "string",
      "assignedUnitId": "string",
      "householdId": "string",
      "leaseId": "string",
      "applicantId": "string",
      "organizationId": "string",
      "propertyId": "string"
    }
  ],
  "userProperties": [
    {
      "id": "string",
      "readableId": "string",
      "idempotencyId": "string",
      "userId": "string",
      "propertyId": "string",
      "organizationId": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z"
    }
  ],
  "prospects": [
    {
      "firstName": "string",
      "middleName": "string",
      "lastName": "string",
      "phone": "string",
      "email": "string",
      "referralSource": "string",
      "propertyId": "string",
      "organizationId": "string",
      "assignedUserId": "string",
      "prospectStatusId": "string",
      "isPrimaryProspect": true,
      "portalInviteUrl": "string",
      "id": "string",
      "readableId": "string",
      "idempotencyId": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z"
    }
  ],
  "activities": [
    {
      "notes": "string",
      "type": "EMAILED",
      "prospectId": "string",
      "assignedUserId": "string",
      "propertyId": "string",
      "organizationId": "string",
      "householdId": "string",
      "customerStatus": "string",
      "startTime": "2024-01-15T09:30:00Z",
      "id": "string",
      "readableId": "string",
      "idempotencyId": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": "2024-01-15T09:30:00Z"
    }
  ]
}

Available by Request

Create a new user account in the system. This allows you to add staff members, property managers, or other users who need access to manage properties and operations.

This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team.

Authentication

x-api-keystring

API Key authentication via header

Response

The created transaction

firstNamestringOptional

lastNamestringOptional

emailstringOptional

usernamestringOptional

statusenumOptional

Allowed values:

hasAllPropertiesbooleanOptional

idstringOptionalformat: "uuid"

readableIdstringOptional

idempotencyIdstringOptionalformat: "uuid"

createdAtdatetimeOptional

updatedAtdatetimeOptional

deletedAtdatetimeOptional

organizationIdstringOptionalformat: "uuid"

propertyIdsstringOptional

Comma-separated list of property UUIDs

workOrderslist of objectsOptional

applicationslist of objectsOptional

userPropertieslist of objectsOptional

prospectslist of objectsOptional

activitieslist of objectsOptional