Skip to main content
Profiles

Get

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

Endpoint

GET https://api.postpeer.dev/v1/profiles/{id}

Path Parameters

ParameterTypeDescription
idstringProfile ID

Example

curl "https://api.postpeer.dev/v1/profiles/65ab123" \
  -H "x-access-key: YOUR_API_KEY"
import PostPeer from '@postpeer/node';

const client = new PostPeer();
const { data } = await client.profiles.get({
	path: { id: '65ab123' },
});
from postpeer import PostPeer

with PostPeer() as client:
    profile = client.profiles.get(id="65ab123")

Response

{
	"success": true,
	"profile": {
		"id": "65ab...",
		"name": "Acme Co",
		"description": "Marketing accounts",
		"integrationCount": 3,
		"createdAt": "2026-05-03T08:33:36.445Z",
		"updatedAt": "2026-05-03T08:33:36.445Z"
	}
}

Status Codes

CodeMeaning
200Success
400Invalid profile id
404Profile not found

On this page