> ## Documentation Index > Fetch the complete documentation index at: https://docs.useroulette.com/llms.txt > Use this file to discover all available pages before exploring further. # List shared links > Retrieve all shared links for an account. Shared links allow you to share company portfolios with external parties (LPs, co-investors, etc.) with granular access control. ## OpenAPI ````yaml openapi.json get /accounts/{account_id}/shared-links openapi: 3.1.0 info: title: Roulette API version: 1.0.0 description: > The Roulette API provides programmatic access to manage your VC deal flow, companies, contacts, and related data. ## Authentication All API requests require authentication using a Bearer token. Include your API key in the `Authorization` header: ``` Authorization: Bearer YOUR_API_KEY ``` You can generate API keys from your account settings in the Roulette dashboard. ## Rate Limiting API requests are rate limited to ensure fair usage. Current limits: - 1000 requests per minute per API key - 100 requests per second per API key Rate limit headers are included in all responses: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Requests remaining in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Pagination List endpoints support cursor-based pagination using the following query parameters: - `page`: Page number (default: 1) - `limit`: Items per page (default: 25, max: 100) Paginated responses include pagination metadata: ```json { "data": [...], "pagination": { "page": 1, "limit": 25, "has_next": true, "has_prev": false } } ``` **Note**: For performance reasons, total counts (`total`, `total_pages`) are not included. Use `has_next` and `has_prev` to determine if more pages exist. ## Errors The API uses standard HTTP status codes and returns errors in a consistent format: ```json { "success": false, "error": "Human readable error message", "data": null } ``` Common status codes: - `400` Bad Request - Invalid parameters or request body - `401` Unauthorized - Missing or invalid API key - `403` Forbidden - Valid API key but insufficient permissions - `404` Not Found - Resource not found - `429` Too Many Requests - Rate limit exceeded - `500` Internal Server Error - Server-side error termsOfService: https://www.useroulette.com/terms contact: name: Roulette API Support email: support@useroulette.com url: https://www.useroulette.com/support license: name: Proprietary url: https://www.useroulette.com/license servers: - url: https://www.useroulette.com/api/v1 description: Production server - url: http://localhost:3000/api/v1 description: Local development server security: - BearerAuth: [] tags: - name: Companies description: > Manage companies in your deal flow pipeline. Companies represent potential investment opportunities with associated pitch decks, contacts, and metadata. - name: Company Statuses description: | Manage deal flow stages/statuses for organizing companies through your investment pipeline (e.g., "Initial Review", "Due Diligence", "Closed"). - name: Company Settings description: | Configure custom fields and settings for company tracking. - name: Contacts description: | Manage contacts associated with companies, including founders, executives, and other key personnel. - name: Form Submissions description: | Access form submissions from integrated platforms like Tally. - name: Emails description: | Manage emails linked to companies and contacts. - name: Meeting Minutes description: | Store and retrieve meeting notes and minutes related to companies. - name: Shared Links description: | Create and manage secure shareable links for company portfolios. - name: Integrations description: | Configure third-party integrations (Tally, Specter, etc.). - name: Investor Dashboard description: | Configure and manage investor-facing portfolio dashboards. - name: Dashboard description: | Access aggregated dashboard data and analytics. - name: Team Members description: | View team members and their roles within your account. - name: Short URLs description: | Create shortened URLs with optional password protection. paths: /accounts/{account_id}/shared-links: get: tags: - Shared Links summary: List shared links description: | Retrieve all shared links for an account. Shared links allow you to share company portfolios with external parties (LPs, co-investors, etc.) with granular access control. operationId: listSharedLinks parameters: - $ref: '#/components/parameters/AccountIdParam' - $ref: '#/components/parameters/PageParam' - $ref: '#/components/parameters/LimitParam' - $ref: '#/components/parameters/SortOrderParam' - name: sort_by in: query schema: type: string enum: - created_at - updated_at - name default: created_at - name: is_active in: query required: false description: Filter by active status schema: type: boolean responses: '200': description: List of shared links content: application/json: schema: $ref: '#/components/schemas/SharedLinkListResponse' example: success: true data: links: - id: link-uuid-1 account_id: account-uuid name: Q1 2024 Portfolio short_code: abc123xy short_url: https://www.useroulette.com/s/abc123xy password_protected: true is_active: true view_count: 42 created_at: '2024-01-01T00:00:00Z' pagination: page: 1 limit: 20 total: 5 total_pages: 1 '401': $ref: '#/components/responses/UnauthorizedError' '404': $ref: '#/components/responses/NotFoundError' components: parameters: AccountIdParam: name: account_id in: path required: true description: The unique identifier of the account/team schema: type: string format: uuid example: 550e8400-e29b-41d4-a716-446655440000 PageParam: name: page in: query required: false description: Page number for pagination (starts at 1) schema: type: integer minimum: 1 default: 1 example: 1 LimitParam: name: limit in: query required: false description: Number of items per page (max 100) schema: type: integer minimum: 1 maximum: 100 default: 20 example: 20 SortOrderParam: name: sort_order in: query required: false description: Sort direction schema: type: string enum: - asc - desc default: desc example: desc schemas: SharedLinkListResponse: type: object required: - success - data properties: success: type: boolean data: type: object properties: links: type: array items: $ref: '#/components/schemas/SharedLink' pagination: 2cab2139-7a8c-41f9-ad61-a2b1410e3a38 SharedLink: type: object required: - id - account_id - short_code - created_at properties: id: type: string format: uuid description: Unique identifier for the shared link account_id: type: string format: uuid description: Account this link belongs to name: type: string description: Internal name for the shared link example: Q1 2024 Portfolio for LP description: type: string description: Description of what's being shared short_code: type: string description: Unique short code for the URL example: abc123xy short_url: type: string format: uri description: Full shareable URL example: https://www.useroulette.com/s/abc123xy password_protected: type: boolean description: Whether a password is required to access expires_at: type: string format: date-time nullable: true description: When the link expires (null = never) is_active: type: boolean description: Whether the link is currently active default: true companies: type: array items: $ref: '#/components/schemas/SharedLinkCompany' description: Companies included in this shared link view_count: type: integer description: Number of times the link has been accessed example: 42 created_at: type: string format: date-time updated_at: type: string format: date-time Error: type: object required: - success - error properties: success: type: boolean example: false error: type: string description: Human-readable error message example: Invalid request body data: type: 'null' example: null authType: type: string enum: - api_key - session example: api_key SharedLinkCompany: type: object properties: company_id: type: string format: uuid company_name: type: string permissions: type: string enum: - view - view_deck - full description: | Access level for this company: - `view`: Basic company info only - `view_deck`: Info + pitch deck - `full`: All available information responses: UnauthorizedError: description: Unauthorized - missing or invalid API key content: application/json: schema: $ref: '#/components/schemas/Error' example: success: false error: Invalid or expired API key data: null NotFoundError: description: Resource not found content: application/json: schema: $ref: '#/components/schemas/Error' example: success: false error: Resource not found data: null securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: API Key description: | API key authentication. Generate keys from your account settings. Include in header: `Authorization: Bearer YOUR_API_KEY` ````