v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB

Members

Get a team member by account (email)

Returns a team member of the caller's team identified by their login email. The member must have accepted the team invitation.

get/v1.0/members/{account}

Path parameters

accountstring required

Headers

Authorizationstring required

Bearer [access_token]

Response

Team member retrieved successfully.

idinteger

Team-member record ID.

teamIdinteger

ID of the team this member belongs to.

invitorUserIdinteger

User ID of the member who invited this member.

memberUserIdinteger

User ID of the team member.

roleinteger

Numeric role code.

roleNamestring

Human-readable role name.

firstLetterstring

First letter of the member's name, used for alphabetic grouping.

emailstring

Email address of the member.

firstNamestring

Given name of the member.

lastNamestring

Family name of the member.

phoneNumberstring

Phone number of the member.

statusinteger

Numeric status code of the member.

virtualNumberstring

Virtual number assigned to the member for dialer features. Empty string when no virtual number is assigned.

newLeadCountinteger

Number of new (unassigned) leads routable to this member.

assignedLeadCountinteger

Number of leads currently assigned to this member.

isAdminboolean

Whether the member is an administrator of the team.

timeZoneIdstring

IANA time zone identifier for the member.

groupIdinteger

ID of the office / group this member belongs to.

groupNamestring

Name of the office / group this member belongs to.

accountStatusstring

Example response

{
  "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"
}