/api/v1/profiles

Overview

Fetch all connected social profiles for a user along with key identity details. Use this endpoint to discover valid profileIds for posting.

Authentication

Include the following headers:

x-api-key: Your API key (found in Profile > Settings)
user-id: Your user ID (found in Profile > Settings)

Request

Method: `GET`

URL

https://postfaster.io/api/v1/profiles

Headers


{
  "x-api-key": "your-api-key",
  "user-id": "your-user-id"
}

Response

Success


{
  "profiles": [
    {
      "id": "sp_12345_fb",
      "platform": "facebook",
      "profileId": "1234567890",
      "profileType": "page",
      "name": "Acme Inc",
      "username": "acmeinc",
      "pictureUrl": "https://.../avatar.jpg",
      "canPost": true,
      "createdAt": "2025-11-01T10:15:20.000Z",
      "updatedAt": "2025-11-10T08:00:00.000Z",
      "identity": {
        "id": "si_123",
        "platform": "facebook",
        "openId": "open_123",
        "displayName": "John Doe",
        "avatarUrl": "https://.../john.jpg",
        "authType": "OAuth",
        "createdAt": "2025-10-01T12:00:00.000Z",
        "updatedAt": "2025-11-01T12:00:00.000Z"
      }
    }
  ]
}

Errors

Missing API Key


{ "error": "No api key found" }

Missing User ID


{ "error": "No user ID found" }

Invalid User ID


{ "error": "Invalid user ID" }

Notes

Use the returned profiles[].id as profileIds in the /api/v1/post endpoint.
Profiles are scoped to the authenticated user.