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

Push Notifications

View .md

Endpoints for registering, unregistering, and inspecting push notification devices.

Note: Push notifications require additional setup on the Micro.blog side for your app’s push credentials. Email help@micro.blog before using these endpoints with a custom app_name.
BASE URL https://micro.blog
GET /users/push/info

Returns registered push devices for the authenticated user and push environment.

Example Request

curl -X GET "https://micro.blog/users/push/info?push_env=production" \
  --header "Authorization: Bearer EF7BB9BCAC1F6D561C93"

Query Parameters

Name Type Required Description
push_env string Required Push environment, for example production or sandbox.
Example: production
app_name string Optional Name of the app requesting access.
Example: Micro.blog for Android
device_token string Optional Push notification device token.
Example: TEST

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 for the requested resource.

Example Response

[
  {
    "token": "DEVICE_TOKEN",
    "app_name": "Micro.blog for iOS",
    "push_env": "production",
    "created_at": "2026-04-26T12:00:00+00:00"
  }
]
POST /users/push/register

Registers a device token for push notifications.

Example Request

curl -X POST "https://micro.blog/users/push/register?device_token=TEST&push_env=production" \
  --header "Authorization: Bearer EF7BB9BCAC1F6D561C93"

Query Parameters

Name Type Required Description
device_token string Required Push notification device token.
Example: TEST
push_env string Required Push environment, for example production or sandbox.
Example: production
app_name string Optional Name of the app requesting access.
Example: Micro.blog for Android

Header Parameters

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

Response

201 OK application/json

Returns registration status and device metadata. Already-registered devices return 200 with the same shape.

Example Response

{
  "status": "success",
  "message": "Device registered",
  "device": {
    "token": "DEVICE_TOKEN",
    "app_name": "Micro.blog for Android",
    "push_env": "production",
    "created_at": "2026-04-26T12:00:00+00:00"
  }
}
POST /users/push/unregister

Unregisters a device token for push notifications.

Example Request

curl -X POST "https://micro.blog/users/push/unregister?device_token=TEST&push_env=production" \
  --header "Authorization: Bearer EF7BB9BCAC1F6D561C93"

Query Parameters

Name Type Required Description
device_token string Required Push notification device token.
Example: TEST
push_env string Required Push environment, for example production or sandbox.
Example: production
app_name string Optional Name of the app requesting access.
Example: Micro.blog for Android

Header Parameters

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

Response

200 OK application/json

Returns unregister status.

Example Response

{
  "status": "success",
  "message": "Device unregistered"
}