List profiles
List profiles.
GET
/v1/profilesRequest
| Method and path | GET/v1/profiles |
|---|---|
| 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. |
Query parameters
| Name | Type | Default | Allowed values | Description |
|---|---|---|---|---|
limit | integer | 50 | – | From 1 to 200. |
after | string | – | – | The next value of the previous page (same filters and sort). Opaque; do not build it yourself. |
curl "https://api.boxline.dev/v1/profiles?limit=50" \ -H "x-api-key: $BOXLINE_API_KEY"import { Boxline } from "@boxline/sdk";const bx = new Boxline(); // reads BOXLINE_API_KEY and BOXLINE_API_URLconst page = await bx.profiles.list({ limit: 50 });console.log(page.total, page.data.map((p) => p.name));from boxline import Boxlinebx = Boxline() # reads BOXLINE_API_KEY and BOXLINE_API_URLpage = bx.profiles.list(limit=50)print(page.total, [p["name"] for p in page.data])Responses
200 OK
A page of profiles, newest first.
Fields
| Name | Type | Default | Allowed values | Description |
|---|---|---|---|---|
data | object[] | – | – | |
data[].id | string | – | – | |
data[].name | string | – | – | |
data[].sizeBytes | integer | – | – | |
data[].createdAt | string | – | – | Format: date-time. |
data[].updatedAt | string | – | – | Format: date-time. |
data[].inUseBy | string | null | – | – | The running session using it. |
data[].credential | string | null | – | – | The password credential it signs in with (PATCH /v1/profiles/:id {credential}); null without one. |
total | integer | – | – | |
next | string | null | – | – | Pass it back as after for the next page; null on the last page. |
{ "data": [ { "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" } ], "total": 0, "next": "eyJvIjoiY3JlYXRlZF9kZXNjIiwidCI6IjIwMjYtMDktMjlUMTA6MDA6MDAuMTIzNDU2WiIsImkiOiI2YzFmIn0"}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 |
|---|---|---|
| 400 Bad Request | invalid_request, invalid_json, invalid_cursor, invalid_idempotency_key, invalid_extension, variables_with_extensions, terms_not_accepted, invalid_reset_token, invalid_confirmation_code, wrong_password, no_password, invalid_next, invalid_oauth_token | The request is not valid. |
| 401 Unauthorized | unauthorized | Missing or invalid API key. |
{ "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.