v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB

Members

Team Members

Returns members of the caller's team, optionally filtered by office / group IDs, with pagination metadata.

Notes:

limit must not exceed the configured maximum; oversized values return 400 LIMIT_PARAM_OVERSIZE.
offset < 0 is silently reset to 0.
total in _metadata reflects the full result size before pagination.
When groupIds is omitted, all members visible to the caller are returned.

get/v1.0/members

Query parameters

groupIdsinteger[]

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

offsetinteger

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

limitinteger

Number of entries to return per page.

Headers

Authorizationstring required

Bearer [access_token]

Response

Page of team members with pagination metadata.

Example response

{
  "get_metadata": {
    "collection": "note",
    "limit": 10,
    "total": 50
  },
  "members": [
    {
      "id": 11,
      "teamId": 12345,
      "invitorUserId": 100001,
      "memberUserId": 100234,
      "roleName": "Agent",
      "firstLetter": "A",
      "email": "alice@example.com",
      "firstName": "Alice",
      "lastName": "Johnson",
      "phoneNumber": "+14155550199",
      "status": 1,
      "virtualNumber": "+14155550100",
      "newLeadCount": 5,
      "assignedLeadCount": 42,
      "timeZoneId": "America/Los_Angeles",
      "groupId": 12345,
      "groupName": "North Austin Office"
    }
  ]
}