Schemas | HRMLESS

Activity

name

string · minLength: 1 · maxLength: 200 · required

value

string · minLength: 1 · maxLength: 200 · required

candidate

string · uuid · required

id

string · uuid

timestamp

string · date-time · readOnly

ActivityCreate

name

string · minLength: 1 · maxLength: 200 · required

value

string · minLength: 1 · maxLength: 200 · required

candidate

string · uuid · required

timestamp

string · date-time · readOnly

Email

email_type

string · enum · required

Enum values:

ai_interview_invitation

min_score

incomplete_interview

candidates

(string | null)[] · required

Questionnaire

name

string · minLength: 1 · maxLength: 250 · required

value

string · minLength: 1 · maxLength: 250 · required

id

string · uuid

is_knockout

boolean

expected_result

string · maxLength: 250

InterviewDetailsSeralizer

interview_link

string · minLength: 1 · required

position_name

string · minLength: 1 · required

candidate_name

string · minLength: 1 · required

organization_name

string · minLength: 1 · required

Questionnaire[] · required

accepted_languages

string[]

Default: []

line_items

price_id

string · minLength: 1 · required

CreateCheckoutSession

customer_id

string · minLength: 1 · required

success_url

string · minLength: 1 · required

cancel_url

string · minLength: 1 · required

line_items[] · required

AutomaticTaxSerializer_

enabled

boolean · required

liability

string | null · minLength: 1 · required

status

string | null · minLength: 1 · required

CustomText

shipping_address

string | null · minLength: 1 · required

submit

string | null · minLength: 1 · required

InvoiceData

account_tax_ids

string | null · minLength: 1 · required

custom_fields

string | null · minLength: 1 · required

description

string | null · minLength: 1 · required

footer

string | null · minLength: 1 · required

issuer

string | null · minLength: 1 · required

object · required

rendering_options

string | null · minLength: 1 · required

InvoiceCreation

enabled

boolean · required

InvoiceData · required

PhoneNumberCollection

enabled

boolean · required

TotalDetails

amount_discount

integer · required

amount_shipping

integer · required

amount_tax

integer · required

CheckoutResponse

id

string · minLength: 1 · required

object

string · minLength: 1 · required

after_expiration

string | null · minLength: 1 · required

allow_promotion_codes

string | null · minLength: 1 · required

amount_subtotal

integer · required

amount_total

integer · required

AutomaticTaxSerializer_ · required

billing_address_collection

string | null · minLength: 1 · required

cancel_url

string | null · minLength: 1 · required

client_reference_id

string | null · minLength: 1 · required

consent

string | null · minLength: 1 · required

consent_collection

string | null · minLength: 1 · required

created

integer · required

currency

string · minLength: 1 · required

custom_fields

(string | null)[] · required

CustomText · required

customer

string | null · minLength: 1 · required

customer_creation

string · minLength: 1 · required

customer_details

string | null · minLength: 1 · required

customer_email

string | null · minLength: 1 · required

expires_at

integer · required

invoice

string | null · minLength: 1 · required

InvoiceCreation · required

livemode

boolean · required

locale

string | null · minLength: 1 · required

object · required

mode

string · minLength: 1 · required

payment_intent

string | null · minLength: 1 · required

payment_link

string | null · minLength: 1 · required

payment_method_collection

string · minLength: 1 · required

object · required

payment_method_types

string[] · required

payment_status

string · minLength: 1 · required

PhoneNumberCollection · required

recovered_from

string | null · minLength: 1 · required

setup_intent

string | null · minLength: 1 · required

shipping_address_collection

string | null · minLength: 1 · required

shipping_cost

string | null · minLength: 1 · required

shipping_details

string | null · minLength: 1 · required

shipping_options

(string | null)[] · required

status

string · minLength: 1 · required

submit_type

string | null · minLength: 1 · required

subscription

string | null · minLength: 1 · required

success_url

string · minLength: 1 · required

TotalDetails · required

url

string · minLength: 1 · required

Customer

email

string · email · minLength: 1 · required

name

string · minLength: 1 · required

