Company Connect

Create Link Token

Create a Company Connect link token used to launch a Link modal.

post/company_connect/link_tokens

Request

Base URL
https://api.getpinwheel.com/v1
Auth
API key in header X-API-SECRET
TypeScript
https://skmtc.dev/getpinwheel/apis/pinwheel/docs/company_connect/link_tokens/post.ts
A function with typed inputs. Its response is checked against the schema.

Pinwheel-Version'2025-07-08' | '2023-11-22' | '2023-07-18' | '2023-04-18' | '2022-09-09' | '2022-06-22' | '2022-03-02' required

Version identifier specifying how the Pinwheel API should behave. See the Change Management page for more information.

required_jobsstring[]

List of job types to be performed on the Company Connection. Platforms that do not support ALL of these jobs will not be visible to the user.

org_namestring required

Organization or app name that is displayed to the user.

skip_intro_screenboolean

If set to true, intro screen is not shown to user.

platform_idstring uuid

UUID of a platform. If set, user is taken directly to Link login screen.

language'en' | 'es' | 'pt-br'

IETF code denoting which language to display in Link.

Nov 11, 2026d1c86ae1189c Revision changes
- breaking
  removed the enum value es-419 of the request property
Aug 4, 2026bf20c4d4c5d3 Revision changes
- info
  added the new es-419 enum value to the request property
- info
  added the new pt-br enum value to the request property