LxBlog
/Docs

Api Reference

Blog Metadata

The Status endpoint returns information about the current OAuth connection and the connected blog. Use it to verify that your integration is active, inspect blog details, and monitor sync activity.

Get Connection Status

GET/api/v1/status

Returns the current connection status, blog metadata, granted scopes, and sync activity timestamps.

This endpoint accepts any valid OAuth scope. As long as the access token is valid, you can call this endpoint regardless of which scopes were granted.

Example Request

Status request
curl https://lxblog.app/api/v1/status \
  -H "Authorization: Bearer lxb_at_your_access_token"

Response

200 OK
{
  "status": "active",
  "blog": {
    "id": "cm5blog123abc456def",
    "name": "My Engineering Blog",
    "slug": "my-engineering-blog",
    "description": "Thoughts on software engineering, architecture, and developer tooling.",
    "language": "en",
    "articleCount": 42
  },
  "scopes": ["articles:read", "blog:read"],
  "connectedAt": "2026-01-10T08:00:00.000Z",
  "lastSyncAt": "2026-02-22T14:30:00.000Z"
}

Response Fields

NameTypeDescription
statusstringConnection status. Currently always "active" for valid tokens.
blog.idstringUnique CUID identifier for the connected blog.
blog.namestringDisplay name of the blog.
blog.slugstringURL-friendly slug for the blog.
blog.descriptionstringBlog description or tagline.
blog.languagestringPrimary language of the blog as an ISO 639-1 code (e.g. "en", "pt", "es", "fr", "de"). All articles from the blog are written in this language.
blog.articleCountnumberTotal number of published articles in the blog.
scopesstring[]List of OAuth scopes granted to this access token.
connectedAtstringISO 8601 timestamp of when the OAuth connection was established.
lastSyncAtstring | nullISO 8601 timestamp of the last sync API call, or null if never synced.

Use Cases

  • Verify connection is active — Check the status field to confirm the OAuth connection is still valid before making other API calls.
  • Display blog information — Use the blog object to show the connected blog's name, description, and article count in your application's UI.
  • Monitor sync activity — The lastSyncAt timestamp lets you track when your application last synced with the blog, useful for alerting if syncs stop running.
  • Check granted scopes — The scopes array shows which permissions were granted, so your application can conditionally enable features based on available scopes.

Blog Language & Content Format

The blog.language field tells you what language the blog's articles are written in. This is an ISO 639-1 code. Common values:

  • en — English
  • pt — Portuguese
  • es — Spanish
  • fr — French
  • de — German

All article content is delivered in Markdown format. You need a Markdown renderer to display articles as HTML. See the Articles API reference for rendering examples and the complete field reference.

Call the status endpoint on application startup or at regular intervals to ensure the connection is healthy. If the token is expired, you will receive a 401 Unauthorized response, indicating you need to refresh the access token.