{
  "opencollection": "1.0.0",
  "info": {
    "name": "Pinwheel Accounts Company Connect API",
    "version": "v2025-07-08"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-API-SECRET",
      "value": "{{X-API-SECRET}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Company Connect",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Employees",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.getpinwheel.com/v1/company_connections/:company_connection_id/census",
            "headers": [
              {
                "name": "Pinwheel-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "company_connection_id",
                "value": "",
                "type": "path",
                "description": "UUID of the Company Connection."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Cursor for the page you want to retrieve."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of results to return."
              }
            ]
          },
          "docs": "List all employee census data reported by the payroll platform. This is a paginated endpoint; see how Pinwheel implements pagination <a href='https://docs.pinwheelapi.com/docs/pagination-1' target='_blank'>here</a>."
        },
        {
          "info": {
            "name": "List Company Connections",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.getpinwheel.com/v1/company_connections",
            "headers": [
              {
                "name": "Pinwheel-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Cursor for the page you want to retrieve."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of results to return."
              }
            ]
          },
          "docs": "List all Company Connections. This is a paginated endpoint; see how Pinwheel implements pagination <a href='https://docs.pinwheelapi.com/docs/pagination-1' target='_blank'>here</a>."
        },
        {
          "info": {
            "name": "Create Company Connection",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.getpinwheel.com/v1/company_connections",
            "headers": [
              {
                "name": "Pinwheel-Version",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a Company Connection used to get income & employment data from your target company."
        },
        {
          "info": {
            "name": "Get Company Connection",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.getpinwheel.com/v1/company_connections/:company_connection_id",
            "headers": [
              {
                "name": "Pinwheel-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "company_connection_id",
                "value": "",
                "type": "path",
                "description": "UUID of the Company Connection."
              }
            ]
          },
          "docs": "Get Company Connection."
        },
        {
          "info": {
            "name": "List Employments Data",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.getpinwheel.com/v1/company_connections/:company_connection_id/employments",
            "headers": [
              {
                "name": "Pinwheel-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "company_connection_id",
                "value": "",
                "type": "path",
                "description": "UUID of the Company Connection."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Cursor for the page you want to retrieve."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of results to return."
              }
            ]
          },
          "docs": "List all employments data reported by the payroll platform. This is a paginated endpoint; see how Pinwheel implements pagination <a href='https://docs.pinwheelapi.com/docs/pagination-1' target='_blank'>here</a>."
        },
        {
          "info": {
            "name": "List Employee Incomes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.getpinwheel.com/v1/company_connections/:company_connection_id/incomes",
            "headers": [
              {
                "name": "Pinwheel-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "company_connection_id",
                "value": "",
                "type": "path",
                "description": "UUID of the Company Connection."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Cursor for the page you want to retrieve."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of results to return."
              }
            ]
          },
          "docs": "List all employee income data reported by the payroll platform. This is a paginated endpoint; see how Pinwheel implements pagination <a href='https://docs.pinwheelapi.com/docs/pagination-1' target='_blank'>here</a>."
        },
        {
          "info": {
            "name": "List Employee Paystubs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.getpinwheel.com/v1/company_connections/:company_connection_id/paystubs/:employee_external_id",
            "headers": [
              {
                "name": "Pinwheel-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "company_connection_id",
                "value": "",
                "type": "path",
                "description": "UUID of the Company Connection."
              },
              {
                "name": "employee_external_id",
                "value": "",
                "type": "path",
                "description": "Employee ID as reported by their employer."
              },
              {
                "name": "from_pay_date",
                "value": "",
                "type": "query",
                "description": "Filter for paystubs with pay dates after this date."
              },
              {
                "name": "to_pay_date",
                "value": "",
                "type": "query",
                "description": "Filter for paystubs with pay dates before this date."
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Cursor for the page you want to retrieve."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of results to return."
              }
            ]
          },
          "docs": "List employee paystubs data reported by the payroll platform. This is a paginated endpoint; see how Pinwheel implements pagination <a href='https://docs.pinwheelapi.com/docs/pagination-1' target='_blank'>here</a>."
        },
        {
          "info": {
            "name": "Create Link Token",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.getpinwheel.com/v1/company_connect/link_tokens",
            "headers": [
              {
                "name": "Pinwheel-Version",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a Company Connect link token used to launch a Link modal."
        }
      ]
    }
  ],
  "bundled": true
}