> ## 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 structure members
> List the members of an organization structure.
Pagination: [Cursor-based](#section/Cursor-based)
## OpenAPI
````yaml https://api.saas-manager.biz.nuro.jp/public-api/docs/v1-json get /api/v1/organizations/{organizationId}/structures/{structureId}/members
openapi: 3.0.0
info:
title: Assist SaaS Manager Public API
description: >-
Assist SaaS Manager API is a RESTful 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.saas-manager.biz.nuro.jp
security: []
tags:
- name: Organizations
description: ''
- name: Users
description: ''
- name: Directory
description: ''
- name: Departments
description: ''
- name: Locations
description: ''
- name: Companies
description: ''
- name: Structures
description: ''
- name: People
description: ''
- name: People Stats
description: ''
- name: Employee Masters
description: ''
- name: Workspaces
description: ''
- name: Custom Service and Workspace
description: ''
- name: Custom Services
description: ''
- name: Workspace Accounts
description: ''
- name: Workspace Licenses
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: Service Roles
description: ''
- name: Service Licenses
description: ''
- name: Recommended Services
description: ''
- name: Requests
description: ''
- name: AuditLogs
description: ''
- name: EventLogs
description: ''
paths:
/api/v1/organizations/{organizationId}/structures/{structureId}/members:
get:
tags:
- Structures
summary: List structure members
description: >-
List the members of an organization structure.
Pagination:
[Cursor-based](#section/Cursor-based)
operationId: publicGetStructureMembers
parameters:
- name: organizationId
required: true
in: path
schema:
type: number
- name: structureId
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: keyword
required: false
in: query
description: 'Search keyword: identity name or email.'
schema:
type: string
- name: memberType
required: false
in: query
description: Filter for member type/role.
schema:
$ref: '#/components/schemas/MemberType'
- name: sortBy
required: false
in: query
description: Sort results by email, member type, status or join date.
schema:
$ref: '#/components/schemas/StructureMembersSortBy'
- name: sortOrder
required: false
in: query
description: Sort results in ascending or descending order. Defaults to `ASC`.
schema:
$ref: '#/components/schemas/SortOrder'
- name: types
required: false
in: query
description: Filter results by type. Accepts multiple options.
schema:
type: array
items:
$ref: '#/components/schemas/EmployeeType'
- name: statuses
required: false
in: query
description: Filter results by status. Accepts multiple options.
schema:
type: array
items:
$ref: '#/components/schemas/ExtendedEmployeeStatus'
- name: serviceId
required: false
in: query
description: Filter results by serviceId.
schema:
type: number
example: 1
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PublicGetStructureMembersResponseDto'
'401':
description: Invalid or missing API key
security:
- API-Key: []
components:
schemas:
MemberType:
type: string
enum:
- manager
- member
- guest
StructureMembersSortBy:
type: string
enum:
- email
- memberType
- status
- joinedAt
SortOrder:
type: string
enum:
- DESC
- ASC
EmployeeType:
type: string
enum:
- board_member
- full_time_employee
- fixed_time_employee
- temporary_employee
- part_time_employee
- secondment_employee
- contract_employee
- collaborator
- group_address
- shared_address
- test_address
- other
- unknown
- unregistered
ExtendedEmployeeStatus:
type: string
enum:
- active
- on_leave
- draft
- preactive
- retired
- untracked
- archived
description: Extended status of the employee
PublicGetStructureMembersResponseDto:
type: object
properties:
meta:
readOnly: true
allOf:
- $ref: '#/components/schemas/CursorPaginationMeta'
items:
readOnly: true
type: array
items:
$ref: '#/components/schemas/PublicStructureMemberResponseDto'
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
PublicStructureMemberResponseDto:
type: object
properties:
identityId:
type: string
readOnly: true
example: 300VUC9TE3
memberType:
nullable: true
readOnly: true
example: member
allOf:
- $ref: '#/components/schemas/MemberType'
roleId:
type: number
nullable: true
readOnly: true
example: 1
peopleId:
type: number
readOnly: true
example: 1
name:
type: string
nullable: true
readOnly: true
example: Full Name
email:
type: string
nullable: true
readOnly: true
example: email@iggre.net
avatar:
type: string
nullable: true
readOnly: true
joinedAt:
format: date-time
type: string
readOnly: true
example: '2024-01-01T12:00:00Z'
groupNames:
readOnly: true
type: array
items:
type: string
status:
type: string
nullable: true
readOnly: true
example: active
workspaceNames:
readOnly: true
type: array
items:
type: string
required:
- identityId
- memberType
- roleId
- peopleId
- name
- email
- avatar
- joinedAt
- groupNames
- status
- workspaceNames
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 Assist SaaS Manager
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.