API docs by Redocly

KiteTags FTW (1.5)

Download OpenAPI specification:

The nestjs API description

AppController_getHello

Responses

AppController_getVersion

Responses

StripeController_createCheckoutSession

Request Body schema: application/json
required
object (CreateCheckoutSessionDto)

Responses

Request samples

Content type
application/json
{ }

StripeController_handleWebhook

header Parameters
stripe-signature
required
string

Responses

StripeController_getSubscription

Responses

StripeController_getInvoices

Responses

StripeController_cancelSubscription

Responses

InteractionsController_create

Request Body schema: application/json
required
name
required
string
fields
required
object
groupId
required
number
userId
required
number
structureId
required
number
appAction
required
string
secondaryName
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "fields": { },
  • "groupId": 0,
  • "userId": 0,
  • "structureId": 0,
  • "appAction": "string",
  • "secondaryName": "string"
}

InteractionsController_findAll

Responses

Response samples

Content type
application/json
[
  • {
    }
]

InteractionsController_findByUserId

path Parameters
userId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

InteractionsController_findByApiKey

path Parameters
apiKey
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

InteractionsController_findOne

path Parameters
id
required
string

Responses

InteractionsController_update

path Parameters
id
required
string
Request Body schema: application/json
required
name
string
fields
object
groupId
number
userId
number
structureId
number
appAction
string
secondaryName
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "fields": { },
  • "groupId": 0,
  • "userId": 0,
  • "structureId": 0,
  • "appAction": "string",
  • "secondaryName": "string"
}

InteractionsController_remove

path Parameters
id
required
string

Responses

TapHistoryController_getAllRecordsByUserKey

path Parameters
userId
required
number

Responses

TapHistoryController_getAllRecordsByInteractionId

path Parameters
interactionId
required
number
header Parameters
apikey
required
string

Responses

TapHistoryController_getAllRecordsAsFlatArrayByInteractionId

path Parameters
interactionId
required
number
header Parameters
apikey
required
string

Responses

users

UsersController_create

Request Body schema: application/json
required
email
required
string
password
required
string
firstname
required
string
lastname
required
string
address
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "address": "string"
}

Response samples

Content type
application/json
{
  • "apiKey": "string",
  • "id": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "email": "string"
}

UsersController_findAll

Authorizations:
bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

UsersController_findOne

Authorizations:
bearer
path Parameters
id
required
number

Responses

Response samples

Content type
application/json
{
  • "apiKey": "string",
  • "id": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "email": "string"
}

UsersController_update

Authorizations:
bearer
path Parameters
id
required
number
Request Body schema: application/json
required
email
string
password
string
firstname
string
lastname
string
address
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "address": "string"
}

Response samples

Content type
application/json
{
  • "apiKey": "string",
  • "id": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "email": "string"
}

UsersController_remove

Authorizations:
bearer
path Parameters
id
required
number

Responses

Response samples

Content type
application/json
{
  • "apiKey": "string",
  • "id": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "email": "string"
}

UsersController_getUserWithGroups

Authorizations:
bearer
path Parameters
id
required
number

Responses

Response samples

Content type
application/json
{
  • "apiKey": "string",
  • "id": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "email": "string"
}

UsersController_getUserDataStructures

Authorizations:
bearer
path Parameters
id
required
number

Responses

Response samples

Content type
application/json
[
  • {
    }
]

UsersController_changeStatus

Authorizations:
bearer
path Parameters
id
required
number
Request Body schema: application/json
required
object (UpdateUserRoleDto)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "apiKey": "string",
  • "id": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "email": "string"
}

auth

AuthController_login

Request Body schema: application/json
required
email
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "userId": 0,
  • "accessToken": "string",
  • "refreshToken": "string",
  • "role": "string"
}

AuthController_refresh

Responses

AuthController_logout

Responses

AuthController_getProfile

Responses

Response samples

Content type
application/json
{
  • "userId": 0,
  • "accessToken": "string",
  • "refreshToken": "string",
  • "role": "string"
}

AuthController_getBasicHello

Responses

Response samples

Content type
application/json
{
  • "userId": 0,
  • "accessToken": "string",
  • "refreshToken": "string",
  • "role": "string"
}

AuthController_getApiKeyHello

header Parameters
apikey
required
string

Responses

AuthController_requestPasswordReset

Request Body schema: application/json
required
object (RequestPasswordResetDto)

Responses

Request samples

Content type
application/json
{ }

AuthController_resetPassword

Request Body schema: application/json
required
object (ResetPasswordDto)

Responses

Request samples

Content type
application/json
{ }

AuthController_generateApiKey

Request Body schema: application/json
required
userId
required
number

User ID to associate with the generated API key

Responses

Request samples

Content type
application/json
{
  • "userId": 0
}

Response samples

Content type
application/json
"string"

AuthController_getApiKeyByUserId

path Parameters
userId
required
number

Responses

Response samples

Content type
application/json
"string"

groups

GroupsController_create

Request Body schema: application/json
required
name
required
string
quantity
required
number
active_structure
object or null
active_interaction
object or null
userId
required
number
default_group
required
boolean
testflight_mode
required
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "quantity": 0,
  • "active_structure": { },
  • "active_interaction": { },
  • "userId": 0,
  • "default_group": true,
  • "testflight_mode": true
}

GroupsController_findAll

Responses

Response samples

Content type
application/json
[
  • {
    }
]

GroupsController_checkName

query Parameters
name
required
string
userId
required
string

Responses

GroupsController_findOne

path Parameters
id
required
string

Responses

GroupsController_update

