Skip to main content
GET
/
v1.0
/
members
Team Members
curl --request GET \
  --url https://api.lofty.com/v1.0/members \
  --header 'Authorization: <authorization>'
{
  "get_metadata": {
    "collection": "note",
    "limit": 10,
    "offset": 0,
    "total": 50,
    "scrollId": "<string>"
  },
  "members": [
    {
      "id": 11,
      "teamId": 12345,
      "invitorUserId": 100001,
      "memberUserId": 100234,
      "role": 0,
      "roleName": "Agent",
      "firstLetter": "A",
      "email": "alice@example.com",
      "firstName": "Alice",
      "lastName": "Johnson",
      "phoneNumber": "+14155550199",
      "status": 1,
      "virtualNumber": "+14155550100",
      "newLeadCount": 5,
      "assignedLeadCount": 42,
      "isAdmin": false,
      "agentInfo": {
        "licenseId": "<string>",
        "position": "<string>",
        "companyName": "<string>",
        "companyAddress": "<string>",
        "mlsAgentId": "<string>",
        "agentPid": "<string>"
      },
      "timeZoneId": "America/Los_Angeles",
      "groupId": 12345,
      "groupName": "North Austin Office",
      "group": {
        "id": 123,
        "teamId": 123,
        "parentId": 123,
        "websiteOwnerId": 123,
        "name": "<string>",
        "type": 123,
        "phone": "<string>",
        "phoneCode": "<string>",
        "phoneCountry": "<string>",
        "email": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zipcode": "<string>",
        "streetAddress": "<string>",
        "webSiteUrl": "<string>",
        "createTime": "2023-11-07T05:31:56Z",
        "updateTime": "2023-11-07T05:31:56Z",
        "path": "<string>",
        "showInSite": true,
        "defaultFlag": true,
        "allowManageSub": true,
        "agentCount": 123,
        "boundNumber": "<string>",
        "status": "ACTIVE",
        "layer": 123,
        "childPath": "<string>"
      },
      "accountStatus": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developer.lofty.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string
required

Bearer [access_token]

Query Parameters

​
groupIds
integer<int64>[]

Office / group IDs to filter members by. When omitted, all visible members are returned.

​
offset
integer<int32>
default:0

Zero-based index of the first entry to return. Values < 0 are silently reset to 0.

Required range: x >= 0
​
limit
integer<int32>
default:25

Maximum number of entries to return per page. Exceeding the server-configured maximum returns 400 LIMIT_PARAM_OVERSIZE.

Required range: x >= 1

Response

Page of team members with pagination metadata.

Response for GET /v1.0/members: a page of team members with pagination metadata.

​
get_metadata
object

Pagination metadata (offset, limit, total, collection).

​
members
object[]

Team members on this page.