How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Pinwheel Company Connect API

The Company Connect API from Pinwheel — 7 operation(s) for company connect.

Pinwheel Company Connect API is one of 14 APIs that Pinwheel publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Company Connect. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 8 operations across 7 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version v2025-07-08.

Requests are made against 3 base URLs: https://api.getpinwheel.com/v1, https://sandbox.getpinwheel.com/v1, https://development.getpinwheel.com/v1.

8 operations 7 paths 12 schemas 6 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v2025-07-08
Base URL
https://api.getpinwheel.com
Authentication
API Key, HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 2

Pinwheel Company Connect API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-API-SECRET (apiSecret). It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • apiSecret — API Secret
  • bearerAuth — Bearer token

Paths & Operations 8

Across 7 paths, the API surfaces 8 operations — 6 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Company Connect 8
GET
/company_connections/{company_connection_id}/census
List Employees
get_v1_company_connections__company_connection_id__census_get 4 params → 200
GET
/company_connections
List Company Connections
list_v1_company_connections_get 3 params → 200
POST
/company_connections
Create Company Connection
post_v1_company_connections_post 1 param body → 200
GET
/company_connections/{company_connection_id}
Get Company Connection
get_v1_company_connections__company_connection_id__get 2 params → 200
GET
/company_connections/{company_connection_id}/employments
List Employments Data
get_v1_company_connections__company_connection_id__employments_get 4 params → 200
GET
/company_connections/{company_connection_id}/incomes
List Employee Incomes
get_v1_company_connections__company_connection_id__incomes_get 4 params → 200
GET
/company_connections/{company_connection_id}/paystubs/{employee_external_id}
List Employee Paystubs
get_v1_company_connections__company_connection_id__paystubs__employee_external_id__get 7 params → 200
POST
/company_connect/link_tokens
Create Link Token
post_v1_company_connect_link_tokens_post 1 param body → 200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are CompanyPaystubObjResponse (15 properties), CompanyEmploymentObjResponse (12 properties), CompanyIdentityObjResponse (11 properties), AddressGetResponseItem (7 properties). Each schema is shown below with its type and property counts.

CompanyPaystubObjResponse
object
15 properties 10 required
CompanyConnect
object
This class defines the fields present in the companyconnect object in the link token. For non-Company Connect link tokens, this field is optional. If the objec…
1 property
CompanyIdentityObjResponse
object
11 properties 6 required
CompanyConnectLinkTokenCreate
object
6 properties 1 required
PhoneNumberGetResponseItem
object
2 properties 1 required
CompanyIncomeObjResponse
object
6 properties 5 required
CompanyEmploymentObjResponse
object
12 properties 3 required
AddressGetResponseItem
object
7 properties 1 required
CompanyConnectLinkTokenObjResponse
object
4 properties 4 required
PaginationMeta
object
2 properties
CompanyConnectionBase
object
5 properties 5 required
CompanyConnectionCreate
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pinwheel-company-connect-api-openapi.yml Raw ↑

Other APIs Pinwheel publishes across the network.

Pinwheel Accounts API
Pinwheel API Keys API
Pinwheel Direct Deposit Allocations API
Pinwheel Earnings Stream API
Pinwheel Employers and Platforms API
Pinwheel End Users API
Pinwheel Income and Employment API
Pinwheel Jobs API
Pinwheel Link Tokens API
Pinwheel Sandbox API
Pinwheel Tax Forms API
Pinwheel Verification Reports API
Where this information came from

This is an independent, third-party profile of Pinwheel Company Connect API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.