Get a Member

    Gets information of a member.

    API Type

    Server API

    Request URL

    • Live environment: https://apis.worksmobile.com/r/{API ID}/organization/v2/domains/{domainId}/users/{externalKey}
    • Testing environment: https://sandbox-apis.worksmobile.com/r/{API ID}/organization/v2/domains/{domainId}/users/{externalKey}

    HTTP Method

    GET

    Path Parameters

    Parameter Type Length Required Description
    domainId Integer Y Domain ID
    externalKey String 100 characters Y An external key for members

    Request Example

    GET https://apis.worksmobile.com/r/apiid/organization/v2/domains/123/users/EX123
    

    Response

    For members with multiple positions, information of his or her primary position is returned. You can check organizations fields to see whether or not a member has multiple positions.

    Property Type Description
    tenantId Integer Tenant ID
    domainId Integer Domain ID
    externalKey String External key of the member
    master Boolean Indicates whether the member is Admin.
    manager Boolean Indicates whether the member is Sub Admin.
    suspended Boolean Indicates whether the member is suspended.
    suspensionReason String Reason why the member is suspended.
    - MASTER: Suspended by the Admin.
    - LOGIN_FAIL: Login failed.
    absence Boolean Indicates whether the member is absent.
    absenceReason String Reason for absence
    ● BUSINESS_TRIP: Business trip
    ● EDUCATION: Education
    ● SICK_LEAVE: Sick leave
    ● VACATION: Vacation
    ● LEAVE_OF_ABSENCE: Leave of absence
    ● ETC: Others
    resigned Boolean Indicates whether the member is deleted.
    standby Boolean Indicates whether the member is in the standby state.
    email String Account.
    Member's email address for the Basic and Premium products.
    id@group name for the Lite product.
    name Nested Object
    name.lastName String Family name
    name.firstName String Given name
    name.phoneticLastName String Family name in Furigana
    name.phoneticFirstName String Given name in Furigana
    i18nNames[].language String Language code.
    ●ko_KR
    ●ja_JP
    ●zh_CN
    ●zh_TW
    ●en_US
    i18nNames[].firstName String Given name in the language
    i18nNames[].lastName String Family name in the language
    nickName String Nickname
    privateEmail String Private email address
    aliasEmails List<String> Sub email addresses
    telephone String Telephone number
    cellphone String Mobile phone number
    fax String Fax number
    employmentTypeExternalKey String External key for employment types
    location String Office location
    task String Task
    messenger NESTED OBJECT
    messenger.protocol String Messenger protocol.
    ● LINE: LINE
    ● FACEBOOK: Facebook
    ● TWITTER: Twitter
    ● OTHER: Others
    ● CUSTOM: Custom protocol
    messenger.customProtocol String Custom protocol if the messenger protocol is "CUSTOM"
    messenger.messengerId String Messenger ID
    birthday String Date of birth (yyyy.mm.dd)
    hireDate String Date of hire (yyyy.mm.dd)
    searchable Boolean Indicates whether to enable auto-complete and search for the member.
    organizations[] List List of domains (companies) to which the member belongs (including both the primary and secondary positions)
    organizations[].domainId Integer Domain ID
    organizations[].levelExternalKey String External key of the member's level in the domain
    organizations[].represent Boolean Indicates whether it is the default company.
    organizations[].externalKey String External key of the member in the domain.
    organizations[].email String Account of the member in the domain.
    Member's email address for the Basic and Premium products.
    id@group name for the Lite product.
    organizations[].orgUnits[] List List of organizations to which the member belongs, in the domain.
    organizations[].orgUnits[].domainId Integer Domain ID of the organization
    organizations[].orgUnits[].externalKey String External key of the organization
    organizations[].orgUnits[].represent Boolean Indicates whether it is the default organization.
    organizations[].orgUnits[].positionExternalKey String External key of the position
    organizations[].orgUnits[].manager Boolean Indicates whether the member is a manager.
    organizations[].orgUnits[].display Boolean Indicates whether to show the member in the organization.
    organizations[].orgUnits[].receiveEmail Boolean Indicates whether to enable team features.
    ● Use this parameter when you need to limit the following team features of a member for security purposes: receiving messages, sharing files and receiving organization emails in the team room.
    ● If this parameter is true, the following team features are enabled.
    - As a member of the team room (Message/Note/Calendar/Folder), the member can send/receive messages, view notes, receive shared calendar events and view folders.
    - The member can receive email messages sent to the organization.
    - The member can receive calendar events shared to the organization.
    - The member can view the organization calendar.
    - The member can view files in the drive shared to the organization.
    - The member can view boards with the permissions given to the organization.
    - The member can respond to surveys of the organization.
    - The member also becomes a member of the group which the organization belongs to.
    ● If this parameter is false, all the team features described above are disabled.
    relations[].relationName String Relation name of related contacts
    relations[].externalKey String External key of related contacts.
    locale String Language code.
    ●ko_KR
    ●ja_JP
    ●zh_CN
    ●zh_TW
    ●en_US
    timeZone String Timezone code.
    ●Pacific/Midway
    ●Pacific/Honolulu
    ●Pacific/Marquesas
    ●America/Anchorage
    ●America/Los_Angeles
    ●America/Denver
    ●America/Chicago
    ●America/New_York
    ●America/Caracas
    ●America/Santiago
    ●America/St_John
    ●America/Sao_Paulo
    ●America/Noronha
    ●Atlantic/Azores
    ●Europe/London
    ●Europe/Berlin
    ●Europe/Athens
    ●Asia/Baghdad
    ●Asia/Tehran
    ●Asia/Baku
    ●Asia/Karachi
    ●Asia/Colombo
    ●Asia/Katmandu
    ●Asia/Dhaka
    ●Asia/Rangoon
    ●Asia/Bangkok
    ●Asia/Shanghai
    ●Asia/Seoul
    ●Asia/Tokyo
    ●Australia/Darwin
    ●Australia/Sydney
    ●Australia/Lord_Howe
    ●Pacific/Noumea
    ●Pacific/Norfolk
    ●Pacific/Auckland
    customField NESTED OBJECT Custom field
    customField.{schemaKey}[] List Custom field definition key (schemaKey) defined in the primary position’s domain
    customField.{schemaKey}[].value String Custom field’s text to display
    customField.{schemaKey}[].link String URL if the type of custom field is link

    Response Example

    {
      "tenantId": 1,
      "domainId": 1,
      "externalKey": "EX123",
      "master": false,
      "manager": false,
      "absence": false,
      "resigned": false,
      "standby": false,
      "email": "localpart@domain.com",
      "name": {
        "lastName": "lastName",
        "firstName": "firstName",
        "phoneticLastName": "",
        "phoneticFirstName": ""
      },
      "i18nNames": [
        {
          "language": "en_US",
          "firstName": "firstName",
          "lastName": "lastName"
        },
        {
          "firstName": "firstName",
          "lastName": "lastName"
        }
      ],
      "nickName": "nickName",
      "privateEmail": "private@domain.com",
      "aliasEmails": [
        "alias@domain.com"
      ],
      "telePhone": "000000000",
      "location": "worksPlace",
      "task": "task",
      "messenger": {
        "protocol": "LINE",
        "messengerId": "messenger"
      },
      "birthday": "2015.04.01",
      "hireDate": "2015.04.01",
      "searchable": true,
      "organizations": [
        {
          "domainId": 1,
          "primary": true,
          "externalKey": "EX123",
          "email": "localpart@domain.com",
          "orgUnits": [
            {
              "domainId": 1,
              "externalKey": "PST123",
              "primary": true,
              "manager": true,
              "display": true,
              "receiveEmail": true
            }
          ]
        }
      ],
      "relations": [],
      "locale": "ja_JP",
      "timeZone": "Asia/Seoul",
      "customField": {
        "schema123": [
          {
            "value": "The Face Shop",
            "link": "http://www.thefaceshop.com"
          },
          {
            "value": "Beyond"
          },
          {
            "link": "http://www.sum37.com"
          }
        ],
        "schema456": [
          {
            "value": "CRAFTON Tower"
          },
          {
            "value": "Green Factory"
          }
        ]
      }
    }
    

    Error Code

    It returns an error code and message when the API call fails.
    Refer to Organization Integration REST API Error Codes for details.