API reference
List a project's profiles, oldest first, with page-based pagination and a name filter.
https://api.betterpost.dev/v1/profiles| Name | Type | Default | Description |
|---|---|---|---|
page | integer | 1 | Page number, from 1. |
limit | integer | 50 | Profiles per page, 1 to 100. |
name | string | Case-insensitive substring match on the name. |
curl -s "https://api.betterpost.dev/v1/profiles?page=1&limit=50" \
-H "x-access-key: $BETTERPOST_API_KEY"200 OK
{
"success": true,
"total": 1,
"page": 1,
"limit": 50,
"profiles": [
{
"id": "prof_1b7r4a9n2d5c8l0e3k6s9m2x",
"name": "Acme Coffee",
"description": "Brand accounts for Acme",
"integrationCount": 2,
"createdAt": "2026-10-21T14:03:12.418Z",
"updatedAt": "2026-10-21T14:03:12.418Z"
}
]
}total counts all matching profiles. integrationCount is the number of connected accounts in each profile.
| Status | Code | When |
|---|---|---|
200 | Success. | |
400 | validation_error | page or limit is out of range. |
401 | unauthorized | Missing or unknown API key. |
429 | rate_limited | More than 120 requests per minute. |