Create Link Token

post

https://api.getpinwheel.com/v1/company_connect/link_tokens

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

Body Params

company_connect

object

This class defines the fields present in the company_connect object in
the link token.

For non-Company Connect link tokens, this field is optional. If the object
is present, it indicates that the link token is a Company Connect link
token.

Attributes:
company_connection_id (UUID): This field specifies the ID of the
company connection. This ID is generated by Pinwheel. All Company
Connect webhooks reference the connection by this ID, and all
public CC API endpoints require this ID as well.

language

string

enum

Defaults to en

IETF code denoting which language to display in Link.

Allowed:

org_name

string

required

length between 3 and 30

Organization or app name that is displayed to the user.

platform_id

uuid

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

required_jobs

array of strings

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.

required_jobs

skip_intro_screen

boolean

Defaults to false

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

Headers

Pinwheel-Version

string

enum

required

Defaults to 2025-07-08

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

Allowed:

Response

Language

Credentials

Header

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK