profiles
List profiles
Returns profiles sorted default-first, then by creation date. Filter with name (exact match) and paginate with limit/skip; without those params the full list is returned unchanged. Use includeOverLimit=true to include profiles that exceed the plan limit.
AuthorizationBearer <token>
API key authentication - use your Zernio API key as a Bearer token
In: header
Query Parameters
includeOverLimit?boolean
When true, includes over-limit profiles (marked with isOverLimit: true).
Default
falsename?string
Exact-match filter on the profile name. Useful to recover a profile id after an ambiguous create (timeout followed by a 409 on retry).
limit?integer
Page size. When limit or skip is present, the response includes total and skip (and echoes limit).
Range
1 <= value <= 1000skip?integer
Number of profiles to skip, applied after sorting and filtering.
Range
0 <= valueResponse Body
application/json
application/json
application/json
import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.profiles.listProfiles();console.log(data);{
"profiles": [
{
"_id": "64f0...",
"name": "Personal Brand",
"color": "#ffeda0",
"isDefault": true
}
]
}{
"error": "string",
"type": "invalid_request_error",
"code": "string",
"param": "string",
"platform": "string",
"platformError": {},
"details": {}
}{
"error": "Unauthorized"
}