jointrashposs/content/ja/.docs-legacy/api/endpoints/users.json5
2023-07-11 23:48:17 +09:00

75 lines
1.1 KiB
Plaintext

{
summary: '',
description: '',
tags: [
'users',
],
requireCredential: false,
req: {
type: 'object',
properties: {
limit: {
type: 'integer',
minimum: 1,
maximum: 100,
default: 10,
},
offset: {
type: 'integer',
default: 0,
},
sort: {
type: 'string',
enum: [
'+follower',
'-follower',
'+createdAt',
'-createdAt',
'+updatedAt',
'-updatedAt',
],
},
state: {
type: 'string',
enum: [
'all',
'admin',
'moderator',
'adminOrModerator',
'alive',
],
default: 'all',
},
origin: {
type: 'string',
enum: [
'combined',
'local',
'remote',
],
default: 'local',
},
hostname: {
type: 'string',
nullable: true,
default: null,
description: 'The local host is represented with `null`.',
},
},
required: [],
},
res: {
type: 'array',
optional: false,
nullable: false,
items: {
type: 'object',
optional: false,
nullable: false,
ref: 'UserDetailed',
$ref: 'misskey://UserDetailed',
},
},
errors: {},
}