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

Configuration used to specify a Company Connection.

language

string

enum

Defaults to en

IETF code denoting which language to display in Link.

Allowed:

org_name

string

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

Allowed:

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 2023-07-18

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

Allowed:

Response

200OK