> ## 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 senders ## OpenAPI ````yaml /openapi.json get /sender-profiles/ 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: >- The docked AI Assistant: its general chat about the workspace and the product, streamed as Server-Sent Events, and the one list of a person's threads across every assistant, with pin, rename, delete and the search-to-table link. name: assistant - description: >- The messages a person keeps to send the assistant again: the ones the workspace saved and the ones that ship with the product, with save, rename, edit and delete. name: assistant-prompt - description: >- Granted workspace actions: what the AI Assistant proposed or applied in a conversation, the approve and dismiss decisions on each card, the workspace's approval threshold and default grants, and the eight verbs. name: workspace-actions - description: >- The Getting started checklist: a workspace's progress through the six steps from its first people search to its first launched sequence. name: onboarding - description: Senders, connected mailboxes, tags, and the Google connect flow. name: senders - description: The workspace do-not-contact list, enforced before every send. name: suppression - description: >- The workspace's recontact rule: how long before anyone hears from us again. name: contact_cooldown - description: 'Sequence authoring: the graph, the table-backed audience, previews.' name: sequences - description: >- The outbound agent behind a sequence: the voice it writes in, its per-message prompts, what it wrote and what people told it. name: outbound-agents - 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 approval queue: everything waiting on a person across every sender and channel, and the workspace's manual or automatic modes per channel. name: outreach - 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: >- The Model Context Protocol endpoint: use Oneprofile from Claude Code, Claude Desktop, Cursor or any other MCP client, with an API key as the bearer token. name: mcp - 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: >- 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. Alongside people and company searches, leads can be sourced from buying signals — what a company or person just did — with a catalogue endpoint behind the picker that builds them. 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 affiliate program's own dashboard: enrolling and claiming a code, the summary, stats and activity feed, the commission ledger, and identity verification and payouts. name: affiliate - 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, interest signals and social proof — plus domain-based generation and the reference documents whose summaries ride alongside those fields. name: ai-context - description: >- Endpoints for the signed-in user's Google Drive connection: starting and finishing the OAuth grant, checking or dropping it, and minting the short-lived token the Google Picker needs. name: google-drive paths: /sender-profiles/: get: tags: - senders summary: List senders operationId: list_sender_profiles parameters: - in: query name: search required: false schema: anyOf: - maxLength: 255 type: string - type: 'null' title: Search responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/SenderProfileReadSchema' title: Response List Sender Profiles type: array 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: - APIKeyHeader: [] - HTTPBearer: [] components: schemas: SenderProfileReadSchema: properties: booking_url: anyOf: - type: string - type: 'null' description: >- The link people use to book a meeting with this sender, such as a Calendly or Cal.com page. It is what the {{Sender booking link}} variable is replaced with. Null when none is set. title: Booking Url created_at: format: date-time title: Created At type: string daily_limit: default: 0 title: Daily Limit type: integer email_approval_mode: anyOf: - $ref: '#/components/schemas/EmailApprovalMode' - type: 'null' description: manual | auto; null inherits the workspace's email approval mode. first_name: default: '' title: First Name type: string id: format: uuid title: Id type: string last_name: default: '' title: Last Name type: string linkedin_connection_request_cap: default: 0 title: Linkedin Connection Request Cap type: integer linkedin_connection_requests_today: default: 0 title: Linkedin Connection Requests Today type: integer linkedin_identity: anyOf: - type: string - type: 'null' title: Linkedin Identity linkedin_photo_url: anyOf: - type: string - type: 'null' title: Linkedin Photo Url linkedin_presence: anyOf: - $ref: '#/components/schemas/LinkedInPresence' - type: 'null' mailbox_count: title: Mailbox Count type: integer name: title: Name type: string send_mode: $ref: '#/components/schemas/SenderSendMode' description: >- Whether the messages the agent writes for this sender go out on their own or wait for a person, replies included. Always send (`always_send`): the agent's messages go out on their own unless something is wrong with the words. Send when confident (`send_when_confident`, the default): they go out when the agent was confident and nothing is wrong, and wait for a person otherwise. Always ask (`always_ask`): a person approves every one. A sequence set to ask first still asks, whichever mode its senders are on. sent_today: default: 0 title: Sent Today type: integer signature_text: default: '' title: Signature Text type: string status: $ref: '#/components/schemas/SenderProfileStatus' title: description: >- The sender's job title, as their messages introduce them. It is what the {{Sender title}} variable is replaced with. Empty when none is set. title: Title type: string updated_at: format: date-time title: Updated At type: string required: - id - name - status - mailbox_count - send_mode - title - booking_url - created_at - updated_at title: SenderProfileReadSchema 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 EmailApprovalMode: description: >- Whether a sender's email steps wait in the approval queue or send on their own. F-25's per-sender override of the workspace's email approval mode. The workspace setting lives in the outreach-task domain, a layer above this one, so this enum names only the two overrides a sender can carry; the absence of one (``SenderProfileDTO.email_approval_mode`` is None) means the sender follows the workspace. enum: - manual - auto title: EmailApprovalMode type: string LinkedInPresence: description: >- How recently ANY browser connected to this sender checked in. Three states, not two, because two different questions are asked of a connection. ``ACTIVE`` answers "can a step run right now" — a browser is open and heartbeating. ``IDLE`` answers "is this still set up" — the laptop was closed for the evening. ``NOT_SEEN`` is the one that needs a person: nothing has checked in for a day, and queued work is silently waiting. enum: - active - idle - not_seen title: LinkedInPresence type: string SenderSendMode: description: >- How much of this sender's agent-written email leaves without a person. ``ALWAYS_SEND``: agent-written email steps and replies go out unattended unless a defect is found in the message itself. ``SEND_WHEN_CONFIDENT``: they go out when the agent's confidence rule holds, and a person is asked when it does not. ``ALWAYS_ASK``: every agent-written email waits for a person, whatever the agent thinks of it. The three are ordered by strictness — ALWAYS_ASK strictest, then SEND_WHEN_CONFIDENT, then ALWAYS_SEND loosest — and that order is what ``service.strictest_send_mode`` folds a cadence's assigned senders down with. The order is the point: everything that combines two modes must resolve towards asking, never towards sending. Replaces ``EmailApprovalMode``'s two-way choice, which cannot express "send the ones the agent stands behind". That enum and its column stay until a release backfills this one; do not read both in one decision. enum: - always_send - send_when_confident - always_ask title: SenderSendMode type: string SenderProfileStatus: description: >- Lifecycle of a sender. A sender is DRAFT from the moment it is created and becomes ACTIVE once at least one mailbox is attached. The status is derived from attachment, never stored — it cannot drift. enum: - draft - active title: SenderProfileStatus type: string 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: APIKeyHeader: in: header name: X-API-Key type: apiKey HTTPBearer: scheme: bearer type: http ````