# Get the profile

Source: https://workroad.app/docs/api/get-profile

`GET https://workroad.app/api/v1/settings/profile`

The user's name, username, bio and what their public profile shows.

- MCP tool: `getProfile` on `https://workroad.app/api/mcp`
- Required scopes: settings:view
- Test mode: `GET https://workroad.app/api/test/v1/settings/profile` checks the request and returns the example response without changing anything.

## Response

`200` OK

- `data`: object, required
  - `name`: string, required. The display name.
  - `username`: string, required. Lower case letters, digits, `_` and `.`. The public profile lives at `/{username}`.
  - `description`: string, required. The profile bio.
  - `status`: string, required. A short status line shown on the profile.
  - `location`: string or null, required. Free text, or null.
  - `showLastLogin`: boolean, required. The profile shows when they were last on.
  - `showCreated`: boolean, required. The profile shows when they joined.
  - `showTimezone`: boolean, required. The profile shows their time zone.
  - `showMembership`: boolean, required. The profile shows their plan.

### Example

```json
{
  "data": {
    "name": "Ada Lovelace",
    "username": "ada",
    "description": "Maths and computing, mostly.",
    "status": "Revising for finals",
    "location": "London",
    "showLastLogin": true,
    "showCreated": true,
    "showTimezone": false,
    "showMembership": true
  }
}
```

## Errors

Every error has the body `{ "error": { "code", "message", "details" } }`.

- `400`: Invalid request body or query
- `401`: Missing, invalid, disabled or expired API key
- `403`: The API key lacks the required scope
- `404`: No endpoint exists at this path.
- `405`: Method not allowed. Use a method from the Allow header.
- `429`: Rate limit exceeded. Wait for Retry-After before retrying. The rate-limit headers are absent when the key's own limiter rejected the request before the per-endpoint bucket check ran.
- `500`: Internal server error