---
title: "Get members (employees)"
method: GET
path: "/v1/public/members"
tags: ["Public", "Members"]
---

# Get members (employees)

`GET /v1/public/members`

## Query parameters

- `includeAdmins` boolean
- `includeSupervisors` boolean
- `includeManagers` boolean
- `includeEmployees` boolean
- `status` 'active' | 'inactive'
- `includeRelationships` boolean
- `skip` number
- `take` number

## Response `200`

- GetPublicMembers
  - `members` PublicMember[], required — The list of members matching the query
    - `uid` string, required — Unique member id
    - `createdAt` string, required — Member creation date and time. In ISO-8601 format
    - `updatedAt` string — Member last modification date and time. In ISO-8601 format
    - `deactivatedAt` string — if the member status is inactive, the deactivation date in ISO-8601 format
    - `status` 'active' | 'inactive' | 'deleted' | 'needs_approval', required
    - `firstName` string, required — Member first name
    - `lastName` string, required — Member last name
    - `code` string, nullable — Member employee code
    - `pin` string, required — Employee pin use to clock in and out of the punch console. Length must be larger than 5 characters
    - `type` object — FULL_TIME = 1,PART_TIME = 2, SUBSTITUTE = 3, OCCASIONAL = 4, CONTRACTUAL = 5, SUPERNUMERARY = 6, ON_PROBATION = 7, PROSPECT = 8, TRAINING = 9, PARENTAL_LEAVE = 10, STUDENT = 11, REGULAR = 12, SEASONAL = 13, PARTIAL_WITH_RESTRICTION = 14, MANAGER = 15, VOLUNTEER = 16, AGENCY = 17,
    - `typeId` object, required — A member type UID indicating the member status
    - `typeCode` object, required — A member type code indicating the member status
    - `email` string, nullable — Member email
    - `phone` string, nullable — Member phone number
    - `hiringDate` number, nullable — Member hiring date in format yyyy-mm-dd
    - `teamIds` string[], nullable — An array of team UID indicating on which team a member can work
    - `teamCodes` string[], nullable — An array of team code indicating on which team a member can work
    - `skillIds` string[], nullable — An array of skill UID indicating on which skill (position) a member can work
    - `skillCodes` string[], nullable — An array of skill code indicating on which skill (position) a member can work
    - `locationIds` string[], nullable — An array of location UID indicating on which location a member can work
    - `locationCodes` string[], nullable — An array of location code indicating on which location a member can work
    - `custom` object, nullable — An optional object of custom properties. Current implementation only support string values
    - `isAdmin` boolean — Indicates if the member is an administrator.
    - `gender` 'M' | 'F' | 'X' | 'P' — Member gender. P mean "Prefer not to say"
    - `emailNotification` boolean — Accept email notifications
    - `pushNotification` boolean — Accept push notifications
    - `birthdate` string — Member date of birth
    - `homeAddress` Address
      - `line1` string, required
      - `line2` string
      - `city` string
      - `state` string
      - `postalCode` string
      - `country` string
      - `latitude` string
      - `longitude` string
    - `primaryEmergencyContactName` string — Member primary emergency contact name
    - `primaryEmergencyContactPhone` string — Member primary emergency contact phone
    - `primaryEmergencyContactNote` string — Member primary emergency contact note
    - `secondaryEmergencyContactName` string — Member secondary emergency contact name
    - `secondaryEmergencyContactPhone` string — Member secondary emergency contact phone
    - `secondaryEmergencyContactNote` string — Member secondary emergency contact note
    - `activity` PublicUserActivity
      - `lastActiveAt` string — Last user activity date and time. In ISO-8601 format
  - `locations` PublicLocation[], required — The list of locations that are linked to the resulting members
    - `uid` string, required — unique location id
    - `status` 'deleted' | 'active', required — Location status
    - `name` string, required — Location name
    - `abbrev` string — Location abbreviation
    - `code` string — The location code. The code is often used as a mapping value between Evolia and an external system
    - `externalId` string — The unique location externalId. The externalId is often used as a mapping value between Evolia and an external system
    - `address` string — Location address
    - `coordinates` string[] — 0: Longitude, 1: Latitude
    - `subLocationIds` string[] — Array of sub location UIDs linked to the location
    - `subLocations` string[] — Array of sub locations
    - `custom` object, nullable — An optional object of custom properties. Current implementation only support string values
  - `skills` PublicSkill[], required — The list of skills that are linked to the resulting members
    - `uid` string, required — unique skill id
    - `status` 'active' | 'deleted', required — Skill status
    - `names` object, required — Multilingual skill name as a map indexed by locale ("en" or "fr")
    - `abbrev` string — Represents the abbreviation of the skill
    - `code` string — The skill code. The code is often used as a mapping value between Evolia and an external system
    - `externalId` string — The skill externalId. The unique externalId is often used as a mapping value between Evolia and an external system
    - `colorIndex` number, required — An index from 0 to 19 matching the skill color palette. Check the create position screen in Evolia settings.
    - `custom` object, nullable — An optional object of custom properties. Current implementation only support string values
  - `teams` PublicTeam[], required — The list of teams that are linked to the resulting members
    - `uid` string, required — unique team id
    - `status` 'active' | 'deleted', required — Team status
    - `names` object, required — Multilingual team name as a map indexed by locale ("en" or "fr")
    - `code` string — The team code. The code is often used as a mapping value between Evolia and an external system
    - `externalId` string — The unique team externalId. The externalId is often used as a mapping value between Evolia and an external system
    - `locationIds` string[], required — Array of location UIDs linked to the team
    - `skillIds` string[], required — Array of skill UIDs linked to the team
    - `custom` object, nullable — An optional object of custom properties. Current implementation only support string values

---

[API](https://skmtc.dev/evolia/apis/public-evolia.md) · [All operations](https://skmtc.dev/evolia/apis/public-evolia/llms.txt) · [OpenAPI document](https://skmtc.dev/evolia/apis/public-evolia/revisions/7d9572f4eff6?raw)