InvoiceSettings

custom_fields

object | null · required

default_payment_method

string | null · minLength: 1 · required

footer

string | null · minLength: 1 · required

rendering_options

object | null · required

CustomerResponse

id

string · minLength: 1 · required

object

string · minLength: 1 · required

address

object | null · required

balance

integer · required

created

integer · required

currency

string | null · minLength: 1 · required

default_source

string | null · minLength: 1 · required

delinquent

boolean · required

description

string | null · minLength: 1 · required

discount

object | null · required

email

string · email · minLength: 1 · required

invoice_prefix

string · minLength: 1 · required

InvoiceSettings · required

livemode

boolean · required

metadata

object · required

name

string · minLength: 1 · required

next_invoice_sequence

integer · required

phone

string | null · minLength: 1 · required

shipping

object | null · required

tax_exempt

string · minLength: 1 · required

test_clock

object | null · required

preferred_locales

string[]

Default: []

CreateSubscription

payment_method_id

string · minLength: 1 · required

customer_id

string · minLength: 1 · required

price_id

string · minLength: 1 · required

AutomaticTax

disabled_reason

string | null · minLength: 1 · required

enabled

boolean · required

liability

string | null · minLength: 1 · required

CancellationDetails

comment

string | null · minLength: 1 · required

feedback

string | null · minLength: 1 · required

reason

string | null · minLength: 1 · required

InvoiceIssuer

type

string · minLength: 1 · required

NewInvoiceSettings

account_tax_ids

string | null · minLength: 1 · required

InvoiceIssuer · required

Plan

id

string · minLength: 1 · required

object

string · minLength: 1 · required

active

boolean · required

amount

integer · required

amount_decimal

string · minLength: 1 · required

billing_scheme

string · minLength: 1 · required

created

integer · required

currency

string · minLength: 1 · required

interval

string · minLength: 1 · required

interval_count

integer · required

livemode

boolean · required

metadata

object · required

meter

string | null · minLength: 1 · required

nickname

string | null · minLength: 1 · required

product

string · minLength: 1 · required

tiers_mode

string | null · minLength: 1 · required

transform_usage

string | null · minLength: 1 · required

trial_period_days

integer | null · required

usage_type

string · minLength: 1 · required

Recurring

interval

string · minLength: 1 · required

interval_count

integer · required

meter

string | null · minLength: 1 · required

trial_period_days

integer | null · required

usage_type

string · minLength: 1 · required

Price

id

string · minLength: 1 · required

object

string · minLength: 1 · required

active

boolean · required

billing_scheme

string · minLength: 1 · required

created

integer · required

currency

string · minLength: 1 · required

custom_unit_amount

string | null · minLength: 1 · required

livemode

boolean · required

lookup_key

string | null · minLength: 1 · required

metadata

object · required

nickname

string | null · minLength: 1 · required

product

string · minLength: 1 · required

Recurring · required

tax_behavior

string · minLength: 1 · required

tiers_mode

string | null · minLength: 1 · required

transform_quantity

string | null · minLength: 1 · required

type

string · minLength: 1 · required

unit_amount

integer · required

unit_amount_decimal

string · minLength: 1 · required

SubscriptionItem

id

string · minLength: 1 · required

object

string · minLength: 1 · required

billing_thresholds

string | null · minLength: 1 · required

created

integer · required

current_period_end

integer · required

current_period_start

integer · required

discounts

(string | null)[] · required

metadata

object · required

Plan · required

Price · required

quantity

integer · required

subscription

string · minLength: 1 · required

tax_rates

(string | null)[] · required

ItemsList

object

string · minLength: 1 · required

SubscriptionItem[] · required

has_more

boolean · required

total_count

integer · required

url

string · minLength: 1 · required

PaymentSettings

payment_method_options

string | null · minLength: 1 · required

payment_method_types

string | null · minLength: 1 · required

save_default_payment_method

string · minLength: 1 · required

TrialEndBehavior

missing_payment_method

string · minLength: 1 · required

TrialSettings

TrialEndBehavior · required

SubscriptionResponse

id

string · minLength: 1 · required

object

string · minLength: 1 · required

application

string | null · minLength: 1 · required

application_fee_percent

string | null · minLength: 1 · required

AutomaticTax · required

billing_cycle_anchor

integer · required

billing_cycle_anchor_config

string | null · minLength: 1 · required

billing_thresholds

string | null · minLength: 1 · required

cancel_at

string | null · minLength: 1 · required

cancel_at_period_end

boolean · required

canceled_at

string | null · minLength: 1 · required

CancellationDetails · required

collection_method

string · minLength: 1 · required

created

integer · required

currency

string · minLength: 1 · required

customer

string · minLength: 1 · required

days_until_due

string | null · minLength: 1 · required

default_payment_method

string | null · minLength: 1 · required

default_source

string | null · minLength: 1 · required

default_tax_rates

(string | null)[] · required

description

string | null · minLength: 1 · required

discounts

(string | null)[] · required

ended_at

string | null · minLength: 1 · required

NewInvoiceSettings · required

ItemsList · required

latest_invoice

string · minLength: 1 · required

livemode

boolean · required

metadata

object · required

next_pending_invoice_item_invoice

string | null · minLength: 1 · required

on_behalf_of

string | null · minLength: 1 · required

pause_collection

string | null · minLength: 1 · required

PaymentSettings · required

pending_invoice_item_interval

string | null · minLength: 1 · required

pending_setup_intent

string | null · minLength: 1 · required

pending_update

string | null · minLength: 1 · required

Plan · required

quantity

integer · required

schedule

string | null · minLength: 1 · required

start_date

integer · required

status

string · minLength: 1 · required

test_clock

string | null · minLength: 1 · required

transfer_data

string | null · minLength: 1 · required

trial_end

string | null · minLength: 1 · required

TrialSettings · required

trial_start

string | null · minLength: 1 · required

KeycloakOnboarding

organization_name

string · minLength: 1 · required

organization_domain

string · minLength: 1 · required

stripe_customer_id

string · minLength: 1 · required

stripe_subscription_id

string · minLength: 1 · required

stripe_price_id

string · minLength: 1 · required

KeycloakUpdateOrg

organization_name

string · minLength: 1 · required

stripe_customer_id

string · minLength: 1 · required

stripe_subscription_id

string · minLength: 1 · required

stripe_price_id

string · minLength: 1 · required

organization_domain

string[]

enabled

boolean

UsersSerializerCreate

email

string · email · minLength: 1 · required

id

string · uuid

first_name

string · maxLength: 150

last_name

string · maxLength: 150

role

string · minLength: 1 · maxLength: 200

phone

string | null · minLength: 1 · maxLength: 15

enabled

boolean

organization

string | null · uuid · readOnly

OrganizationKombo

integration_id

string · minLength: 1 · maxLength: 200 · required

status

string · minLength: 1 · maxLength: 50 · required

organization

string · uuid · readOnly

auto_move_stages

boolean

updated_at

string · date-time · readOnly

last_synced

string | null · date-time

candidate_stage

string | null · maxLength: 200

passed_stage

string | null · maxLength: 200

rejected_stage

string | null · maxLength: 200

needs_reviewed_stage

string | null · maxLength: 200

OrganizationSerializerCreate

UsersSerializerCreate[] · required

name

string · minLength: 1 · maxLength: 200 · required

contact_email

string · email · minLength: 1 · maxLength: 200 · required

contact_phone

string · minLength: 1 · maxLength: 200 · required

id

string · uuid

UsersSerializerCreate[]

OrganizationKombo[]

address

string | null

is_active

boolean

contact_name

string · minLength: 1 · maxLength: 200

calendar_link

string · minLength: 1 · maxLength: 200

Users

email

string · email · minLength: 1 · required

id

string · uuid

first_name

string · maxLength: 150

last_name

string · maxLength: 150

role

string · minLength: 1 · maxLength: 200

phone

string | null · minLength: 1 · maxLength: 15

enabled

boolean

organization

string | null · uuid · readOnly

Organization

Users[] · required

name

string · minLength: 1 · maxLength: 200 · required

contact_email

string · email · minLength: 1 · maxLength: 200 · required

contact_phone

string · minLength: 1 · maxLength: 200 · required

id

string · uuid

Users[]

OrganizationKombo[]

address

string | null

is_active

boolean

contact_name

string · minLength: 1 · maxLength: 200

calendar_link

string · minLength: 1 · maxLength: 200

OrganizationIdName

name

string · minLength: 1 · maxLength: 200 · required

id

string · uuid

OrganizationListResponse

count

integer · required

next

integer · required

previous

integer · required

OrganizationIdName[] · required

SubscriptionReactivate

subscription_id

string · minLength: 1 · required

cancel_at_period_end

boolean

Default: false

SubscriptionID

subscription_id

string · minLength: 1 · required

CreatePortalSession

customer_id

string · minLength: 1 · required

return_url

string · uri · minLength: 1 · required

SubscriptionListResponse

object

string · minLength: 1 · required

SubscriptionResponse[] · required

has_more

boolean · required

url

string · minLength: 1 · required

IncrementMeter

customer_id

string · minLength: 1 · required

event_name

string · minLength: 1 · required

Payload

stripe_customer_id

string · minLength: 1 · required

value

string · minLength: 1 · required

MeterEvent

object

string · minLength: 1 · required

created

integer · required

event_name

string · minLength: 1 · required

identifier

string · minLength: 1 · required

livemode

boolean · required

Payload · required

timestamp

integer · required

Communication

id

string · uuid · readOnly

initial_email_sent

boolean

initial_text_sent

boolean

_3hr_reminder_text_sent

boolean

day2_email_sent

boolean

day2_text_sent

boolean

day3_email_sent

boolean

day3_text_sent

boolean

day4_email_sent

boolean

day4_text_sent

boolean

day5_email_sent

boolean

day5_text_sent

boolean

passed_notification_sent

boolean

rejected_notification_sent

boolean

Candidate

id

string · uuid

position_id

string · uuid

organization_id

string · uuid

name

string · minLength: 1

email

string · email · minLength: 1

phone

string · minLength: 1

language

string · minLength: 1

state

string · minLength: 1

score

integer

feedback

string · minLength: 1

hired

boolean

invited_at

string · date-time

Communication

completed_at

string · date-time

kombo_application_id

string · minLength: 1

short_listed

boolean

Default: false

tags

string[] · unique

created_at

string · date-time · readOnly

updated_at

string · date-time · readOnly

PostionSerializerList

name

string · minLength: 1 · maxLength: 200 · required

email

string · email · minLength: 1 · maxLength: 200 · required

phone

string · minLength: 1 · maxLength: 200 · required

language

string · minLength: 1 · maxLength: 200 · required

tags

string[] · unique

Communication

hired

boolean

kombo_application_id

string | null · minLength: 1 · maxLength: 100

short_listed

boolean | null

Interview

id

string · uuid

conversation_id

string | null · minLength: 1 · maxLength: 100

transcript_link

string | null · minLength: 1 · maxLength: 350

recording_link

string | null · minLength: 1 · maxLength: 350

start_time

string | null · date-time

end_time

string | null · date-time

graded_at

string | null · date-time

last_attempted_at

string | null · date-time

ip_address

string | null · minLength: 1

location

string | null · minLength: 1 · maxLength: 200

interview_link

string | null · minLength: 1 · maxLength: 200

status

string · enum

Enum values:

not_started

errored

cancelled

completed

graded

score

integer | null · min: -2147483648 · max: 2147483647

feedback

string | null · minLength: 1

interview_transcript

string | null · minLength: 1 · maxLength: 20000

candidate

string · uuid

CandidateAssessmentMapCreate

name

string | null · minLength: 1 · maxLength: 250

value

integer | null · min: -2147483648 · max: 2147483647

CandidateAssessmentDataCreate

CandidateAssessmentMapCreate[] · required

overall_score

integer | null · min: -2147483648 · max: 2147483647

skills_score

integer | null · min: -2147483648 · max: 2147483647

