Skip to main content
GET
Get your profile
Use username as the data-domain attribute of the Tikk embed script to show your booking page on any website. See the embed guide.

Authorizations

Authorization
string
header
required

An API key from Settings → API Keys (starts with tikk_sk_), or an OAuth access token for a partner app. Both carry scopes; each endpoint lists the one it needs.

Scopes

profile.read

Response

Your profile.

username
string | null
required

Your Tikk handle, and the data-domain value for the embed script. null until you pick one.

Example:

"jane"

name
string | null
required

Display name, shown at the top of your booking page.

Example:

"Jane Doe"

title
string | null
required

Job title, shown beneath your name.

Example:

"Coach"

bio
string | null
required
Example:

"I help founders find focus."

avatar_url
string<uri> | null
required

Profile photo.

logo_url
string<uri> | null
required

Brand logo. null if you haven't uploaded one.

profile_url
string<uri> | null
required

Your public booking page. null until you pick a username.

Example:

"https://tikk.chat/jane"

profile_complete
boolean
required

false until you pick a username. Bookings can't come in until then.

Example:

true

plan
enum<string>
required

Your plan. Use it to hide or badge Pro features, like custom slugs or group services, up front.

Available options:
free,
pro
Example:

"pro"