Get Group Employee List

GET

api

groups

{group_id}

employees

curl --request GET \
  --url https://fulfillment.noyo.com/api/v1/groups/{group_id}/employees

{
  "meta": {
    "offset": 0,
    "page_num": 1,
    "page_size": 20,
    "total_records": 1
  },
  "response": [
    {
      "employment": {
        "employment_dates": {
          "full_time_start": "2015-01-01",
          "hire_date": "2014-12-10"
        },
        "employment_status": "full-time",
        "hours_worked": 50,
        "occupation": "Senior Analyst",
        "salary": {
          "amount": 55000,
          "type": "salary",
          "unit": "annual"
        }
      },
      "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
      "id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4",
      "location_id": "bd957820-4652-4ee7-8a3a-6413df21e28d",
      "person": {
        "contact": {
          "email_address": "david@testemail.com",
          "email_address_type": "home",
          "home_phone": "+12065551234",
          "preferred_method": "email",
          "work_phone": "+12065559876"
        },
        "date_of_birth": "1981-06-22",
        "first_name": "David",
        "home_address": {
          "city": "San Francisco",
          "county": "San Francisco",
          "state": "CA",
          "street_one": "1234 Home Ave",
          "zip_code": "94107"
        },
        "last_name": "Johnson",
        "marital_status": "",
        "sex": "M",
        "ssn": "123456789"
      },
      "version": "6260146a-3486-4c3d-b2a6-fcd3f8c84043"
    }
  ]
}

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”).

Path Parameters

group_id

string

required

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

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

response

object[]

required

List of employee results

response.created

integer

required

The date the record was originated

response.employment

object

required

Employment information for the employee

response.group_id

string

required

Unique identifier of the group in Noyo

response.id

string

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

response.person.date_of_birth

string

required

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

response.person.first_name

string

required

First name of the person

response.person.home_address

object

required

Home address of the person

response.person.last_name

string

required

Last name of the person

response.person.sex

enum<string>

required

Sex of the person

Available options:

F,

M,

U,

X

response.person.contact

object

Contact information for the person

response.person.details

object

Additional personal details of the person

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

response.person.marital_status

enum<string>

Marital status of the person

Available options:

single,

married,

domestic-partner,

divorced,

widowed,

legally-separated

response.person.middle_name

string

Middle name of the person

response.person.ssn

string | null

Social Security Number of the person

response.person.suffix

string

Suffix of the person

response.version

string

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

Unique identifier of the employee group location in Noyo

Was this page helpful?

Get Group Employee Get Dependent

curl --request GET \
  --url https://fulfillment.noyo.com/api/v1/groups/{group_id}/employees

{
  "meta": {
    "offset": 0,
    "page_num": 1,
    "page_size": 20,
    "total_records": 1
  },
  "response": [
    {
      "employment": {
        "employment_dates": {
          "full_time_start": "2015-01-01",
          "hire_date": "2014-12-10"
        },
        "employment_status": "full-time",
        "hours_worked": 50,
        "occupation": "Senior Analyst",
        "salary": {
          "amount": 55000,
          "type": "salary",
          "unit": "annual"
        }
      },
      "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
      "id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4",
      "location_id": "bd957820-4652-4ee7-8a3a-6413df21e28d",
      "person": {
        "contact": {
          "email_address": "david@testemail.com",
          "email_address_type": "home",
          "home_phone": "+12065551234",
          "preferred_method": "email",
          "work_phone": "+12065559876"
        },
        "date_of_birth": "1981-06-22",
        "first_name": "David",
        "home_address": {
          "city": "San Francisco",
          "county": "San Francisco",
          "state": "CA",
          "street_one": "1234 Home Ave",
          "zip_code": "94107"
        },
        "last_name": "Johnson",
        "marital_status": "",
        "sex": "M",
        "ssn": "123456789"
      },
      "version": "6260146a-3486-4c3d-b2a6-fcd3f8c84043"
    }
  ]
}

Groups

Members

Changes

Legacy

Get Group Employee List

Path Parameters

Query Parameters

Response