> ## Documentation Index > Fetch the complete documentation index at: https://doc.folkyn.com/llms.txt > Use this file to discover all available pages before exploring further. # List Team Users > Lists company users (team admins and members), including pending invitations. Default `status` filter: `active,pending`. Other values: `expired`, `undeliverable`, or `all`. For `status: active`, `id` is the profile UUID. For invitations, `id` is the invitation UUID. ## OpenAPI ````yaml /openapi.yaml get /api/v1/users openapi: 3.0.3 info: title: Folkyn API version: 1.0.0 license: name: Proprietary url: https://folkyn.com description: >- Team API key; responses in `data`, errors in `error` with `X-Request-Id`. Spec at `/api/v1/openapi.yaml` and `/api/v1/openapi.json` (no key). **60 requests/minute** per key on `/api/v1/*`. servers: - url: https://api.folkyn.com description: Production security: - bearerAuth: [] - ApiKeyHeader: [] tags: - name: Specification description: OpenAPI document download (no authentication) - name: Project codes description: Team project codes - name: Team tags description: Team tags - name: Teams description: Organizational teams (team units) and member lists - name: Missions description: Team missions - name: Freelancers description: Team freelancers and invitations - name: Activity reports description: Activity reports (CRA) - name: Accounting description: Accounting entries paths: /api/v1/users: get: tags: - Users summary: List Team Users description: > Lists company users (team admins and members), including pending invitations. Default `status` filter: `active,pending`. Other values: `expired`, `undeliverable`, or `all`. For `status: active`, `id` is the profile UUID. For invitations, `id` is the invitation UUID. operationId: listUsers parameters: - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PerPage' - name: status in: query description: >- Comma-separated segments — `active`, `pending`, `expired`, `undeliverable`, or `all`. Default `active,pending`. schema: type: string example: active,pending - name: role in: query description: >- Filter by team role — `team-admin` or `team-member`. Omit for all roles. schema: type: string enum: - team-admin - team-member - name: email in: query description: >- Filter by exact email address (case-insensitive). Matches both active members and invitations. schema: type: string format: email example: jane.doe@acme.com responses: '200': description: Success content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/PaginatedPartnerUsers' '400': description: Validation (unknown status or role) content: application/json: schema: $ref: '#/components/schemas/PublicError' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/ForbiddenError' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalError' components: parameters: Page: name: page in: query schema: type: integer minimum: 1 default: 1 PerPage: name: per_page in: query schema: type: integer minimum: 1 maximum: 100 default: 10 schemas: PaginatedPartnerUsers: type: object required: - items - total - current_page - per_page properties: items: type: array items: $ref: '#/components/schemas/UserListItemPublic' total: type: integer current_page: type: integer per_page: type: integer PublicError: type: object required: - error properties: error: type: object required: - code - message - request_id properties: code: type: integer description: Same as HTTP status; use `message` and `details` to narrow. enum: - 400 - 401 - 403 - 404 - 429 - 500 example: 401 message: type: string request_id: type: string format: uuid description: Correlates with the X-Request-Id response header. details: $ref: '#/components/schemas/PublicErrorDetails' UserListItemPublic: type: object required: - id - email - role - status - tags - teams properties: id: type: string format: uuid description: >- Profile UUID when active; invitation UUID when pending/expired/undeliverable. email: type: string format: email first_name: type: string nullable: true last_name: type: string nullable: true role: type: string enum: - team-admin - team-member job_title: type: string nullable: true status: type: string enum: - active - pending - expired - undeliverable tags: type: array items: $ref: '#/components/schemas/PartnerTagPublic' teams: type: array description: Organizational teams assigned to the user or invitation. items: $ref: '#/components/schemas/PartnerTeamUnitPublic' created_at: type: string format: date-time nullable: true PublicErrorDetails: type: object description: Optional structured hints (validation, scope, rate limit). additionalProperties: true properties: reason: $ref: '#/components/schemas/PartnerValidationErrorReason' field: type: string description: JSON body field name when applicable (e.g. `name`). example: name requiredScope: type: string description: >- Required OAuth-like scope string when `code` is 403 (insufficient scope). example: tags:write retryAfterSeconds: type: integer minimum: 0 description: Hint when `code` is 429. PartnerTagPublic: type: object required: - id - name properties: id: type: string format: uuid name: type: string PartnerTeamUnitPublic: type: object required: - id - name - depth - path - parent_id properties: id: type: string format: uuid name: type: string depth: type: integer minimum: 1 maximum: 3 path: type: string description: Ancestor path from root to this node. parent_id: type: string format: uuid nullable: true PartnerValidationErrorReason: type: string description: >- Machine-readable validation subtype (HTTP 400) for create tag / project code. enum: - invalid_json - required_field - duplicate_name responses: Unauthorized: description: Missing or invalid API key content: application/json: schema: $ref: '#/components/schemas/PublicError' ForbiddenError: description: Insufficient scope or forbidden content: application/json: schema: $ref: '#/components/schemas/PublicError' RateLimited: description: Too many requests content: application/json: schema: $ref: '#/components/schemas/PublicError' InternalError: description: Server error content: application/json: schema: $ref: '#/components/schemas/PublicError' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API Key description: 'Use `Authorization: Bearer `' ApiKeyHeader: type: apiKey in: header name: X-Api-Key ````