ListMembersResponse

statusstring

Possible values: [OK, FAIL, ERROR]

codestringnullable

ResultCode enum name (e.g. SUCCESS, NOT_FOUND, RATE_LIMIT_EXCEEDED)

messagestringnullable

Error message, present when status is FAIL or ERROR.

messagesstring[]nullable

In rare, specific cases, additional error messages.

data object

members object[]

The organization's members, one entry per member.

Array [

account object

The member's public account profile: identity, name, email, images, and primary phone.

idstring

Unique identifier of the member's Gigwell account.

firstNamestring

Member's first name.

lastNamestring

Member's last name.

emailstring

Member's email address, used as the account login and primary contact.

displayTitlestring

Read-only display name for the member, composed from first and last name.

avatarImageUrlstring

URL of the member's small avatar image; absent when no avatar is set.

profileImageUrlstring

URL of the member's full-size profile image; absent when none is set.

primaryPhone object

The member's primary phone number as an object (number, type, and primary flag); absent when no phone is on file.

primaryboolean

Whether this is the primary phone number.

typestring

Number type. Default main.

numberstring

The phone number.

activeboolean

Whether the member's Gigwell account is active.

membershipEntry object

The member's membership record within the queried organization — roles, active state, and membership title; scoped to this organization only, not the account's memberships elsewhere.

identityIdstring

rolesstring[]

The member's roles within this organization.

Possible values: [agent, owner, assistant, reporting, logistician]

activeboolean

titlestring

]

requestIdstringnullable

A request correlation id generated by the server.

ListMembersResponse

{
  "status": "OK",
  "code": "string",
  "message": "string",
  "messages": [
    "string"
  ],
  "data": {
    "members": [
      {
        "account": {
          "id": "string",
          "firstName": "string",
          "lastName": "string",
          "email": "string",
          "displayTitle": "string",
          "avatarImageUrl": "string",
          "profileImageUrl": "string",
          "primaryPhone": {
            "primary": true,
            "type": "string",
            "number": "string"
          },
          "active": true
        },
        "membershipEntry": {
          "identityId": "string",
          "roles": [
            "agent"
          ],
          "active": true,
          "title": "string"
        }
      }
    ]
  },
  "requestId": "string"
}