---
title: "Create Link Token"
method: POST
path: "/company_connect/link_tokens"
tags: ["Company Connect"]
---

# Create Link Token

`POST /company_connect/link_tokens`

## Request

- Base URL: `https://api.getpinwheel.com/v1`
- URL: `https://api.getpinwheel.com/v1/company_connect/link_tokens`
- 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)

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

## Headers

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

## Request body

- CompanyConnectLinkTokenCreate
  - `required_jobs` string[]: 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_name` string, required: Organization or app name that is displayed to the user.
  - `skip_intro_screen` boolean: If set to true, intro screen is not shown to user.
  - `platform_id` string, 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.
  - `company_connect` CompanyConnect
    - `company_connection_id` string, uuid: ID of the Company Connection.

## Response `200`

OK

- object
  - `data` CompanyConnectLinkTokenObjResponse, required
    - `mode` 'sandbox' | 'development' | 'production', required: Token mode, i.e. `sandbox`, `development`, or `production`.
    - `id` string, uuid, required: UUID of the link token.
    - `token` string, required: Short-lived token that is used to initialize Pinwheel Link.
    - `expires` string, date-time, required: The token will be invalid after this timestamp.

## Changes

- **2026-11-11** `d1c86ae1189c`: 1 breaking
  - removed the enum value `es-419` of the request property `language`
- **2026-08-04** `bf20c4d4c5d3`: 2 info
  - added the new `es-419` enum value to the request property `language`
  - added the new `pt-br` enum value to the request property `language`

[Operation history](https://skmtc.dev/getpinwheel/apis/pinwheel/changes/company_connect/link_tokens/post.md)

---

[API](https://skmtc.dev/getpinwheel/apis/pinwheel.md) - [All operations](https://skmtc.dev/getpinwheel/apis/pinwheel/llms.txt) - [OpenAPI document](https://skmtc.dev/getpinwheel/apis/pinwheel/revisions/d1c86ae1189c?raw)