education_score

integer | null · min: -2147483648 · max: 2147483647

experience_score

integer | null · min: -2147483648 · max: 2147483647

InterviewSerializerCreate

CandidateAssessmentDataCreate · required

id

string · uuid

strenght

string[] · unique

weakness

string[] · unique

conversation_id

string | null · minLength: 1 · maxLength: 100

transcript_link

string | null · minLength: 1 · maxLength: 350

recording_link

string | null · minLength: 1 · maxLength: 350

start_time

string | null · date-time

end_time

string | null · date-time

graded_at

string | null · date-time

last_attempted_at

string | null · date-time

ip_address

string | null · minLength: 1

location

string | null · minLength: 1 · maxLength: 200

interview_link

string | null · minLength: 1 · maxLength: 200

status

string · enum

Enum values:

not_started

errored

cancelled

completed

graded

score

integer | null · min: -2147483648 · max: 2147483647

feedback

string | null · minLength: 1

interview_transcript

string | null · minLength: 1 · maxLength: 20000

candidate

string · uuid

CustomerInvoice

customer_id

string · minLength: 1 · required

subscription_id

string · minLength: 1 · required

Issuer

type

string · minLength: 1 · required

SubscriptionItemDetails

invoice_item

string | null · minLength: 1 · required

proration

boolean · required

object · required

subscription

string · minLength: 1 · required

subscription_item

string · minLength: 1 · required

LineItemParent

invoice_item_details

string | null · minLength: 1 · required

SubscriptionItemDetails · required

type

string · minLength: 1 · required

Period

start

integer · required

end

integer · required

PriceDetails

price

string · minLength: 1 · required

product

string · minLength: 1 · required

Pricing

PriceDetails · required

type

string · minLength: 1 · required

unit_amount_decimal

string · minLength: 1 · required

LineItem

id

string · minLength: 1 · required

object

string · minLength: 1 · required

amount

integer · required

currency

string · minLength: 1 · required

description

string · minLength: 1 · required

discount_amounts

(string | null)[] · required

discountable

boolean · required

discounts

(string | null)[] · required

invoice

string · minLength: 1 · required

livemode

boolean · required

metadata

object · required

LineItemParent · required

Period · required

pretax_credit_amounts

(string | null)[] · required

Pricing · required

quantity

integer · required

taxes

(string | null)[] · required

Lines

object

string · minLength: 1 · required

LineItem[] · required

has_more

boolean · required

total_count

integer · required

url

string · minLength: 1 · required

SubscriptionDetails

metadata

object · required

subscription

string · minLength: 1 · required

InvoiceParent

quote_details

string | null · minLength: 1 · required

SubscriptionDetails · required

type

string · minLength: 1 · required

NewPaymentSettings

default_mandate

string | null · minLength: 1 · required

payment_method_options

string | null · minLength: 1 · required

payment_method_types

string | null · minLength: 1 · required

StatusTransitions

finalized_at

string | null · minLength: 1 · required

marked_uncollectible_at

string | null · minLength: 1 · required

paid_at

string | null · minLength: 1 · required

voided_at

string | null · minLength: 1 · required

InvoiceResponse

id

string · minLength: 1 · required

object

string · minLength: 1 · required

account_country

string · minLength: 1 · required

account_name

string · minLength: 1 · required

account_tax_ids

string | null · minLength: 1 · required

amount_due

integer · required

amount_overpaid

integer · required

amount_paid

integer · required

amount_remaining

integer · required

amount_shipping

integer · required

application

string | null · minLength: 1 · required

attempt_count

integer · required

attempted

boolean · required

auto_advance

boolean · required

AutomaticTax · required

automatically_finalizes_at

string | null · minLength: 1 · required

billing_reason

string · minLength: 1 · required

collection_method

string · minLength: 1 · required

created

integer · required

currency

string · minLength: 1 · required

custom_fields

string | null · minLength: 1 · required

customer

string · minLength: 1 · required

customer_address

string | null · minLength: 1 · required

customer_email

string · email · minLength: 1 · required

customer_name

string · minLength: 1 · required

