GET /profile. Retrieve your public profile and services

The /profile endpoint returns everything that makes up your public Tikk presence: your handle, display name, bio, branding assets, and the full list of services you have published. Integrations commonly read this endpoint once at startup to grab the username needed for the embed script and the profile_url to link visitors directly to your booking page.

Endpoint

GET https://app.tikk.chat/api/v1/profile

Required scope: profile.read

Example request

curl https://app.tikk.chat/api/v1/profile \
  -H "Authorization: Bearer {YOUR_API_KEY}"

Request parameters

This endpoint accepts no query parameters.

Response schema

string | null

Your Tikk handle. Use this as the data-domain value in the embed script. null until you claim a username.

string | null

Your display name, shown at the top of your booking page.

string | null

Your job title, displayed beneath your name on the booking page.

string | null

Short bio visible to anyone who opens your booking page.

string | null

Fully-qualified URI of your profile photo.

string | null

Fully-qualified URI of your brand logo. null if you have not uploaded one.

string | null

Direct link to your public booking page (e.g. https://tikk.chat/joeri). null until you pick a username.

boolean

Whether your profile is ready to receive bookings. false while no username has been claimed.

array

All active services published on your profile.

Show ProfileService

string

URL-safe identifier for the service. Pass this as the service query parameter on /availability.

string

Human-readable service name shown on the booking page.

string | null

Fully-qualified booking URL for this service (e.g. https://tikk.chat/joeri/discovery-call). null until you pick a username.

Example response

{
  "username": "joeri",
  "name": "Joeri Verstraete",
  "title": "Founder",
  "bio": "I help teams ship faster.",
  "avatar_url": "https://app.tikk.chat/avatars/joeri.jpg",
  "logo_url": null,
  "profile_url": "https://tikk.chat/joeri",
  "profile_complete": true,
  "services": [
    {
      "slug": "discovery-call",
      "title": "Discovery call",
      "embed_url": "https://tikk.chat/joeri/discovery-call"
    },
    {
      "slug": "strategy-session",
      "title": "Strategy session",
      "embed_url": "https://tikk.chat/joeri/strategy-session"
    }
  ]
}

Use the username field as the data-domain attribute in the Tikk embed script to surface your booking page inline on any website. See the embed guide for the full setup instructions.

profile_complete is false and both profile_url and all embed_url values are null until you claim a username in your Tikk account settings. Bookings cannot be received while profile_complete is false.

Errors

Status	Meaning
`401`	Missing or invalid API key.
`403`	Your API key does not have the `profile.read` scope.
`429`	Rate limit exceeded. Back off and retry after the period indicated in the `Retry-After` header.

Overview

Endpoints

GET /profile. Retrieve your public profile and services

Endpoint

Example request

Request parameters

Response schema

Example response

Errors

​Endpoint

​Example request

​Request parameters

​Response schema

​Example response

​Errors

Endpoint

Example request

Request parameters

Response schema

Example response

Errors