path Parameters
id
required
string
Request Body schema: application/json
required
name
string
quantity
number
active_structure
object or null
active_interaction
object or null
userId
number
default_group
boolean
testflight_mode
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "quantity": 0,
  • "active_structure": { },
  • "active_interaction": { },
  • "userId": 0,
  • "default_group": true,
  • "testflight_mode": true
}

GroupsController_remove

path Parameters
id
required
number

Responses

GroupsController_getGroupWithTags

Authorizations:
bearer
path Parameters
id
required
number

Responses

Response samples

Content type
application/json
{
  • "active_structure": 0,
  • "active_interaction": 0,
  • "quantity": 0,
  • "interactions": [
    ],
  • "userId": { },
  • "id": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "testflight_mode": true,
  • "default_group": true
}

GroupsController_switchActiveStructure

Authorizations:
bearer
path Parameters
groupId
required
number

Responses

GroupsController_updateActiveInteraction

Authorizations:
bearer
path Parameters
groupId
required
number
Request Body schema: application/json
required
name
string
quantity
number
active_structure
object or null
active_interaction
object or null
userId
number
default_group
boolean
testflight_mode
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "quantity": 0,
  • "active_structure": { },
  • "active_interaction": { },
  • "userId": 0,
  • "default_group": true,
  • "testflight_mode": true
}

GroupsController_duplicateGroup

path Parameters
id
required
number

Responses

GroupsController_moveTags

path Parameters
groupId
required
number

Responses

GroupsController_moveSelectedTags

path Parameters
groupId
required
number
Request Body schema: application/json
required
object (MoveSelectedTagsDto)

Responses

Request samples

Content type
application/json
{ }

GroupsController_toggleTestFlight

path Parameters
id
required
string

Responses

GroupsController_exportGroupData

Authorizations:
bearer
path Parameters
id
required
number

Responses

tags

TagsController_create

Request Body schema: application/json
required
callsign
required
string
bundleId
required
string
uid
required
string
customerId
required
string
groupId
number
required
Array of objects (FieldDataDto)

The fields associated with the tag for a specific structure

required
object

Additional data for flexible fields

Responses

Request samples

Content type
application/json
{
  • "callsign": "string",
  • "bundleId": "string",
  • "uid": "string",
  • "customerId": "string",
  • "groupId": 0,
  • "fieldData": [
    ],
  • "additionalData": { }
}

Response samples

Content type
application/json
{
  • "uid": "string",
  • "bundleId": "string",
  • "callsign": "string",
  • "customerId": "string",
  • "groupId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "fieldData": [
    ],
  • "additionalData": { }
}

TagsController_findAll

Responses

Response samples

Content type
application/json
[
  • {
    }
]

TagsController_updateBulk

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

TagsController_claimTag

path Parameters
uid
required
string
Request Body schema: application/json
required
customerId
required
string
userId
required
number
newUser
required
boolean

Responses

Request samples

Content type
application/json
{
  • "customerId": "string",
  • "userId": 0,
  • "newUser": true
}

TagsController_checkUser

Request Body schema: application/json
required
email
required
string
tagUid
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "tagUid": "string"
}

TagsController_verifyEmail

query Parameters
token
required
string

Responses

TagsController_checkTag

path Parameters
uid
required
string
number
required
string

Responses

Response samples

Content type
application/json
"string"

TagsController_findOne

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "uid": "string",
  • "bundleId": "string",
  • "callsign": "string",
  • "customerId": "string",
  • "groupId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "fieldData": [
    ],
  • "additionalData": { }
}

TagsController_remove

path Parameters
uid
required
string

Responses

Response samples

Content type
application/json
{
  • "uid": "string",
  • "bundleId": "string",
  • "callsign": "string",
  • "customerId": "string",
  • "groupId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "fieldData": [
    ],
  • "additionalData": { }
}

TagsController_updateField

path Parameters
uid
required
string
Request Body schema: application/json
required
structureId
required
number
fieldName
required
string
fieldValue
required
string

Responses

Request samples

Content type
application/json
{
  • "structureId": 0,
  • "fieldName": "string",
  • "fieldValue": "string"
}

Response samples

Content type
application/json
{
  • "uid": "string",
  • "bundleId": "string",
  • "callsign": "string",
  • "customerId": "string",
  • "groupId": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "fieldData": [
    ],
  • "additionalData": { }
}

TagsController_uploadCsv

Request Body schema: application/json
required
object (UploadCsvDto)

Responses

Request samples

Content type
application/json
{ }

TagsController_bulkCreate

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • {
    }
]

TagsController_getInteractionData

path Parameters
interactionId
required
number

Responses

TagsController_triggerWebhook

Responses

TagsController_getVCardData

Responses

TagsController_registerWebhook

Request Body schema: application/json
required
object (RegisterWebhookDto)

Responses

Request samples

Content type
application/json
{ }

TagsController_unregisterWebhook

Request Body schema: application/json
required
object (UnregisterWebhookDto)

Responses

Request samples

Content type
application/json
{ }

structures

StructuresController_create

Request Body schema: application/json
required
name
required
string
fields
required
Array of strings
userId
required
number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "fields": [
    ],
  • "userId": 0
}

StructuresController_findAll

Responses

Response samples

Content type
application/json
[
  • {
    }
]

StructuresController_findOne

path Parameters
id
required
string

Responses

StructuresController_update

path Parameters
id
required
string
Request Body schema: application/json
required
name
string
fields
Array of strings
userId
number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "fields": [
    ],
  • "userId": 0
}

StructuresController_remove

path Parameters
id
required
string

Responses

StructuresController_getInteractions

path Parameters
id
required
number

Responses