Every public route includes what it does, what to send, and what comes back. Docs use the live base URL `https://mypostshare.com/api` so customer teams can move faster in production.
Documentation surface
Overview
Customer companies create apps in your dashboard, configure provider credentials or managed credentials, and issue API keys. Their backend then uses your public API to create end users, start hosted OAuth flows, inspect connections, publish posts, and schedule future delivery.
Dashboard setup
Apps, keys, redirect allowlists, provider credentials, and operator logs.
Hosted OAuth
Connect users through your flow and redirect back safely with non-secret fields only.
Publishing API
Immediate and scheduled posting backed by request-level and delivery-level statuses.
Quickstart
Create an app in the dashboard and issue an API key.
Choose whether the app uses customer-owned credentials or your managed provider credentials.
Register the generated fixed provider callback URL in the provider developer console when using customer-owned credentials.
Allowlist every customer redirect URL that should receive the final OAuth callback.
Create or upsert an end user with `/v1/end-users`.
Create a hosted connect session and send the user to the returned `connectUrl`.
Poll connection and post request status from the customer product as needed.
Endpoint Reference
Create or upsert end user
/v1/end-usersCreates a tenant-scoped end user or updates the existing record for the same external user ID.
Use this route before creating connect sessions or publishing posts so the platform has a stable customer user mapping.
Authentication
Bearer API key required
Send `Bearer YOUR_API_KEY` for the current customer app.
Unique user ID from the customer product.
Human-readable label shown in dashboard inventory.
Optional email for operator visibility.
Free-form customer metadata stored with the end user.
/v1/end-userscurl -X POST "https://mypostshare.com/api/v1/end-users" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"externalUserId": "user_123",
"displayName": "Alex Morgan",
"email": "alex@example.com",
"metadata": { "plan": "pro", "source": "web-app" }
}'{
"id": "4ea64e37-6c19-43a0-8ef5-1a7e7e2b0b89",
"externalUserId": "user_123",
"displayName": "Alex Morgan",
"email": "alex@example.com",
"metadata": { "plan": "pro", "source": "web-app" },
"createdAt": "2026-03-21T08:00:00.000Z",
"updatedAt": "2026-03-21T08:00:00.000Z"
}Get end user
/v1/end-users/:externalUserIdReturns the stored end user profile and a high-level connection summary.
Use this route when the customer product needs to know whether a user has already been onboarded in the current app.
Authentication
Bearer API key required
Customer-defined end user identifier.
Send `Bearer YOUR_API_KEY`.
/v1/end-users/:externalUserIdcurl -X GET "https://mypostshare.com/api/v1/end-users/user_123" \ -H "Authorization: Bearer YOUR_API_KEY"
{
"id": "4ea64e37-6c19-43a0-8ef5-1a7e7e2b0b89",
"externalUserId": "user_123",
"displayName": "Alex Morgan",
"email": "alex@example.com",
"connectionSummary": { "total": 2, "connected": 1, "failed": 0 }
}List end user connections
/v1/end-users/:externalUserId/connectionsLists connected social accounts for the end user, including platform and account metadata.
Use this route to show connection status in the customer app or to confirm a platform is ready before publishing.
Authentication
Bearer API key required
Customer-defined end user identifier.
Send `Bearer YOUR_API_KEY`.
/v1/end-users/:externalUserId/connectionscurl -X GET "https://mypostshare.com/api/v1/end-users/user_123/connections" \ -H "Authorization: Bearer YOUR_API_KEY"
[
{
"id": "7c7f00f5-3412-4546-8cb7-3f095b16fe49",
"platform": "linkedin",
"status": "connected",
"remoteAccountId": "H8a9UFibz4",
"remoteUsername": "ALEX_MORGAN",
"accountType": "person"
}
]Disconnect a platform
/v1/end-users/:externalUserId/connections/:platformRemoves a linked social connection for a specific end user and platform.
Use this when a customer wants to revoke the local platform linkage or force a reconnect for a specific provider.
Authentication
Bearer API key required
Customer-defined end user identifier.
Provider key. Supported values: `linkedin`, `facebook`, `instagram`, `twitter`, `youtube`.
Send `Bearer YOUR_API_KEY`.
/v1/end-users/:externalUserId/connections/:platformcurl -X DELETE "https://mypostshare.com/api/v1/end-users/user_123/connections/linkedin" \ -H "Authorization: Bearer YOUR_API_KEY"
{}Create connect session
/v1/connect-sessionsCreates a hosted OAuth session and returns the `connectUrl` the customer frontend should open.
This is the main entry point for hosted account linking. The platform binds provider callback state to this session and safely redirects back later.
Authentication
Bearer API key required
Send `Bearer YOUR_API_KEY`.
End user identifier already created for the current app.
Provider to connect. Supported values: `linkedin`, `facebook`, `instagram`, `twitter`, `youtube`.
Customer redirect URL that must already be allowlisted.
Optional metadata used to personalize the hosted connect screen.
/v1/connect-sessionscurl -X POST "https://mypostshare.com/api/v1/connect-sessions" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"externalUserId": "user_123",
"platform": "linkedin",
"redirectUri": "https://client.example.com/oauth/callback"
}'{
"id": "9469c610-999a-4cb0-9807-a7037947d6b5",
"status": "pending",
"platform": "linkedin",
"connectUrl": "https://mypostshare.com/connect/9469c610-999a-4cb0-9807-a7037947d6b5"
}Get connect session status
/v1/connect-sessions/:idReturns the latest status for a hosted OAuth session.
Use this route to poll for completion after redirecting the end user to the hosted connect flow.
Authentication
Bearer API key required
Connect session ID returned from `POST /v1/connect-sessions`.
Send `Bearer YOUR_API_KEY`.
/v1/connect-sessions/:idcurl -X GET "https://mypostshare.com/api/v1/connect-sessions/9469c610-999a-4cb0-9807-a7037947d6b5" \ -H "Authorization: Bearer YOUR_API_KEY"
{
"id": "9469c610-999a-4cb0-9807-a7037947d6b5",
"status": "connected",
"platform": "linkedin",
"externalUserId": "user_123",
"errorCode": null,
"updatedAt": "2026-03-21T06:58:48.753Z"
}Publish immediately
/v1/postsCreates a direct publish request and attempts delivery right away.
Use this route when the customer app wants an immediate publish action against one or more connected platforms.
Authentication
Bearer API key required
Send `Bearer YOUR_API_KEY`.
Connected end user to publish on behalf of.
Optional title or headline used by supported providers.
Main post content.
List of provider keys to deliver to. Supported values: `linkedin`, `facebook`, `instagram`, `twitter`, `youtube`.
Optional media URL for supported providers.
Optional thumbnail asset URL.
Optional customer metadata attached to the request.
/v1/postscurl -X POST "https://mypostshare.com/api/v1/posts" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"externalUserId": "user_123",
"title": "Launch update",
"content": "Testing mypostshare direct posting from docs.",
"platforms": ["linkedin"],
"metadata": { "source": "api-docs" }
}'{
"id": "e3143cd2-fb9e-42cf-aa45-f7e711d4823d",
"mode": "immediate",
"status": "published",
"externalUserId": "user_123",
"platformResults": [
{ "platform": "linkedin", "status": "published", "externalId": "urn:li:share:7441018768555757568" }
]
}Schedule a post
/v1/posts/scheduledCreates a scheduled publish request for a future time.
Use this route when the customer app wants the platform worker to execute publishing later.
Authentication
Bearer API key required
Send `Bearer YOUR_API_KEY`.
Connected end user to schedule a post for.
Main post content.
Providers that should receive the scheduled post. Supported values: `linkedin`, `facebook`, `instagram`, `twitter`, `youtube`.
Future ISO 8601 UTC timestamp when the job should run.
Optional customer metadata attached to the request.
/v1/posts/scheduledcurl -X POST "https://mypostshare.com/api/v1/posts/scheduled" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"externalUserId": "user_123",
"content": "Scheduled via mypostshare docs page.",
"platforms": ["linkedin", "twitter"],
"scheduleAt": "2026-03-22T09:30:00.000Z",
"metadata": { "campaign": "launch-week" }
}'{
"id": "40bb5e88-4868-4336-af0c-f18dd7a5eb45",
"mode": "scheduled",
"status": "scheduled",
"externalUserId": "user_123",
"scheduleAt": "2026-03-22T09:30:00.000Z",
"platformResults": []
}Get post request
/v1/posts/:idReturns a single publish or schedule request with per-platform delivery results.
Use this route to poll a specific request after creating an immediate or scheduled post.
Authentication
Bearer API key required
Post request ID returned from a publish or schedule call.
Send `Bearer YOUR_API_KEY`.
/v1/posts/:idcurl -X GET "https://mypostshare.com/api/v1/posts/e3143cd2-fb9e-42cf-aa45-f7e711d4823d" \ -H "Authorization: Bearer YOUR_API_KEY"
{
"id": "e3143cd2-fb9e-42cf-aa45-f7e711d4823d",
"mode": "immediate",
"status": "published",
"externalUserId": "user_123",
"platformResults": [
{ "platform": "linkedin", "status": "published", "externalId": "urn:li:share:7441018768555757568" }
]
}List post requests
/v1/postsReturns publish and schedule requests for the current app, optionally filtered by user or status.
Use this route for dashboard views, support tools, and recent activity feeds.
Authentication
Bearer API key required
Send `Bearer YOUR_API_KEY`.
Optional end user filter.
Optional lifecycle filter such as `scheduled` or `published`.
Optional provider filter.
Optional ISO 8601 start date filter.
Optional ISO 8601 end date filter.
/v1/postscurl -X GET "https://mypostshare.com/api/v1/posts?externalUserId=user_123&status=published" \ -H "Authorization: Bearer YOUR_API_KEY"
[
{ "id": "e3143cd2-fb9e-42cf-aa45-f7e711d4823d", "mode": "immediate", "status": "published", "externalUserId": "user_123" },
{ "id": "40bb5e88-4868-4336-af0c-f18dd7a5eb45", "mode": "scheduled", "status": "scheduled", "externalUserId": "user_123" }
]Provider Notes
Each platform now uses a fixed callback URL, while connect-session state safely restores the app and redirect destination.
Customer apps can use either their own provider credentials or your managed credentials for faster onboarding.
Redirect URIs must be allowlisted in the dashboard before a connect session can use them.
Hosted OAuth redirects back with safe fields only, never with provider tokens or secrets.
Publishing results return request-level and platform-level status for support and auditing.