Skip to main content

Users

NewBeta

User objects represent user accounts in AppFolio®. Skywalk API allows you to obtain the following user attributes from AppFolio®.

The User Object​

Attributes

appfolioIdstring
AppFolio ID of the user.
Example:
"42"
namestring
Full name of the user.
Example:
"Jane Smith"
firstNamestring
First name of the user.
Example:
"Jane"
lastNamestring
Last name of the user.
Example:
"Smith"
emailstring
Email address of the user.
Example:
"jane.smith@example.com"
phoneNumberstring
Phone number of the user.
Example:
"+15551234567"
uuidstring
Unique identifier (UUID) of the user.
Example:
"a1b2c3d4-e5f6-7890-abcd-ef1234567890"
currentSignInAtstring
Date and time of the user's most recent sign-in.
Example:
"2026/04/10 05:27:15 -0700"
activeboolean
Whether the user account is active.
Example:
true
userRolestring
Role of the user (e.g., President, Manager).
Example:
"Property Manager"
adminUserboolean
Whether the user has admin privileges.
Example:
false
agentUserboolean
Whether the user is an agent.
Example:
false
mfaEnabledboolean
Whether multi-factor authentication is enabled for the user.
Example:
true
lockedboolean
Whether the user account is locked.
Example:
false
internalUserboolean
Whether the user is an internal user.
Example:
false
profilePhotoUrlstring
URL of the user's profile photo.
Example:
null
The User Object
{
  "appfolioId": "42",
  "name": "Jane Smith",
  "firstName": "Jane",
  "lastName": "Smith",
  "email": "jane.smith@example.com",
  "phoneNumber": "+15551234567",
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "currentSignInAt": "2026/04/10 05:27:15 -0700",
  "active": true,
  "userRole": "Property Manager",
  "adminUser": false,
  "agentUser": false,
  "mfaEnabled": true,
  "locked": false,
  "internalUser": false,
  "profilePhotoUrl": null
}

Get All Users​

GET /v1/users

Follows: Authentication • Caching • Polling • List Response Format • Scheduled Job

The users endpoint returns a list of all users in your AppFolio® account. This endpoint should respond immediately with your most recently cached data.

Parameters​

This endpoint requires no additional parameters.

Returns​

The standard List Response Format with a data property containing an array of User objects.

GET /v1/users
curl -X GET 'https://api.skywalkapi.com/v1/users' \ 
  -H "X-API-Key: PUT_YOUR_API_KEY_HERE"
Response
{
  "meta": {
    "status": "ok",
    "path": "/v1/users",
    "count": 1,
    "lastUpdated": 1610992228
  },
  "links": {
    "next": "/v1/users?cursor=abcdefg"
  },
  "data": [
    {
      "appfolioId": "42",
      "name": "Jane Smith",
      "firstName": "Jane",
      "lastName": "Smith",
      "email": "jane.smith@example.com",
      "phoneNumber": "+15551234567",
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "currentSignInAt": "2026/04/10 05:27:15 -0700",
      "active": true,
      "userRole": "Property Manager",
      "adminUser": false,
      "agentUser": false,
      "mfaEnabled": true,
      "locked": false,
      "internalUser": false,
      "profilePhotoUrl": null
    }
  ]
}