Public
Members

Get members (employees)

Changed on
get/v1/public/members

Request

  • Base URL
    https://api.evolia.com
  • Auth
    HTTP basic

Query parameters

includeAdminsboolean

if true, administrators will be included in the result.

includeSupervisorsboolean

if true, supervisors will be included in the result.

includeManagersboolean

if true, managers will be included in the result.

includeEmployeesboolean

if true, employees will be included in the result.

status'active' | 'inactive'

if specified, only members with this status will be returned

includeRelationshipsboolean

if true, entities (locations, skills, teams) related to members will also be returned.

skipnumber

Paging attribute, Skips over the specified number of item.

takenumber

Paging attribute, limits the number of item to fetch.

Response

Example response

{
  "members": [
    {
      "code": "12",
      "hourlyWageBySkillCodes": {
        "assistant": 18.25,
        "lead": 20.53
      },
      "hourlyWageBySkillIds": {
        "64f1a2b3c4d5e6f7890abcde": 18.25,
        "64f1a2b3c4d5e6f7890abcdf": 20.53
      },
      "pin": "98765",
      "email": "johndoe@email.com",
      "phone": "418-262-1123",
      "custom": {
        "key1": "value1",
        "key2": "value2"
      },
      "gender": "M",
      "birthdate": "2001-01-31",
      "homeAddress": {
        "line2": "string",
        "city": "string",
        "state": "string",
        "postalCode": "string",
        "country": "string"
      }
    }
  ],
  "locations": [
    {
      "custom": {
        "key1": "value1",
        "key2": "value2"
      }
    }
  ],
  "skills": [
    {
      "names": {
        "en": "cook",
        "fr": "cuisinier"
      },
      "custom": {
        "key1": "value1",
        "key2": "value2"
      }
    }
  ],
  "teams": [
    {
      "names": {
        "en": "customer service",
        "fr": "service client"
      },
      "custom": {
        "key1": "value1",
        "key2": "value2"
      }
    }
  ]
}

Changes

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status