> ## Documentation Index
> Fetch the complete documentation index at: https://developers.luminpdf.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Workspace Members
> Return a paginated list of members in a Workspace.
This endpoint requires one of the following scopes:
`workspaces.read` or `workspaces`
```bash Request theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl --request GET \
--url 'https://api.luminpdf.com/v1/workspaces/members?page=1&limit=25' \
--header 'X-API-Key: '
```
## OpenAPI
````yaml GET /workspaces/members
openapi: 3.1.0
info:
version: 1.0.0
title: Lumin API Reference
description: >
The Lumin API Reference provides a comprehensive set of tools to integrate
document workflows — including editing, eSignatures, and automation — into
your applications.
Useful links:
- [Document Repository](https://github.com/luminpdf/luminsign-docs)
- [API
Definition](https://github.com/luminpdf/luminsign-docs/blob/main/openapi.yaml)
- [Authentication Guide](/tabs/guides/authentication/overview)
termsOfService: https://www.luminpdf.com/terms-of-use/
contact:
name: API Support
email: integration@luminpdf.com
url: https://help.luminpdf.com
servers:
- url: https://api.luminpdf.com/v1
description: Production server
security: []
tags:
- name: Signature Requests
description: Everything about Signature Requests
- name: Users
description: Everything about Users
- name: Templates
description: Everything about Templates
- name: Documents
description: Everything about Documents
- name: Workspaces
description: Everything about Workspaces
- name: Agreements
description: Everything about Agreements
paths:
/workspaces/members:
get:
tags:
- Workspaces
summary: Get Workspace Members
description: Return a paginated list of members in a Workspace.
parameters:
- name: page
in: query
description: Specify which page of the dataset to return (min = 1).
required: true
example: 1
schema:
type: integer
minimum: 1
- name: limit
in: query
description: 'Specify how many records to return: one of 10, 25, 50.'
required: true
example: 25
schema:
type: integer
enum:
- 10
- 25
- 50
responses:
'200':
description: Returns the list of members in the Workspace.
content:
application/json:
schema:
$ref: '#/components/schemas/WorkspaceMembersResponse'
example:
page: 1
limit: 25
total_count: '123'
data:
- user_id: 655f...
email: alice@example.com
name: Alice
role: owner
joined_at: 1748456885430
last_active_at: 1748456885430
- user_id: 655f...
email: bob@example.com
name: Bob
role: admin
joined_at: 1748456885430
last_active_at: 1748456885430
- user_id: 655f...
email: carol@example.com
name: Carol
role: member
joined_at: 1748456885430
last_active_at: 1748456885430
4XX:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
security:
- ApiKey: []
- BearerAuth:
- workspaces.read
- BearerAuth:
- workspaces
components:
schemas:
WorkspaceMembersResponse:
type: object
properties:
page:
type: integer
description: The current page of results being returned.
limit:
type: integer
description: The maximum number of records shown per page (e.g., 10, 25, or 50).
total_count:
type: string
description: The total number of records returned for the request.
data:
type: array
description: List of Workspace members returned for the requested page.
items:
$ref: '#/components/schemas/WorkspaceMember'
Error:
type: object
required:
- error_code
- error_message
properties:
error_code:
type: string
description: The system error code.
error_message:
type: string
description: The human-readable error message.
WorkspaceMember:
type: object
properties:
user_id:
type: string
description: The unique identifier for the user.
email:
type: string
description: The email address of the user.
name:
type: string
description: The name of the user.
role:
type: string
description: Role of the member.
enum:
- owner
- admin
- member
joined_at:
type: integer
format: unix-epoch
description: The time the user joined the Workspace.
last_active_at:
type: integer
format: unix-epoch
description: The time the user was last active in Lumin.
securitySchemes:
ApiKey:
type: apiKey
in: header
name: X-API-Key
description: >
Provide your API key in the `X-API-Key` header, e.g., `X-API-Key:
YOUR_API_KEY`.
BearerAuth:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://auth.luminpdf.com/oauth2/auth
tokenUrl: https://auth.luminpdf.com/oauth2/token
scopes:
openid: >-
Retrieve basic identity details (username, email, profile
picture).
offline_access: Request a refresh token for long-lived access. Private apps only.
profile.read: View basic user profile information.
workspaces: View and manage Workspaces and Spaces.
workspaces.read: View information about the authenticated user's Workspace.
templates: View and manage templates in a Workspace.
pdf:files: Create, edit, and delete PDF files in a Workspace.
pdf:files.read: Retrieve PDF documents stored in a Workspace.
sign:requests: Create, update, or view signature requests.
sign:requests.read: Retrieve signature requests.
agreements: Create, update, or delete AgreementGen documents.
description: >
OAuth 2.0 authorization code flow. Provide your access token in the
`Authorization` header, e.g., `Authorization: Bearer `. See the
[OAuth 2.0 guide](/tabs/guides/authentication/oauth2) for details.
````