Get Worker Profile Details

Describes the API specifications for retrieving all worker profile details.

Request

URL: https://<SAP Fieldglass envionment URL>/api/vi/worker-profile/<workerRef>

HTTP Method: GET

Request Parameters

Parameter

Required

Data Type

Description

Parameter Type

workerRef

Yes

String

The unique reference ID of the user.

Path

Request Example

GET https://company.com/api/v1/worker-profile/ANTEPW00000008
authorization: Bearer WDXlKj3TTOn3rpg9GHnZpbKmvj1=
x-ApplicationKey: 5c91f4fdb0c6ee9992ff476f89bf6cf25e589350
content-type: application/json

Response

Response Status and Error Codes

See Common Status and Error Codes for more information.

Response Body

Parameter

Data Type

Description

prefix

String

The prefix of profile worker.

firstName

String

First name of profile worker.

lastName

String

Last Name of profile worker.

email

String

Email address of the profile worker.

ccEmail

String

Copy To email address of the profile worker.

employeeId

String

Unique ID of the employee

title

String

Title of the profile worker.

address1

String

Address of the profile worker.

address2

String

Address of the profile worker.

city

String

City associated with the address of the profile worker.

stateProvince

String

State/province associated with the address of the profile worker.

country

String

Country associated to the address of the profile worker.

postalCode

String

Zip/postal code associated to the address of the profile worker.

phoneNumber

String

Phone number of the profile worker.

faxNumber

String

Fax number of the profile worker.

mobileNumber

String

Mobile number of the profile worker.

linkedInPublicProfileUrl

String

The URL of the profile worker's LinkedIn profile.

username

String

User name of profile worker.

role

String

The profile worker's role.

Custom Field Name1

Dependent on Custom Field configuration

This is the value that is entered for the specific profile worker custom field being updated.

Custom Field Name2

Dependent on Custom Field configuration

This is the value that is entered for the specific profile worker custom field being updated.

Response Body Example

{
    "firstName": "Sabine",
    "lastName": "Bosch",
    "email": "sbosch@acme.com",
    "ccEmail": "kmayer@acme.com",
    "address1": "4138 Pheasant Ridge Road",
    "address2": "",
    "city": "Philadelphia",
    "stateProvince": "PA",
    "country": "USA",
    "postalCode": "19131",
    "phoneNumber": "202-555-0015",
    "faxNumber": "",
    "mobileNumber": "202-555-0517,
    "linkedInPublicProfileUrl": "https://linked-in.com/default216",
    "username": "sabine_bosch",
    "role": "Profile Worker",
    "profileWorkerCustomFields": {
        "Worker_Reg_Date": "1999-01-28",
        "Worker_Occupation": "Software Engineer",
        "Worker_WorkType_PickList": "For-profit company or organization",
        "Worker_PO_Number": "1234556"
    }
}