v1

latestOpenAPI 3.0.22026-07-24154101.1 MB
Account

Create Trial Account

post/v2/partner_company_creation

Headers

x-api-versionstring

An API version

Example:2022-05-01

7shifts API version

x-company-guidstring uuid

Company GUID

Request body

emailstring required

The user's email

firstnamestring required

The user's first name

lastnamestring required

The user's last name

company_namestring required

The company's name

country'CA' | 'US' required

The company's country

mobile_phonestring

The user's mobile phone

utm_campaignstring

The UTM campaign

utm_contentstring

The UTM content

utm_mediumstring

The UTM medium

utm_sourcestring required

The UTM source

utm_termstring

The UTM term

create_company_grantboolean

If true, it will create a company grant for the calling OAuth client and the GUID returned in the response. If false, it will not create a company grant.

Response

Created

object'partner_company' required

Example response

{
  "data": {
    "company_grant_guid": "1310bfe1-cb3f-4f24-98a2-fde2bc504108"
  }
}