Build with Micro.blog logo
Build with Micro.blog
API Documentation

Users and Relationships

View .md

Endpoints for user search, following, relationship checks, discovery suggestions, and user logs.

BASE URL https://micro.blog
POST /users/follow

Follows a Micro.blog user or feed URL.

Example Request

curl -X POST "https://micro.blog/users/follow" \
  --header "Authorization: Bearer EF7BB9BCAC1F6D561C93"

Query Parameters

Name Type Required Description
username string Optional Micro.blog username.
Example: vincent
feed_url string Optional Feed URL.
Example: https://example.com/feed.json

Header Parameters

Name Type Required Description
Authorization string Required Bearer token for authentication. Format: Bearer {token}.

Response

200 OK application/json

Returns an empty JSON object on success.

Example Response

{}
GET /users/is_following

Checks whether the authenticated user follows another user.

Example Request

curl -X GET "https://micro.blog/users/is_following?username=vincent" \
  --header "Authorization: Bearer EF7BB9BCAC1F6D561C93"

Query Parameters

Name Type Required Description
username string Required Micro.blog username.
Example: vincent

Header Parameters

Name Type Required Description
Authorization string Required Bearer token for authentication. Format: Bearer {token}.

Response

200 OK application/json

Returns a JSON response.

Example Response

{
  "is_following": true,
  "is_you": false
}
GET /users/discover/{username}

Returns suggested users based on a user’s follows.

Example Request

curl -X GET "https://micro.blog/users/discover/{username}" \
  --header "Authorization: Bearer EF7BB9BCAC1F6D561C93"

Header Parameters

Name Type Required Description
Authorization string Required Bearer token for authentication. Format: Bearer {token}.

Path Parameters

Name Type Required Description
username string Required Micro.blog username.
Example: vincent

Response

200 OK application/json

Returns an array of suggested users.

Example Response

[
  {
    "name": "Vincent",
    "url": "https://vincent.micro.blog/",
    "avatar": "https://avatars.micro.blog/avatars/2026/123.jpg",
    "username": "vincent",
    "is_following": true,
    "is_you": false
  }
]
GET /users/following/{username}

Returns users followed by the given username.

Example Request

curl -X GET "https://micro.blog/users/following/{username}" \
  --header "Authorization: Bearer EF7BB9BCAC1F6D561C93"

Header Parameters

Name Type Required Description
Authorization string Required Bearer token for authentication. Format: Bearer {token}.

Path Parameters

Name Type Required Description
username string Required Micro.blog username.
Example: vincent

Response

200 OK application/json

Returns an array of followed users.

Example Response

[
  {
    "name": "Vincent",
    "url": "https://vincent.micro.blog/",
    "avatar": "https://avatars.micro.blog/avatars/2026/123.jpg",
    "username": "vincent",
    "is_following": true,
    "is_you": false
  }
]
GET /users/search

Searches Micro.blog users.

Example Request

curl -X GET "https://micro.blog/users/search?q=Vincent" \
  --header "Authorization: Bearer EF7BB9BCAC1F6D561C93"

Query Parameters

Name Type Required Description
q string Required Search query or Micropub query type.
Example: Vincent

Header Parameters

Name Type Required Description
Authorization string Required Bearer token for authentication. Format: Bearer {token}.

Response

200 OK application/json

Returns an array of matching users.

Example Response

[
  {
    "name": "Vincent",
    "url": "https://vincent.micro.blog/",
    "avatar": "https://avatars.micro.blog/avatars/2026/123.jpg",
    "username": "vincent",
    "bio": "Writing about Micro.blog and the web.",
    "is_following": true,
    "is_you": false
  }
]
GET /users/logs

Returns recent account log messages.

Example Request

curl -X GET "https://micro.blog/users/logs" \
  --header "Authorization: Bearer EF7BB9BCAC1F6D561C93"

Header Parameters

Name Type Required Description
Authorization string Required Bearer token for authentication. Format: Bearer {token}.

Response

200 OK application/json

Returns a JSON response.

Example Response

[
  {
    "date": "2026-04-26T12:00:00+00:00",
    "message": "Publishing complete",
    "is_error": false
  }
]
GET /users/logs/errors

Returns recent account error log messages.

Example Request

curl -X GET "https://micro.blog/users/logs/errors" \
  --header "Authorization: Bearer EF7BB9BCAC1F6D561C93"

Header Parameters

Name Type Required Description
Authorization string Required Bearer token for authentication. Format: Bearer {token}.

Response

200 OK application/json

Returns a JSON response.

Example Response

[
  {
    "date": "2026-04-26T12:00:00+00:00",
    "message": "Could not refresh feed",
    "is_error": true
  }
]
POST /users/unfollow

Unfollows a Micro.blog user.

Example Request

curl -X POST "https://micro.blog/users/unfollow?username=vincent" \
  --header "Authorization: Bearer EF7BB9BCAC1F6D561C93"

Query Parameters

Name Type Required Description
username string Required Micro.blog username.
Example: vincent

Header Parameters

Name Type Required Description
Authorization string Required Bearer token for authentication. Format: Bearer {token}.

Response

200 OK application/json

Returns an empty JSON object on success.

Example Response

{}