Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve people’s details with optional filtering. Required permission: View role for the Employee Person Details.
External DocumentationTo learn more, visit the UKG Pro HCM documentation.

​
Basic Parameters

ParameterDescription
COBRA Event Date And TimeThe date and time to filter results by.
COBRA Event Date And Time FromThe date and time to filter results from.
COBRA Event Date And Time UntilThe date and time to filter results until.
Changed Date And TimeThe date and time to filter results by.
Changed Date And Time FromThe date and time to filter results from.
Changed Date And Time UntilThe date and time to filter results until.
Company IDThe ID of the company to filter results by.
Created Date And TimeThe date and time to filter results by.
Created Date And Time FromThe date and time to filter results from.
Created Date And Time UntilThe date and time to filter results until.
Email AddressThe email address of the person to filter by.
Employee IDThe ID of the employee to filter the results by.
Filter By COBRA Event TimeSelect how to filter the results by their COBRA event time.
Filter By Changed TimeSelect how to filter the results by the time they were changed.
Filter By Created TimeSelect how to filter the results by their creation time.
Last NameThe last name of the person to filter by.
National IDThe national ID to filter the results by.
National ID CountryThe national ID country to filter the results by.
PageThe page number to get the results from. The value must be greater than 0.
Per PageThe maximum number of results to return per page.
Return All PagesAutomatically fetch all resources, page by page.

​
Advanced Parameters

ParameterDescription
Address CountryThe country to filter the results by.
Address StateThe state to filter the results by.
Cobra Is ActiveSelect whether the cobra is active or not.
Cobra StatusThe cobra status to filter the results by.

​
Example Output

[
	{
		"additionalName1": "string",
		"additionalName2": "string",
		"addressId": "00000000-0000-0000-0000-000000000000",
		"addressIsOnTaxBoundary": true,
		"addressLatitude": 0,
		"cobraExport": "string",
		"cobraIsActive": true,
		"cobraReason": "string",
		"cobraStatus": "string",
		"cobraStatusDate": "2025-12-07T06:53:53.427Z",
		"communityBroadcastSmsCode": "string",
		"consentElectronicW2": true,
		"consentElectronicw2pr": true,
		"dateDeceased": "2025-12-07T06:53:53.427Z",
		"dateOfCobraEvent": "2025-12-07T06:53:53.427Z",
		"dateOfCobraExport": "2025-12-07T06:53:53.427Z",
		"dateOfCobraLetter": "2025-12-07T06:53:53.427Z",
		"dateOfI9Expiration": "2025-12-07T06:53:53.427Z",
		"datetimeChanged": "2025-12-07T06:53:53.427Z",
		"datetimeCreated": "2025-12-07T06:53:53.427Z",
		"disabilityType": "string",
		"ethnicDescription": "string",
		"formerName": "string",
		"healthBloodType": "string",
		"healthEyes": "string",
		"healthHair": "string",
		"healthHeightFeet": "string",
		"healthHeightInches": "string",
		"healthLastDonateDate": "2025-12-07T06:53:53.427Z",
		"healthWeight": 0,
		"i9AlienNumber": "string",
		"i9DocA": "string",
		"i9DocB": "string",
		"i9DocC": "string",
		"i9Verified": true,
		"i9VisaType": "string",
		"i9WorkAuth": "string",
		"isDisabled": true,
		"isMultiPayGroup": true,
		"isSmoker": true,
		"militaryService": true,
		"militaryBranchServed": "string",
		"militaryEra": "string",
		"militaryIsDisabledVet": "string",
		"militaryIsOthEligVet": "string",
		"militaryIsOthEligVetBasis": "string",
		"militaryIsActiveWartimeVet": "string",
		"nameFormer": "string",
		"previousSSN": "string",
		"originCountry": "string",
		"originLocation": "string",
		"w2IsDeceased": true,
		"cobraNotes": "string",
		"addressSms": "string",
		"militarySeparationDate": "2025-12-07T06:53:53.427Z",
		"homePhoneIsPrivate": true,
		"smsApprovals": true,
		"smsPayNotification": true,
		"i9VisaExpirationDate": "2025-12-07T06:53:53.427Z",
		"militaryIsMedalVet": "string",
		"lastNameNotSameAsSSCard": "string",
		"chkCashingInstCode": "string",
		"nationality1": "string",
		"nationality2": "string",
		"nationality3": "string",
		"personId": "00000000-0000-0000-0000-000000000000",
		"employeeId": "string",
		"companyId": "string",
		"userName": "string",
		"firstName": "string",
		"middleName": "string",
		"lastName": "string",
		"preferredName": "string",
		"namePrefixCode": "string",
		"nameSufixCode": "string",
		"emailAddress": "string",
		"emailAddressAlternate": "string",
		"homePhone": "string",
		"homePhoneCountry": "string",
		"addressLine1": "string",
		"addressLine2": "string",
		"addressCity": "string",
		"addressState": "string",
		"addressZipCode": "string",
		"addressCountry": "string",
		"addressCounty": "string",
		"nationalId": "string",
		"nationalIdCountry": "string",
		"dateOfBirth": "2025-12-07T06:53:53.427Z",
		"gender": "string",
		"ethnicIDCode": "string",
		"maritalStatusCode": "string",
		"ssn": "string",
		"ssnIsSuppressed": true
	}
]

​
Workflow Library Example

Retrieve People Details with Ukg Pro Hcm and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop