jointrashposs/content/ja/.docs-legacy/api/endpoints/federation/followers.json5

51 lines
1.1 KiB
Plaintext
Raw Normal View History

2023-07-08 10:36:02 +02:00
{
summary: 'ローカルユーザーからサーバーに所属するユーザーへのフォローを取得します。',
description: 'ローカルユーザーからサーバーに所属するユーザーへのフォローを取得します。',
tags: [
'federation',
],
requireCredential: false,
req: {
type: 'object',
properties: {
host: {
type: 'string',
description: 'ホスト名。',
},
sinceId: {
type: 'string',
format: 'misskey:id',
description: '指定すると、idがその値よりも大きいフォローを返します。',
},
untilId: {
type: 'string',
format: 'misskey:id',
description: '指定すると、idがその値よりも大きいフォローを返します。',
},
limit: {
type: 'integer',
minimum: 1,
maximum: 100,
default: 10,
description: '取得するフォローの最大数。',
},
},
required: [
'host',
],
},
res: {
type: 'array',
optional: false,
nullable: false,
items: {
type: 'object',
optional: false,
nullable: false,
ref: 'Following',
$ref: 'misskey://Following',
},
},
errors: {},
}