Get Group Employee List

There may be some cases where you wish to find a specific employee in a group, but do not know their Noyo id. We provide a way to filter your employee list for a given group via query parameters. The following parameters are accepted by the API in the query string:

Parameter	Type	Description
`date_of_birth`	date	ISO-8601 date string for the date of birth of the employee to be filtered on
`first_name`	string	First name of the employee to be filtered on
`last_name`	string	Last name of the employee to be filtered on
`name`	string	A name search for all name fields for the employee to be filtered on

The filtering is not case-sensitive and it does not require an exact match on the value (e.g. searching for “ann” will match against “Ann” as well as “Annie”).

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

group_id

string<uuid>

required

The unique identifier of the group for which you would like to view employees

Example:

"2613a221-d3c8-4c8a-86d5-e7e885fd1da9"

Query Parameters

page_size

integer

The max size of each page of results

offset

integer

The integer offset at which to start the page. Possible values are 0 to total_records - 1

first_name

string

The employee first name for which you would like to filter

last_name

string

The employee last name for which you would like to filter

name

string

The employee's name for which you would like to filter

date_of_birth

string

The ISO-8601 (YYYY-MM-DD) employee date of birth for which you would like to filter

employment_status

string

Status of the employees employment

Response

200 - application/json

Successful Response - Returns all matching Employees

meta

object

required

Metadata associated with the response data

Show child attributes

meta.offset

integer<int32>

required

The offset of the first response record within the matching data set

Required range: x >= 0

meta.page_num

integer<int32>

required

The page number of the response records within the overall data set (1-based integer)

Required range: x >= 1

meta.page_size

integer<int32>

required

The maximum number of response records on each page of results

Required range: x >= 1

meta.total_records

integer<int32>

The total number of records in the entire matching data set

Required range: x >= 0

response

object[]

required

List of employee results

Show child attributes

response.created

integer

required

The date the record was originated

response.employment

object

required

Employment information for the employee

Show child attributes

response.employment.employment_dates

object

required

Employee employment dates

Show child attributes

response.employment.employment_dates.full_time_start

string

ISO-8601 date string for start date as a full time employee with the group (if applicable)

Example:

"2017-01-17"

response.employment.employment_dates.hire_date

string<date>

ISO-8601 date string for the hire date of the employee

Example:

"2017-01-17"

response.employment.employment_dates.rehire

string

ISO-8601 date string for the rehire date of the employee (if applicable)

Example:

"2018-02-01"

response.employment.employment_dates.retirement

string

ISO-8601 date string for the retirement date of the employee (if applicable)

Example:

"2019-01-01"

response.employment.employment_dates.terminated

string

ISO-8601 date string for the termination date of the employee (if applicable)

Example:

"2018-01-01"

response.employment.employment_status

enum<string>

required

Employee employment status

Available options:

full-time,

part-time,

contract,

disabled,

terminated,

retired

response.employment.hours_worked

integer<int32>

required

An integer of hours worked per week by the employee

Example:

40

response.employment.occupation

string

Employee occupation or job title

Example:

"Engineer"

response.employment.salary

object

Employee salary information

Show child attributes

response.employment.salary.amount

number

Amount of salary earned by the employee in US dollars and cents, as a decimal value

Required range: x >= 0

Example:

52000

response.employment.salary.type

enum<string>

Type of salary earned by the employee

Available options:

hourly,

salary

Example:

"salary"

response.employment.salary.unit

enum<string>

Unit of salary earned by the employee

Available options:

annual,

month,

semi-monthly,

week,

hour

Example:

"annual"

response.group_id

string<uuid>

required

Unique identifier of the group in Noyo

response.id

string<uuid>

required

Unique identifier of the employee in Noyo

response.modified

integer

required

The date the record was last updated

response.person

object

required

Personal information for the employee

Show child attributes

response.person.date_of_birth

string<date>

required

ISO-8601 date string for the date of birth of the person

Example:

"1977-06-03"

response.person.first_name

string

required

First name of the person

Example:

"Catherine"

response.person.home_address

object

required

Home address of the person

Show child attributes

response.person.home_address.city

string

required

City of the address

Example:

"Bend"

response.person.home_address.state

enum<string>

required

State postal code of the address

Available options:

AL,

AK,

AZ,

AR,

CA,

CO,

CT,

DE,

DC,

FL,

GA,

HI,

ID,

IL,

IN,

IA,

KS,

KY,

LA,

ME,

MD,

MA,

MI,

MN,

MS,

MO,

MT,

NE,

NV,

NH,

NJ,

NM,

NY,

NC,

ND,

OH,

OK,

OR,

PA,

RI,

SC,

SD,

TN,

TX,

UT,

VT,

VA,

WA,

WV,

WI,

WY,

AS,

GU,

MH,

FM,

MP,

PW,

PR,

VI,

UM

Example:

"OR"

response.person.home_address.street_one

string

required

Line one of the address

Example:

"339 Hickory Street"

response.person.home_address.zip_code

string

required

Zip code of the address

Example:

"97701"

response.person.home_address.county

string

County of the address

