# List employees

Endpoint: GET /v1/employees
Version: v1
Security: x-api-key

## Query parameters:

  - `chatopsEnabled` (boolean)
    Filter by whether they have ChatOps enabledNote: this is a legacy value available for use by Push accounts that are using employee ChatOps topics. This value will be removed in a future version of the API, however, no timeline has been set. Push will provide ample notice of deprecation ahead of time, as well as a replacement option.

  - `licensed` (boolean)
    Filter by whether they are licensed on the Push platform

  - `groups` (array)
    Filter by groups the employee is in.

  - `email` (string)
    Filter by email address. Accepts partial email addresses for wildcard searches.

  - `limit` (integer)
    Used for pagination. Number of objects to return.

  - `nextToken` (string)
    Used for pagination. Token to be used for the next request. Cannot be set when offset is also set.

  - `offset` (integer)
    Used for pagination. Number of objects to skip. Cannot be set when nextToken is also set.

## Response 200 fields (application/json):

  - `result` (array)

  - `result.id` (string)
    Unique identifier for the employee
    Example: "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0"

  - `result.email` (string)
    Primary email address of the employee
    Example: "john.hill@example.com"

  - `result.firstName` (string)
    First name of the employee
    Example: "John"

  - `result.lastName` (string)
    Last name of the employee
    Example: "Hill"

  - `result.department` (string)
    Department - as provided by connected API integrations
    Example: "Security Engineering"

  - `result.location` (string)
    Location - as provided by connected API integrations
    Example: "New York"

  - `result.licensed` (boolean)
    Whether the employee is licensed on the Push platform
    Example: true

  - `result.groups` (array)
    Groups the employee is in
    Example: ["engineering","marketing"]

  - `result.creationTimestamp` (integer)
    When this employee was created, formatted as a UNIX timestamp (in seconds)
    Example: 1698669223

  - `result.chatopsEnabled` (boolean)
    Whether the employee has ChatOps enabledDeprecation notice: this value no longer does anything unless you still have access to the legacy Employee chat topics functionality on your account. It will be removed in the next API version.
    Example: true

  - `paging` (object)

  - `paging.moreResults` (boolean)
    Whether there are more results available
    Example: true

  - `paging.nextToken` (string,null)
    Start of the next page that can be used as the nextToken for the next request.
    Example: "0b9972aa-fe8d-4095-82d3-2e13cf3cfd43"

  - `paging.next` (string,null)
    Start of the next page that can be used as the offset for the next request
    Example: "501"


## Response 400 fields