v12.11.0

V2 Staging API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

REST API v2. Authenticate with a Bearer JWT in the Authorization header unless an endpoint is marked public.

Servers

https://v2-staging.tscheckout.comCurrent host

---

InviteImports

CSV invite import: upload file, set options, map columns, and run import.

Operations

GET/api/v2/invite-importsPOST/api/v2/invite-importsGET/api/v2/invite-imports/mapping-fieldsGET/api/v2/invite-imports/{id}DELETE/api/v2/invite-imports/{id}PATCH/api/v2/invite-imports/{id}GET/api/v2/invite-imports/{id}/previewPOST/api/v2/invite-imports/{id}/process

---

List invite imports

GET

/api/v2/invite-imports

Returns a list of invite imports

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Responses

Invite Import list

Content-Type

application/json

{

  

"count": 10,

  

"totalCount": 25,

  

"limit": 50,

  

"offset": 25,

  

"data": [

  

]

}

GET

/api/v2/invite-imports

Playground

Authorization

bearerAuth

Samples

---

Create invite import

POST

/api/v2/invite-imports

Upload a CSV file and create a draft invite import.

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

multipart/form-data

object

CSV file

Format"binary"

Responses

Invite import created

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/invite-imports

Playground

Authorization

bearerAuth

Body

file*

sendEmailsOnImport

emailTemplateId

inviteGroup

expirationTimestamp

skipFirstRow

Samples

---

Get mapping fields

GET

/api/v2/invite-imports/mapping-fields

Returns column mapping field options for CSV invite imports

Authorizations

bearerAuth

Type

HTTP (bearer)

Responses

Mapping field options

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/invite-imports/mapping-fields

Playground

Authorization

bearerAuth

Samples

---

Get invite import by ID

GET

/api/v2/invite-imports/{id}

Returns a single invite import by ID

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

integer

Required

Responses

Invite import object

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/invite-imports/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Delete invite import

DELETE

/api/v2/invite-imports/{id}

Delete invite import record and file from storage.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

integer

Required

Responses

Deleted successfully

DELETE

/api/v2/invite-imports/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Update invite import

PATCH

/api/v2/invite-imports/{id}

Update invite import settings or column mapping. Allowed only when status is drafting.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

integer

Required

Request Body

application/json

"string"

Responses

Invite import object

Content-Type

application/json

{

  

"data": "string"

}

PATCH

/api/v2/invite-imports/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Preview invite import

GET

/api/v2/invite-imports/{id}/preview

Returns row count and estimated invites created without writing

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

integer

Required

Responses

Preview data

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/invite-imports/{id}/preview

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Process invite import

POST

/api/v2/invite-imports/{id}/process

Runs the CSV invite import.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

integer

Required

Responses

Import result

Content-Type

application/json

{

  

"data": {

  

}

}

POST

/api/v2/invite-imports/{id}/process

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---