> ## Documentation Index > Fetch the complete documentation index at: https://docs.getoneprofile.ai/llms.txt > Use this file to discover all available pages before exploring further. # List referrals > The friends who joined through this workspace's link, newest first. ## OpenAPI ````yaml /openapi.json get /referral/ openapi: 3.1.0 info: contact: email: support@getoneprofile.ai name: Oneprofile Support description: >- REST API reference for Oneprofile, the GTM data layer for your CRM. Manage tables, enrichments, and integrations. Authenticate with an API key to get started. termsOfService: https://www.getoneprofile.ai/terms title: API Reference | Oneprofile version: '0.0' servers: - url: https://api.getoneprofile.ai security: [] tags: - description: Sender profiles, connected mailboxes, tags, and the Google connect flow. name: senders - description: The workspace do-not-contact list, enforced before every send. name: suppression - description: 'Sequence authoring: the graph, the table-backed audience, previews.' name: sequences - description: >- The LinkedIn channel: connecting an account to a sender, its safety limits and history, and the protocol the browser extension speaks. name: linkedin - description: 'The unified outreach inbox: threads, replies, labels, events.' name: inbox - description: 'The AI reply layer: workspace settings, drafts, and approval.' name: inbox-ai - description: Notification rules, per-user preferences, and the Slack connection. name: notifications - description: Endpoints for seeing all available integration types. name: integration-types - description: Endpoints for creating and managing integrations. name: integrations - description: Endpoints for the generic OAuth install/claim app-listings engine. name: app-listings - description: Endpoints for creating and managing API keys. name: apikey - description: Endpoints for managing billing and subscription information. name: billing - description: Endpoints for creating and managing tables. name: tables - description: Endpoints for table columns, formula previews, and on-demand column runs. name: table-columns - description: Endpoints for table rows and manual cell edits. name: table-rows - description: Endpoints for observing and cancelling table recompute runs. name: table-runs - description: >- Endpoints for org-shared per-column display preferences: hidden, pinned, width, and colour tint. name: table-ui-prefs - description: >- Endpoints for the org-shared names given to the column tint palette: what this organisation calls each colour. Org-level, not per-table. name: table-column-color-labels - description: >- Endpoints for the enrichment action catalog, model list, presets, draft generation, and saved agents. name: table-enrichments - description: >- Endpoints for teaching a saved agent from example rows: training sessions, per-row feedback, and the proposed prompt to approve. name: agent-training - description: >- The durable audit trail of a table's enrichment actions: configured, edited, run, cancelled, and settled cost. name: table-enrichment-audit-logs - description: Endpoints for saving and applying column templates. name: table-templates - description: Server-sent change feed for a table's grid. name: table-events - description: 'Endpoints for org-shared saved table views: sort, filters, hidden columns.' name: table-views - description: >- The per-table AI Assistant: named conversations, the column suggestions a build turn produces, and the questions an analyze turn answers. name: table-assistant - description: >- Endpoints for PER-USER table preferences: favourites and recently opened. Unlike the rest of the table surface these are personal, so two members of one organisation legitimately see different answers. name: table-user-prefs - description: >- Endpoints for building a table from an uploaded CSV: upload and preview the inferred columns, commit the reviewed mapping, then poll the row load. name: table-imports - description: Endpoint for downloading a table's rows as CSV. name: table-export - description: >- Endpoints for the integration a table imports from: attach and preview it, promote imported fields into columns, and run the import on demand. name: table-sources - description: >- Endpoints for a table's recurring import cadence: set it, pause it, and read the next fire times. name: table-schedules - description: >- Endpoints for pushing a table's rows out to a connected integration: list writable destinations, derive their write capabilities, and map export columns. name: table-writeback - description: >- Endpoints backing a lookup column's setup: the connections whose records a column could read, and the identity fields one record type can be looked up by. name: table-integration-lookup - description: >- Endpoints for sourcing leads from the lead database: count and preview matches, land them in a table, and keep saved searches. name: find-leads - description: >- Endpoints for discovering a domain's subdomains from public certificate logs and landing the results in a table. name: find-subdomains - description: Endpoints for the credit balance meter and usage reporting. name: credits - description: >- Endpoints for the workspace referral program: the shareable link, the friends who joined through it, and claiming a code after signup. name: referral - description: >- Endpoints for the design partner program's customer surface: whether this workspace is a design partner, the badges its feedback has earned, and sending and reading that feedback. name: design-partner - description: >- Endpoints for the org-level AI business context — company description, ideal customer profile, buyer personas and interest signals — plus domain-based generation. name: ai-context paths: /referral/: get: tags: - referral summary: List referrals description: The friends who joined through this workspace's link, newest first. operationId: list_referrals parameters: - in: query name: status required: false schema: anyOf: - $ref: '#/components/schemas/ReferralStatus' - type: 'null' description: >- Narrow to friends still on a free plan, or only those on a paid plan. The two are disjoint; omit for everything. description: >- Narrow to friends still on a free plan, or only those on a paid plan. The two are disjoint; omit for everything. - description: The number of items to return. in: query name: limit required: false schema: default: 10 description: The number of items to return. maximum: 100 minimum: 1 title: Limit type: integer - in: query name: order_by required: false schema: $ref: '#/components/schemas/OrderingParametersForIdSignedUpAtCreatedAt' default: signed_up_at enum: - id - signed_up_at - created_at type: string - in: query name: order_direction required: false schema: default: desc enum: - asc - desc title: Order Direction type: string - description: >- Set the cursor to the next or previous page. You can get the cursor from the previous page's response. in: query name: cursor required: false schema: anyOf: - type: string - type: 'null' description: >- Set the cursor to the next or previous page. You can get the cursor from the previous page's response. title: Cursor for pagination. responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedResponse_ReferralReadSchema_' description: Successful Response '401': content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ForbiddenResponse' description: Forbidden '422': content: application/json: schema: $ref: '#/components/schemas/UnprocessableEntityResponse' description: Invalid request made to the API. '500': content: application/json: schema: $ref: '#/components/schemas/ServerErrorResponse' description: Internal server error. '502': content: application/json: schema: $ref: '#/components/schemas/ServerErrorResponse' description: Bad gateway error. '503': content: application/json: schema: $ref: '#/components/schemas/ServerErrorResponse' description: Service unavailable. security: - HTTPBearer: [] - APIKeyHeader: [] components: schemas: ReferralStatus: description: |- How far along one referral is — the list filter's vocabulary. Deliberately NOT Clay's "lead" / "conversion". This product has a Find Leads feature, so a referral labelled a lead reads as a sales prospect. enum: - signed_up - converted title: ReferralStatus type: string OrderingParametersForIdSignedUpAtCreatedAt: enum: - id - signed_up_at - created_at title: OrderingParametersForIdSignedUpAtCreatedAt type: string PaginatedResponse_ReferralReadSchema_: properties: data: description: The list of ResponseItems. items: $ref: '#/components/schemas/ReferralReadSchema' title: Data type: array next_page_cursor: anyOf: - type: string - type: 'null' description: >- The cursor to the next page. If there are no more pages, this is None. previous_page_cursor: anyOf: - type: string - type: 'null' description: >- The cursor to the previous page. If there are no previous pages, this is None. title: PaginatedResponse[ReferralReadSchema] type: object UnauthorizedResponse: properties: detail: description: The detail of why the request is unauthorized. title: Detail type: string required: - detail title: UnauthorizedResponse type: object ForbiddenResponse: properties: detail: description: The detail of why the request is forbidden. title: Detail type: string required: - detail title: ForbiddenResponse type: object UnprocessableEntityResponse: properties: detail: description: >- The detail of the error. This is the error message to show to the user. You should also use the issues field to show more detailed error messages per field. Use this field for a single liner error message. title: Detail type: string issues: description: >- The issues that caused the error. There can be multiple issues. Each issue is a user-facing error message. items: $ref: '#/components/schemas/UnprocessableEntityIssue' title: Issues type: array required: - detail - issues title: UnprocessableEntityResponse type: object ServerErrorResponse: properties: detail: description: The detail of why the server returned an error. title: Detail type: string required: - detail title: ServerErrorResponse type: object ReferralReadSchema: description: One row of the referral list. properties: converted_at: anyOf: - format: date-time type: string - type: 'null' description: When they started their first paid plan; null while still on free. title: Converted At credits_earned: description: Credits this referral has earned the referrer, in decimal credits. title: Credits Earned type: number email: title: Email type: string id: format: uuid title: Id type: string name: anyOf: - type: string - type: 'null' description: The referred person's display name, when known. title: Name signed_up_at: description: When they joined through the link. format: date-time title: Signed Up At type: string status: $ref: '#/components/schemas/ReferralStatus' required: - id - name - email - signed_up_at - converted_at - status - credits_earned title: ReferralReadSchema type: object UnprocessableEntityIssue: properties: input: anyOf: - type: string - type: integer - type: number - type: boolean - items: {} type: array - additionalProperties: true type: object description: The user's input that caused the error. title: Input loc: description: >- The location of the error. Always contains 1 or 2 elements. The first element is the type of location (e.g. 'body', 'query', 'path', 'header'). The second element is the name of the field that caused the error. If the error is not related to a specific field, the second element is not present. items: type: string title: Loc type: array msg: description: The message of the error. The error message to show to the user. title: Msg type: string type: description: >- The type of the error. Useful for frontend code to handle different types of errors. title: Type type: string required: - loc - msg - type - input title: UnprocessableEntityIssue type: object securitySchemes: HTTPBearer: scheme: bearer type: http APIKeyHeader: in: header name: X-API-Key type: apiKey ````