Example:

"Deschutes"

response.person.home_address.street_two

string

Line two of the address

Example:

"Apartment 5"

response.person.last_name

string

required

Last name of the person

Example:

"Briggs"

response.person.sex

enum<string>

required

Sex of the person

Available options:

F,

M,

U,

X

Example:

"F"

response.person.contact

object

Contact information for the person

Show child attributes

response.person.contact.email_address

string<email>

Email address of the person

Example:

"[email protected]"

response.person.contact.email_address_type

enum<string>

Type of email address

Available options:

home,

work

Example:

"home"

response.person.contact.home_phone

string

Home phone number in E.164 format

Example:

"+15555551212"

response.person.contact.preferred_language

string

Preferred written or spoken language of the person

Example:

"Engish"

response.person.contact.preferred_method

enum<string>

Preferred method of contact for the person

Available options:

mail,

email,

home-phone,

work-phone,

other

Example:

"email"

response.person.contact.speaks_english

boolean

True if the person can speak or communicate in English

Example:

true

response.person.contact.work_phone

string

Work phone number in E.164 format

Example:

"+15555551212"

response.person.details

object

Additional personal details of the person

Show child attributes

response.person.details.american_indian

object

American Indian status details (if applicable)

Show child attributes

response.person.details.american_indian.state

enum<string>

Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable

Available options:

AL,

AK,

AZ,

AR,

CA,

CO,

CT,

DE,

DC,

FL,

GA,

HI,

ID,

IL,

IN,

IA,

KS,

KY,

LA,

ME,

MD,

MA,

MI,

MN,

MS,

MO,

MT,

NE,

NV,

NH,

NJ,

NM,

NY,

NC,

ND,

OH,

OK,

OR,

PA,

RI,

SC,

SD,

TN,

TX,

UT,

VT,

VA,

WA,

WV,

WI,

WY,

AS,

GU,

MH,

FM,

MP,

PW,

PR,

VI,

UM

response.person.details.american_indian.tribe

string

Name of the federally-recognized American Indian or Alaska Native tribe, if applicable

Example:

"Ojibwe"

response.person.details.disability

object

Disability details (if applicable)

Show child attributes

response.person.details.disability.communication

boolean

True if the disability impacts the ability to communicate or read

response.person.details.disability.disabled

boolean

True if the member has a disability

response.person.details.disability.reason

string

Description of the disability

response.person.details.is_military

boolean

True if the person is in the military

response.person.details.is_student

boolean

True if the person is a student

response.person.details.tobacco

object

Tobacco usage details (if applicable)

Show child attributes

response.person.details.tobacco.duration

string

Duration of tobacco use

Example:

"5 years"

response.person.details.tobacco.frequency

string

Frequency of tobacco use

Example:

"Daily"

response.person.details.tobacco.types

enum<string>[]

List of types of tobacco use

Minimum array length: 1

Available options:

pipe,

cigarettes,

chewing-tobacco

Example:

"cigarettes"

response.person.details.tobacco.user

boolean

True if the person uses tobacco of any kind

Example:

true

response.person.maiden_name

string

Maiden name of the person (deprecated)

response.person.mailing_address

object

Mailing address of the person, if different from home address

Show child attributes

response.person.mailing_address.city

string

required

City of the address

Example:

"Bend"

response.person.mailing_address.state

enum<string>

required

State postal code of the address

Available options:

AL,

AK,

AZ,

AR,

CA,

CO,

CT,

DE,

DC,

FL,

GA,

HI,

ID,

IL,

IN,

IA,

KS,

KY,

LA,

ME,

MD,

MA,

MI,

MN,

MS,

MO,

MT,

NE,

NV,

NH,

NJ,

NM,

NY,

NC,

ND,

OH,

OK,

OR,

PA,

RI,

SC,

SD,

TN,

TX,

UT,

VT,

VA,

WA,

WV,

WI,

WY,

AS,

GU,

MH,

FM,

MP,

PW,

PR,

VI,

UM

Example:

"OR"

response.person.mailing_address.street_one

string

required

Line one of the address

Example:

"339 Hickory Street"

response.person.mailing_address.zip_code

string

required

Zip code of the address

Example:

"97701"

response.person.mailing_address.county

string

County of the address

Example:

"Deschutes"

response.person.mailing_address.street_two

string

Line two of the address

Example:

"Apartment 5"

response.person.marital_status

enum<string>

Marital status of the person

Available options:

single,

married,

domestic-partner,

divorced,

widowed,

legally-separated

Example:

"married"

response.person.middle_name

string

Middle name of the person

Example:

"S"

response.person.ssn

string | null

Social Security Number of the person

Example:

"123456789"

response.person.suffix

string

Suffix of the person

response.version

string<uuid>

required

Version of the employee record

response.classifications

object

Fields that classify employees for group structure mapping

response.custom_individual_id

string

The custom identifier for this employee in your system

response.location_id

string<uuid>

Unique identifier of the employee group location in Noyo

Groups

Members

Changes

Legacy

Get Group Employee List

Authorizations

Path Parameters

Query Parameters

Response