> ## Documentation Index > Fetch the complete documentation index at: https://alpha.developer.tomorro.com/llms.txt > Use this file to discover all available pages before exploring further. # List members > Returns a paginated list of members in your organization. Supports cursor-based pagination, sorting, and filtering. ## OpenAPI ````yaml /openapi-2025-01-29.alpha.json get /members openapi: 3.0.0 info: title: Tomorro API description: > The Tomorro Public API enables you to programmatically manage contracts, members, and counterparties. Build powerful integrations that automate your contract management workflows. ## API Version: 2025-01-29.alpha This documentation is for API version `2025-01-29.alpha`. ### Using this version ``` curl -X GET https://api.tomorro.com/members \ -H "x-api-key: YOUR_API_KEY" \ -H "tomorro-version: 2025-01-29.alpha" ``` version: 2025-01-29.alpha contact: {} servers: - url: https://api.tomorro.com/v2 description: Production - url: https://api.demo.tomorro.com/v2 description: Demo - url: http://localhost:3015 description: Local Development security: [] tags: [] paths: /members: get: tags: - Members summary: List members description: >- Returns a paginated list of members in your organization. Supports cursor-based pagination, sorting, and filtering. operationId: MemberController_listMembers parameters: - name: limit required: false in: query description: Number of items per page (1-50) schema: minimum: 1 maximum: 50 default: 20 example: 20 type: number - name: after required: false in: query description: >- Cursor for forward pagination. Use the `next_cursor` value from a previous response. schema: example: eyJpZCI6IjEyMyJ9 type: string - name: before required: false in: query description: >- Cursor for backward pagination. Use the `prev_cursor` value from a previous response. schema: example: eyJpZCI6IjEwMCJ9 type: string - name: sort required: false in: query description: >- Sort order. Comma-separated list of fields. Prefix with `-` for descending. Allowed fields: `id`, `role`, `status`, `createdAt`, `updatedAt`. Default: `-createdAt` schema: example: '-createdAt,role' type: string - name: status required: false in: query description: >- Filter by status. Formats: `status=active` (equality), `status=ne:disabled` (not equals), `status=in:active,pending` (in list) schema: example: active type: string - name: role required: false in: query description: >- Filter by role. Formats: `role=ADMIN` (equality), `role=ne:USER` (not equals), `role=in:ADMIN,MANAGER` (in list) schema: example: ADMIN type: string - name: email required: false in: query description: >- Filter by email. Formats: `email=user@example.com` (equality), `email=ne:user@example.com` (not equals), `email=in:a@example.com,b@example.com` (in list) schema: example: user@example.com type: string responses: '200': description: List of members with pagination info content: application/json: schema: $ref: '#/components/schemas/MemberListResponseDto' '401': description: Unauthorized - Invalid or missing API key '403': description: Forbidden - Insufficient permissions '429': description: Too Many Requests - Rate limit exceeded security: - X-API-KEY: [] components: schemas: MemberListResponseDto: type: object properties: data: description: An array of Member objects. example: - id: 550e8400-e29b-41d4-a716-446655440000 role: USER status: active user: email: john.doe@example.com firstName: John lastName: Doe groupIds: - 550e8400-e29b-41d4-a716-446655440000 createdAt: '2024-01-01T00:00:00.000Z' updatedAt: '2024-01-02T00:00:00.000Z' type: array items: $ref: '#/components/schemas/MemberResponseDto' pagination: description: Pagination metadata including cursors and navigation flags. example: limit: 20 next_cursor: eyJpZCI6IjEyMyJ9 prev_cursor: eyJpZCI6IjEwMCJ9 has_next: true has_previous: false allOf: - $ref: '#/components/schemas/PaginationMetaDto' links: description: HATEOAS navigation links for pagination. example: self: /members?limit=20 next: /members?limit=20&after=eyJpZCI6IjEyMyJ9 prev: /members?limit=20&before=eyJpZCI6IjEwMCJ9 allOf: - $ref: '#/components/schemas/PaginationLinksDto' required: - data - pagination - links MemberResponseDto: type: object properties: id: type: string description: Unique identifier for the member. example: 550e8400-e29b-41d4-a716-446655440000 role: type: string description: >- The role assigned to this member, which determines their permissions. - `USER`: Standard user with basic access to view and interact with contracts. - `MANAGER`: Can create, edit, and manage contracts and workflows. - `ADMIN`: Full administrative access including member management and organization settings. enum: - USER - MANAGER - ADMIN example: ADMIN status: type: string description: >- The current status of the member. - `active`: The member has accepted their invitation and can access the platform. - `disabled`: The member has been deactivated and cannot access the platform. - `pending`: The member has been invited but has not yet accepted. enum: - active - disabled - pending example: active user: description: The user account associated with this member. example: email: john.doe@example.com firstname: John lastname: Doe allOf: - $ref: '#/components/schemas/MemberUserResponseDto' groupIds: description: List of group UUIDs the member belongs to. example: - 550e8400-e29b-41d4-a716-446655440000 type: array items: type: string createdAt: format: date-time type: string description: >- Time at which the member was created. Formatted as an ISO 8601 date-time string. example: '2024-01-01T00:00:00.000Z' updatedAt: format: date-time type: string description: >- Time at which the member was last updated. Formatted as an ISO 8601 date-time string. example: '2024-01-02T00:00:00.000Z' required: - id - role - status - user - groupIds PaginationMetaDto: type: object properties: limit: type: number description: The number of items per page. example: 20 next_cursor: type: string description: >- Cursor for fetching the next page. Use with the `after` query parameter. nullable: true example: eyJpZCI6IjEyMyJ9 prev_cursor: type: string description: >- Cursor for fetching the previous page. Use with the `before` query parameter. nullable: true example: eyJpZCI6IjEwMCJ9 has_next: type: boolean description: Whether there are more items available after this page. example: true has_previous: type: boolean description: Whether there are items available before this page. example: false required: - limit - next_cursor - prev_cursor - has_next - has_previous PaginationLinksDto: type: object properties: self: type: string description: URL of the current page. example: /members?limit=20 next: type: string description: URL to fetch the next page. Null if there is no next page. nullable: true example: /members?limit=20&after=eyJpZCI6IjEyMyJ9 prev: type: string description: URL to fetch the previous page. Null if there is no previous page. nullable: true example: /members?limit=20&before=eyJpZCI6IjEwMCJ9 required: - self - next - prev MemberUserResponseDto: type: object properties: email: type: string description: >- The email address of the user. This is used for login and communications. example: john.doe@example.com firstName: type: string description: The first name of the user. nullable: true example: John lastName: type: string description: The last name of the user. nullable: true example: Doe required: - email securitySchemes: X-API-KEY: type: apiKey in: header name: x-api-key description: >- API key for authentication. Get your key at https://app.tomorro.com/settings/integrations?integration=api-key ````