LINE WORKS Developers

Get Members

Gets members (100 members per page).
It returns an empty list if the requested page contains no members.
It is available only when Organization Sync > Setting for use of Get Members API is set to On in the Developer Console.

API Type

Server API

Request URL

https://apis.worksmobile.com/r/{API ID}/organization/v2/domains/{domainId}/users

HTTP Method

GET

Path Parameters

Parameter	Type	Length	Required	Description
domainId	Integer		Y	The primary position's domain ID

Request Parameters

Parameter	Type	Length	Required	Description
page	Integer		Y	Page

Request Example

GET https://apis.worksmobile.com/r/apiid/organization/v2/domains/123/users?page=1

Response

Property	Type	Description
externalKey	String	External key of the member
email	String	Account. Member's email address for the Basic and Premium products. id@group name for the Lite product.
name	String	Member name
authority	String	Member authority • MASTER: Admin • MANEGER: Sub Admin • MEMBER: 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[].levelName	String	Level name
organizations[].orgUnits[]	List	List of organizations that belong to the domain ID
organizations[].orgUnits[].domainId	Integer	Domain ID of the organization
organizations[].orgUnits[].name	String	Organization name
organizations[].orgUnits[].represent	Boolean	Indicates whether it is the default organization.
organizations[].orgUnits[].positionName	String	Position name
organizations[].orgUnits[].display	Boolean	Indicates whether to show the organization.

Response Example

[
    {
        "externalKey": "TEST001",
        "email": "admin@test.com",
        "name": "ADMIN",
        "authority": "MASTER",
        "organizations": [
            {
                "domainId": 1,
                "orgUnits": [],
                "levelName": "LVL"
            }
        ]
    },
    {
        "externalKey": "ABC",
        "email": "abc@test.com",
        "name": "ABC",
        "authority": "MEMBER",
        "organizations": [
            {
                "domainId": 1,
                "orgUnits": [
                    {
                        "domainId": 1,
                        "name": "ORG1",
                        "represent": true,
                        "positionName": "Position1",
                        "display": true
                    },
                    {
                        "domainId": 1,
                        "name": "ORG2",
                        "represent": false,
                        "positionName": "Position2",
                        "display": true
                    }
                ],
                "levelName": "Level"
            }
        ]
    }
]

Error Code

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