Get Account Information

    Gets account information for an account ID.

    API Type

    Server API

    Request URL

    • Live environment: https://apis.worksmobile.com/r/{API_ID}/contact/v2/accounts/{accountId}
    • Testing environment: https://sandbox-apis.worksmobile.com/r/{API_ID}/contact/v2/accounts/{accountId}

    HTTP Method

    GET

    Path Parameters

    Parameter Type Required Description
    account String Y Account ID

    Request Example

    GET https://apis.worksmobile.com/r/apiid/contact/v2/accounts/EX123
    

    Response

    Property Type Description
    name String Name
    organizationName String Company name
    levelName String Level name
    representOrgUnitName String Default organization name
    representPositionName String Default position name
    externalKey String External key to identify members

    Response Example

    {
        "name" : "name",
        "organizationName" : "organization",
        "levelName" : "level",
        "representOrgUnitName" : "orgUnit",
        "representPositionName" : "position",
        "externalKey" : "EX123"
    }