Skip to main content
GET
/
employees
List all employees
curl --request GET \
  --url https://psn-api.paystub.dev/employees \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": 123,
      "site_id": 123,
      "user_id": 123,
      "company_id": 123,
      "first_name": "John",
      "last_name": "Doe",
      "full_name": "John Doe",
      "email": "[email protected]",
      "phone": "+1234567890",
      "ssn": "123-45-6789",
      "masked_ssn": "XXX-XX-6789",
      "additional_info": {},
      "earnings": {},
      "deductions": {},
      "address": {
        "address1": "123 Main St",
        "address2": "Apt 4B",
        "city": "New York",
        "state": "NY",
        "zip": "10001",
        "country": "US",
        "full_address": "123 Main St, Apt 4B, New York, NY 10001, US",
        "formatted_address": "123 Main St<br>Apt 4B<br>New York, NY 10001<br>US"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "company": {
        "id": 123,
        "site_id": 123,
        "user_id": 123,
        "name": "Acme Inc",
        "email": "[email protected]",
        "phone": "+1234567890",
        "ein": "12-3456789",
        "masked_ein": "XX-XXX6789",
        "address": {
          "address1": "123 Main St",
          "address2": "Suite 100",
          "city": "New York",
          "state": "NY",
          "zip": "10001",
          "country": "US",
          "full_address": "123 Main St, Suite 100, New York, NY 10001, US",
          "formatted_address": "123 Main St<br>Suite 100<br>New York, NY 10001<br>US"
        },
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "employees": [
          {}
        ],
        "documents": [
          {
            "id": 123,
            "site_id": 123,
            "user_id": 123,
            "order_id": 123,
            "company_id": 123,
            "employee_id": 123,
            "uuid": "123e4567-e89b-12d3-a456-426614174000",
            "type": "Paystub",
            "template_id": "<string>",
            "color_id": "<string>",
            "quantity": 2,
            "content": {},
            "storage_data": {},
            "errors": {},
            "status": "Pending",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "company": {},
            "employee": {}
          }
        ],
        "employees_count": 123,
        "documents_count": 123
      },
      "documents": [
        {
          "id": 123,
          "site_id": 123,
          "user_id": 123,
          "order_id": 123,
          "company_id": 123,
          "employee_id": 123,
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "type": "Paystub",
          "template_id": "<string>",
          "color_id": "<string>",
          "quantity": 2,
          "content": {},
          "storage_data": {},
          "errors": {},
          "status": "Pending",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "company": {},
          "employee": {}
        }
      ],
      "documents_count": 123
    }
  ],
  "links": {
    "first": "https://api.paystub.dev/employees?page=1",
    "last": "https://api.paystub.dev/employees?page=1",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": "<string>",
        "label": "<string>",
        "active": true
      }
    ],
    "path": "https://api.paystub.dev/employees",
    "per_page": 15,
    "to": 1,
    "total": 1
  }
}

Authorizations

Authorization
string
header
required

Use your API token

Query Parameters

filter[company_id]
integer

Filter by company ID

filter[first_name]
string

Filter by first name

filter[last_name]
string

Filter by last name

filter[email]
string

Filter by email

sort
enum<string>

Sort by field

Available options:
first_name,
-first_name,
last_name,
-last_name,
company_id,
-company_id,
created_at,
-created_at
include
enum<string>

Include related resources

Available options:
company,
documents
per_page
integer
default:15

Number of items per page

Response

List of employees

success
boolean
Example:

true

data
object[]
meta
object