> ## Documentation Index
> Fetch the complete documentation index at: https://hc.saas-manager.biz.nuro.jp/llms.txt
> Use this file to discover all available pages before exploring further.
# List organization people
> List organization people (data aggregated from SaaS).
Pagination: [Cursor-based](#section/Cursor-based)
## OpenAPI
````yaml https://api.itmc.i.moneyforward.com/public-api/docs/v1-json get /api/v1/organizations/{organizationId}/people
openapi: 3.0.0
info:
title: Admina Public API
description: >-
Admina API is a RESTfull API providing programmatic access to much of the
data in the system. It provides predictable URLs for accessing resources,
and uses built-in HTTP features to receive commands and return responses.
This makes it easy to communicate with from a wide variety of environments,
from command-line utilities to gadgets to the browser URL bar itself.
version: '1.0'
contact: {}
servers:
- url: https://api.itmc.i.moneyforward.com
security: []
tags:
- name: Organizations
description: ''
- name: Users
description: ''
- name: Directory
description: ''
- name: Departments
description: ''
- name: Locations
description: ''
- name: Companies
description: ''
- name: People
description: ''
- name: Workspaces
description: ''
- name: Custom Service and Workspace
description: ''
- name: Workspace Accounts
description: ''
- name: Accounts
description: ''
- name: Contracts
description: ''
- name: Devices
description: ''
- name: Devices (alpha)
description: ''
- name: Alerts
description: ''
- name: Spends
description: ''
- name: Usage Optimization
description: ''
- name: Services
description: ''
- name: Requests
description: ''
- name: AuditLogs
description: ''
- name: EventLogs
description: ''
paths:
/api/v1/organizations/{organizationId}/people:
get:
tags:
- People
summary: List organization people
description: >-
List organization people (data aggregated from SaaS).
Pagination: [Cursor-based](#section/Cursor-based)
operationId: publicGetPeople
parameters:
- name: organizationId
required: true
in: path
schema:
type: number
- name: limit
required: false
in: query
description: Limit the number of results returned. Maximum 200.
schema:
maximum: 200
example: 50
type: number
- name: cursor
required: false
in: query
description: Cursor to paginate through results.
schema:
type: string
- name: types
required: false
in: query
description: Filter results by type. Accepts multiple options.
schema:
type: array
items:
$ref: '#/components/schemas/PeopleType'
- name: statuses
required: false
in: query
description: Filter results by status. Accepts multiple options.
schema:
type: array
items:
$ref: '#/components/schemas/PeopleStatus'
- name: keyword
required: false
in: query
description: Filter results by username, email or displayName.
schema:
type: string
- name: sortBy
required: false
in: query
description: Sort results by a specific field.
schema:
$ref: '#/components/schemas/PeopleSortBy'
- name: sortOrder
required: false
in: query
description: Sort results in ascending or descending order. Defaults to `ASC`.
schema:
$ref: '#/components/schemas/SortOrder'
- name: includePeopleWithNoAccounts
required: false
in: query
description: >-
By default, won't return people who have no SaaS accounts. This flag
will override that behavior.
schema:
type: boolean
- name: serviceIds
required: false
in: query
description: >-
Filter people who own some specific SaaS accounts. Accepts multiple
options.
schema:
example:
- 1
- 2
- 3
type: array
items:
type: number
- name: status
required: false
in: query
description: >-
Filter results by status. Note: please use `statuses` instead, this
property is deprecated and will be removed in a future version.
deprecated: true
schema:
$ref: '#/components/schemas/PeopleStatus'
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PublicGetPeopleResponseDto'
security:
- API-Key: []
components:
schemas:
PeopleType:
type: string
enum:
- employee
- guest
- system
- unknown
PeopleStatus:
type: string
enum:
- active
- suspended
- on_leave
PeopleSortBy:
type: string
enum:
- type
- nameOrAccountKey
- accountCount
- createdAt
SortOrder:
type: string
enum:
- DESC
- ASC
PublicGetPeopleResponseDto:
type: object
properties:
meta:
readOnly: true
allOf:
- $ref: '#/components/schemas/CursorPaginationMeta'
items:
readOnly: true
type: array
items:
$ref: '#/components/schemas/PublicPeopleResponseDto'
required:
- meta
- items
CursorPaginationMeta:
type: object
properties:
nextCursor:
type: string
nullable: true
readOnly: true
example: F3UdkoSbpBNrjwP93AX2HQ
totalItems:
type: number
nullable: true
readOnly: true
example: 1
required:
- nextCursor
PublicPeopleResponseDto:
type: object
properties:
id:
type: number
readOnly: true
example: 1
primaryEmail:
type: string
nullable: true
readOnly: true
example: foo@gmail.com
displayName:
type: string
nullable: true
readOnly: true
example: Yamaha Honda
avatar:
type: string
nullable: true
readOnly: true
example: avatar_url
username:
type: string
nullable: true
readOnly: true
example: foo
type:
type: string
readOnly: true
example: employee
status:
type: string
readOnly: true
example: suspended
suspendedAt:
type: string
nullable: true
readOnly: true
example: '2021-07-13T19:15:40.000Z'
createdAt:
type: string
nullable: true
readOnly: true
example: '2021-07-13T19:15:40.000Z'
accounts:
nullable: false
description: >-
This attribute will be removed in the near future. Please use [List
all SaaS accounts belonging to a
person](#tag/People/operation/getPersonAccounts) API to get the list
of accounts.
readOnly: true
deprecated: true
type: array
items:
$ref: '#/components/schemas/PublicCompactPeopleAccountDto'
required:
- id
- primaryEmail
- displayName
- avatar
- username
- type
- status
- suspendedAt
- createdAt
- accounts
PublicCompactPeopleAccountDto:
type: object
properties:
serviceUniqueName:
type: string
nullable: true
readOnly: true
example: github
serviceName:
type: string
nullable: true
readOnly: true
example: GitHub
workspaceName:
type: string
nullable: true
readOnly: true
example: mfi
accountKey:
type: string
nullable: true
readOnly: true
example: foo@mfi.com
required:
- serviceUniqueName
- serviceName
- workspaceName
- accountKey
securitySchemes:
API-Key:
scheme: bearer
bearerFormat: JWT
type: http
description: >-
For authenticated requests, set the `Authorization: Bearer your_api_key`
parameter in the header.
You can create and manage your API Keys by
visiting the **API Keys** tab in the **Settings** page of your
organization in Admina
````