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

Blocking and Reporting

View .md

Endpoints for reporting users and managing muted users.

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

Blocks and mutes a user.

Example Request

curl -X POST "https://micro.blog/users/block?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

{
  "id": 12345,
  "username": "vincent"
}
GET /users/blocking

Returns blocked users.

Example Request

curl -X GET "https://micro.blog/users/blocking" \
  --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

[
  {
    "id": 12345,
    "username": "vincent"
  }
]
DELETE /users/blocking/{id}

Deletes a blocked user by ID.

Example Request

curl -X DELETE "https://micro.blog/users/blocking/{id}" \
  --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
id integer Required Resource identifier.
Example: 12345

Response

200 OK application/json

Returns an empty JSON object on success.

Example Response

{}
POST /users/mute

Mutes a user or keyword for the authenticated user.

Example Request

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

Query Parameters

Name Type Required Description
username string Optional Micro.blog username.
Example: gluon
keyword string Optional Keyword to mute.
Example: spoiler

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/muting

Returns muted users and keywords for the authenticated user.

Example Request

curl -X GET "https://micro.blog/users/muting" \
  --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 for the requested resource.

Example Response

[
  {
    "id": 12345,
    "username": "gluon",
    "domain": "",
    "keyword": "spoiler",
    "is_hiding_other_replies": true
  }
]
DELETE /users/muting/{id}

Deletes a muted user or keyword by ID.

Example Request

curl -X DELETE "https://micro.blog/users/muting/{id}" \
  --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
id integer Required Identifier for the resource.
Example: 12345

Response

200 OK application/json

Returns an empty JSON object on success.

Example Response

{}
POST /users/muting/{id}

Updates a muted user or keyword setting.

Example Request

curl -X POST "https://micro.blog/users/muting/{id}" \
  --header "Authorization: Bearer EF7BB9BCAC1F6D561C93"

Query Parameters

Name Type Required Description
is_hiding_other_replies integer Optional Whether muted-user replies from other people should be hidden.
Example: 1

Header Parameters

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

Path Parameters

Name Type Required Description
id integer Required Resource identifier.
Example: 12345

Response

200 OK application/json

Returns an empty JSON object on success.

Example Response

{}
POST /users/report

Reports a user for review.

Example Request

curl -X POST "https://micro.blog/users/report?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

{}