Returns the children of a message.

GET 
/api/v1/messages/:messageId/children

Returns the children of a message.

Request

Path Parameters

messageId stringrequired
Identifier of the message.
Example: f532a53545103276b46876c473846d98648ee418468bce76df4868648dd73e5d

Responses

200

Successful operation.

application/json

Schema

Schema

data objectrequired

messageId stringrequired

The message identifier of the given message that was used to look up its children.

maxResults integerrequired

The number of results it can return at most.

count integerrequired

The actual number of found results.

childrenMessageIds string[]required

The message identifiers of the found children.

Example (from schema)

{
  "data": {
    "messageId": "string",
    "maxResults": 0,
    "count": 0,
    "childrenMessageIds": [
      "string"
    ]
  }
}

Children were found

{
  "data": {
    "messageId": "ed3c3f1a319ff4e909cf2771d79fece0ac9bd9fd2ee49ea6c0885c9cb3b1248c",
    "maxResults": 1000,
    "count": 2,
    "childrenMessageIds": [
      "1c6943b0487c92fd057d4d22ad844cc37ee27fe6fbe88e5ff0d20b2233f75b9d",
      "7ed3d67fc7b619e72e588f51fef2379e43e6e9a856635843b3f29aa3a3f1f006"
    ]
  }
}

No children were found

{
  "data": {
    "messageId": "7ed3d67fc7b619e72e588f51fef2379e43e6e9a856635843b3f29aa3a3f1f006",
    "maxResults": 1000,
    "count": 0,
    "childrenMessageIds": []
  }
}

400

Unsuccessful operation: indicates that the provided data is invalid.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 400,
    "message": "invalid data provided"
  }
}

403

Unsuccessful operation: indicates that the endpoint is not available for public use.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 403,
    "message": "not available for public use"
  }
}

500

Unsuccessful operation: indicates that an unexpected, internal server error happened which prevented the node from fulfilling the request.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 500,
    "message": "internal server error"
  }
}

Loading...