Skip to main content
GET
/
documents
List all documents
curl --request GET \
  --url https://psn-api.paystub.dev/documents \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "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": 1,
      "content": {},
      "storage_data": {},
      "errors": {},
      "status": "Pending",
      "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": [
          {
            "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": {},
            "documents": [
              {}
            ],
            "documents_count": 123
          }
        ],
        "documents": [
          {}
        ],
        "employees_count": 123,
        "documents_count": 123
      },
      "employee": {
        "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": {},
        "documents": [
          {}
        ],
        "documents_count": 123
      }
    }
  ],
  "links": {
    "first": "https://api.paystub.dev/documents?page=1",
    "last": "https://api.paystub.dev/documents?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/documents",
    "per_page": 15,
    "to": 1,
    "total": 1
  }
}

Authorizations

Authorization
string
header
required

Use your API token

Query Parameters

filter[uuid]
string<uuid>

Filter by UUID

filter[type]
enum<string>

Filter by document type

Available options:
Paystub,
W2,
1099-MISC,
Invoice
filter[status]
enum<string>

Filter by status

Available options:
Pending,
Processing,
Completed,
Failed
filter[company_id]
integer

Filter by company ID

filter[employee_id]
integer

Filter by employee ID

include
enum<string>

Include related resources

Available options:
company,
employee
sort
enum<string>

Sort by field

Available options:
created_at,
-created_at,
type,
-type,
status,
-status
per_page
integer
default:15

Number of items per page

Response

List of documents

success
boolean
Example:

true

data
object[]
meta
object