Skip to main content
Profiles

List

List all active profiles for your project, paginated and ordered newest-first.

Endpoint

GET https://api.postpeer.dev/v1/profiles

Query Parameters

ParameterTypeRequiredDescription
pageintegerNoPage number (1-indexed). Defaults to 1.
limitintegerNoPage size, between 1 and 100. Defaults to 50.

Example

curl "https://api.postpeer.dev/v1/profiles?page=1&limit=20" \
  -H "x-access-key: YOUR_API_KEY"

Response

{
  "success": true,
  "total": 2,
  "page": 1,
  "limit": 20,
  "profiles": [
    {
      "id": "65ab...",
      "name": "Acme Co",
      "description": "Marketing accounts",
      "integrationCount": 3,
      "createdAt": "2026-05-03T08:33:36.445Z",
      "updatedAt": "2026-05-03T08:33:36.445Z"
    },
    {
      "id": "65ac...",
      "name": "Personal",
      "description": null,
      "integrationCount": 1,
      "createdAt": "2026-05-02T17:11:02.000Z",
      "updatedAt": "2026-05-02T17:11:02.000Z"
    }
  ]
}

integrationCount is computed from currently active (non-deleted) integrations bound to each profile.

Status Codes

CodeMeaning
200Success

Create

Create a profile to group one or more social integrations.

Get

Retrieve a single profile, including the count of active integrations bound to it.

On this page

Endpoint
Query Parameters
Example
Response
Status Codes