Get a profile
Get a profile.
GET
/v1/profiles/{id}Request
| Method and path | GET/v1/profiles/{id} |
|---|---|
| Base URL | https://api.boxline.dev |
| Authentication | Your API key in the x-api-key header (or Authorization: Bearer). The examples read it from BOXLINE_API_KEY. |
Path parameters
| Name | Type | Default | Allowed values | Description |
|---|---|---|---|---|
idrequired | string | – | – |
curl "https://api.boxline.dev/v1/profiles/$PROFILE_ID" \ -H "x-api-key: $BOXLINE_API_KEY"import { Boxline } from "@boxline/sdk";const bx = new Boxline(); // reads BOXLINE_API_KEY and BOXLINE_API_URLconst profile = await bx.profiles.get("PROFILE_ID");console.log(profile.name, profile.inUseBy, profile.credential);from boxline import Boxlinebx = Boxline() # reads BOXLINE_API_KEY and BOXLINE_API_URLprofile = bx.profiles.get("PROFILE_ID")print(profile["name"], profile["inUseBy"], profile["credential"])Responses
200 OK
The profile.
Fields
| Name | Type | Default | Allowed values | Description |
|---|---|---|---|---|
id | string | – | – | |
name | string | – | – | |
sizeBytes | integer | – | – | |
createdAt | string | – | – | Format: date-time. |
updatedAt | string | – | – | Format: date-time. |
inUseBy | string | null | – | – | The running session using it. |
credential | string | null | – | – | The password credential it signs in with (PATCH /v1/profiles/:id {credential}); null without one. |
{ "id": "prof_Hk3VxP9mQ2sLw7Tn", "name": "Work account", "sizeBytes": 0, "createdAt": "2026-09-29T10:00:00.000Z", "updatedAt": "2026-09-29T10:00:00.000Z", "inUseBy": "…", "credential": "SHOP"}Errors
Errors have a matching HTTP status and the same body. code is stable, so check it in your code; message is for people. See Errors and request ids.
| Status | Codes | When |
|---|---|---|
| 401 Unauthorized | unauthorized | Missing or invalid API key. |
| 404 Not Found | not_found, invite_not_found, provider_unavailable | No such thing in this project (or organization), or no such route. |
{ "error": { "code": "not_found", "message": "session not found", "requestId": "req_4fJx0aQm2Lk9Pz7N" }}Learn more
These docs describe a beta API. Endpoints, fields and SDK methods may change before general availability; breaking changes will be listed in the changelog.