employees_list

GET

/pegasus/employees/api/employees/

const url = 'https://example.com/pegasus/employees/api/employees/';
const options = {method: 'GET', headers: {cookie: 'sessionid=<sessionid>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/pegasus/employees/api/employees/ \
  --cookie sessionid=<sessionid>

Authorizations

cookieAuth
ApiKeyAuth

Parameters

Query Parameters

page

integer

A page number within the paginated result set.

Responses

200

application/json

object

count

required

integer

next

string format: uri

nullable

previous

string format: uri

nullable

results

required

Array<object>

object

required

integer

user

required

integer

name

required

Your employee’s name.

string

<= 100 characters

department

required

hr - Human Resources
finance - Finance
engineering - Engineering
marketing - Marketing
sales - Sales

string

Allowed values: hr finance engineering marketing sales

salary

required

Your employee’s annual salary.

integer

<= 2147483647

created_at

required

string format: date-time

updated_at

required

string format: date-time

Example

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "department": "hr"
    }
  ]
}