Zernio
Zernio
API Reference

Profiles

List profilesGETCreate profilePOSTGet profileGETUpdate profilePUTDelete profileDELETE
Dashboard
llms.txtOpenAPI
OverviewPlatformsAPI ReferenceResources
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.

GET
/v1/profiles

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

In: header

Query Parameters

includeOverLimit?boolean

When true, includes over-limit profiles (marked with isOverLimit: true).

Defaultfalse
name?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).

Range1 <= value <= 1000
skip?integer

Number of profiles to skip, applied after sorting and filtering.

Range0 <= value

Response Body

application/json

application/json

application/json

{  "profiles": [    {      "_id": "64f0...",      "name": "Personal Brand",      "color": "#ffeda0",      "isDefault": true    }  ]}
Was this page helpful?

Overview

Every Zernio endpoint, grouped by resource. Pick a resource to see its operations.

Create profile

Creates a new profile with a name, optional description, and color. Names are unique per team: a duplicate returns a 409 whose details.existingProfileId carries the id of the existing profile. Send an Idempotency-Key header to make retries safe: a retried create with the same key and body replays the original 201 (same _id) instead of conflicting.