Skip to content

List employees

Request

Security
x-api-key
Query
chatopsEnabledboolean

Filter by whether they have ChatOps enabled

Note: 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.

licensedboolean

Filter by whether they are licensed on the Push platform

groupsArray of strings

Filter by groups the employee is in.

emailstring

Filter by email address. Accepts partial email addresses for wildcard searches.

limitinteger, [ 1 .. 1000 ]

Used for pagination. Number of objects to return.

Default:1000
offsetintegerdeprecated

Used for pagination. Number of objects to skip. Cannot be set when nextToken is also set.

nextTokenstring

Used for pagination. Token to be used for the next request. Cannot be set when offset is also set.

GET
/v1/employees
curl -i -X GET \
  https://api.pushsecurity.com/v1/employees \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
resultArray of objects(Employee)
pagingobject
Response
{
  "result": [
    {
      "id": "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0",
      "email": "john.hill@example.com",
      "firstName": "John",
      "lastName": "Hill",
      "department": "Security Engineering",
      "location": "New York",
      "licensed": true,
      "chatopsEnabled": true,
      "groups": [
        "engineering",
        "marketing"
      ],
      "creationTimestamp": 1698669223
    }
  ],
  "paging": {
    "moreResults": true,
    "next": "501",
    "nextToken": "0b9972aa-fe8d-4095-82d3-2e13cf3cfd43"
  }
}