customer_phone

string | null · minLength: 1 · required

customer_shipping

string | null · minLength: 1 · required

customer_tax_exempt

string · minLength: 1 · required

customer_tax_ids

(string | null)[] · required

default_payment_method

string | null · minLength: 1 · required

default_source

string | null · minLength: 1 · required

default_tax_rates

(string | null)[] · required

description

string | null · minLength: 1 · required

discounts

(string | null)[] · required

due_date

string | null · minLength: 1 · required

effective_at

string | null · minLength: 1 · required

ending_balance

integer · required

footer

string | null · minLength: 1 · required

from_invoice

string | null · minLength: 1 · required

hosted_invoice_url

string | null · minLength: 1 · required

invoice_pdf

string | null · minLength: 1 · required

Issuer · required

last_finalization_error

string | null · minLength: 1 · required

latest_revision

string | null · minLength: 1 · required

Lines · required

livemode

boolean · required

metadata

object · required

next_payment_attempt

integer · required

number

string | null · minLength: 1 · required

on_behalf_of

string | null · minLength: 1 · required

InvoiceParent · required

NewPaymentSettings · required

period_end

integer · required

period_start

integer · required

post_payment_credit_notes_amount

integer · required

pre_payment_credit_notes_amount

integer · required

receipt_number

string | null · minLength: 1 · required

rendering

string | null · minLength: 1 · required

shipping_cost

string | null · minLength: 1 · required

shipping_details

string | null · minLength: 1 · required

starting_balance

integer · required

statement_descriptor

string | null · minLength: 1 · required

status

string · minLength: 1 · required

StatusTransitions · required

subtotal

integer · required

subtotal_excluding_tax

integer · required

test_clock

string | null · minLength: 1 · required

total

integer · required

total_discount_amounts

(string | null)[] · required

total_excluding_tax

integer · required

total_pretax_credit_amounts

(string | null)[] · required

total_taxes

(string | null)[] · required

webhooks_delivered_at

string | null · minLength: 1 · required

orgserial

Organization · required

UsersListResponse

Users[] · required

UpdateSubscription

subscription_id

string · minLength: 1 · required

new_price_id

string · minLength: 1 · required

UserMini

id

string · minLength: 1 · required

first_name

string · minLength: 1 · required

last_name

string · minLength: 1 · required

email

string · email · minLength: 1 · required

phone

string · minLength: 1 · required

enabled

boolean · required

role

string · minLength: 1

Position

name

string · minLength: 1 · maxLength: 100 · required

id

string · uuid

state

string · enum

Enum values:

active

draft

inactive

template

department

string | null · maxLength: 100

location

string | null · maxLength: 100

min_score

integer · min: -2147483648 · max: 2147483647

role_description

string | null · maxLength: 500

position_calender_link

string | null · maxLength: 500

created_at

string · date-time · readOnly

accepted_languages

string[]

Default: []

updated_at

string · date-time · readOnly

agent_id

string · minLength: 1 · maxLength: 255

Questionnaire[]

UserMini

candidate_stage

string | null · maxLength: 200

passed_stage

string | null · maxLength: 200

rejected_stage

string | null · maxLength: 200

needs_reviewed_stage

string | null · maxLength: 200

auto_update_stages

boolean

kombo_job_id_id

string | null · maxLength: 100

kombo_integration_id

string | null · maxLength: 100

DemoInterviewLink

demo_url

string · minLength: 1 · required

CustomEmailTemplate

template

string · minLength: 1 · required

choice

string · enum · required

Enum values:

invite

reminder

passed

SMS

candidates

string[] · required

text

string · enum

Enum values:

sms_1

sms_2

sms_3

sms_4

sms_5

sms_3hr

Default: sms_1

SendRegistration

organization_name

string · minLength: 1 · required

candidate_name

string · minLength: 1 · required

KeycloakEmailChange

username

string · minLength: 1 · required

old_email

string · minLength: 1 · required

new_email

string · minLength: 1 · required

KeycloakPasswordChange

username

string · minLength: 1 · required

new_password

string · minLength: 1 · required