---
title: "The traveller profile"
method: GET
path: "/api/profile"
tags: ["Profile"]
---

# The traveller profile

`GET /api/profile`

## Request

- Base URL: `https://trvlrr.app`
- URL: `https://trvlrr.app/api/profile`
- Auth: HTTP bearer

What the planner knows about how this person travels, with their homes.

## Response `200`

The profile.

- Profile
  - `display_name` string, nullable: Name.
  - `home_city` string, nullable: Home city.
  - `date_of_birth` string, nullable: YYYY-MM-DD.
  - `travels_with` string, nullable: Who they usually travel with.
  - `interests` string, nullable: Interests.
  - `pace` string, nullable: Pace, e.g. relaxed.
  - `budget` string, nullable: Budget.
  - `dietary` string, nullable: Dietary needs.
  - `avoid` string, nullable: Things to avoid.
  - `about` string, nullable: Anything else.
  - `updated_at` string
  - `homes` Home[], required
    - `id` string, required
    - `city` string, required
    - `country` string, nullable, required: ISO alpha-2.
    - `hometown` string, nullable, required
    - `gateway` string, nullable, required: The city they usually fly from.
    - `from_date` string, nullable, required: YYYY or YYYY-MM-DD.
    - `to_date` string, nullable, required: YYYY or YYYY-MM-DD; null for the current home.
    - `created_at` string, required

## Other responses

- `401`: No usable credential: a Clerk session token, a device token or an OAuth access token is required.
- `403`: The caller may not do this to this account or trip.

---

[API](https://skmtc.dev/trvlrr/apis/trvlrr-api.md) · [All operations](https://skmtc.dev/trvlrr/apis/trvlrr-api/llms.txt) · [OpenAPI document](https://skmtc.dev/trvlrr/apis/trvlrr-api/revisions/ea024946b293?raw)