GET https://api.hivemoderation.com/api/v1/appeals/status/<APPEAL_ID>

Get the status of an appeal given the appeal_id.

Example Request

curl -X GET https://api.hivemoderation.com/api/v1/appeals/status/appeal_id_123

Request

Headers

There are no required headers.

Request Parameters

Parameter	Type	Required	Description
`appeal_id`	string	Yes	Unique identifier for the created appeal.

Responses

Response Fields

Field	Type	Always Returned	Description
`appeal_id`	string	Yes	Unique identifier for the created appeal.
`appeal.appeal_status`	string	Yes	The status of the appeal, which is either `"In Review"` or `"Reviewed"`.
`appeal.appeal_judgment`	object	No	An object that provides information about the current appeal judgment, if any.
`original_decision`	object	Yes	An object that provides information about the original judgment decision, if any.

Appeal Judgment Object

Returned when at least one judgment has been made.

Field	Type	Always Returned	Description
`action_id`	string	No	Unique identifier for the action taken.
`action_name`	string	No	Name of the action on Moderation Dashboard.
`action_reasons`	array	No	List of reasons for the action taken, if any.
`overturned`	boolean	No	Returns whether a final judgment overturns or upholds a prior judgment.

Original Decision Object

Always returned. If no decision has been made, an empty object {} will be returned.

Field	Type	Always Returned	Description
action_id	string	Yes	Unique identifier for the action taken.
display_name	string	Yes	Name of the action on Moderation Dashboard.
action_reasons	string	No	List of reasons for the action taken, if any.

Example Responses

Example Success In Review (200 OK)

{
  "appeal_id": "appeal_id_123",
  "appeal": {
    "appeal_status": "In Review"
  },
  "original_decision": {
    "action_id": "action_id_123",
    "display_name": "Your Action Name",
  }
}

Example Success Reviewed (200 OK)

{
  "appeal_id": "appeal_id_123",
  "appeal": {
    "appeal_status": "Reviewed",
    "appeal_judgment": {
      "overturned": true
    }
  },
  "original_decision": {
    "action_id": "action_id_123",
    "display_name": "Your Action Name",
  }
}

Example Error Response (400 Bad Request)

{
  "error": true,
  "status": 400,
  "error_code": "INVALID_APPEAL",
  "message": "This appeal does not exist",
  "show_alert": false
}

Common Errors

Status Code	Error Code	Description
400	INVALID_APPEAL	Invalid `appeal_id`.