> ## 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. # Count mailboxes > How many mailboxes match the filters the list takes. ## OpenAPI ````yaml /openapi.json get /mailboxes/length/ 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 spend 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: >- AI apps connected to the workspace: Claude, ChatGPT, Claude Code or any other MCP client a person signed in to Oneprofile's MCP server with. name: ai_apps - 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 an agent's Preview: example rows run one at a time, and a Looks good on each. Needs work lives under agent-learnings. name: agent-training - description: >- An agent's learnings, the one-line rules it follows on every output, and the thumbs down that teaches them: give one with what was wrong, list the ones on a subject, Undo one, and price the redo it would run. name: agent-learnings - 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 recording where a new workspace came from: the marketing page or campaign its signup link carried, sent once after signup. name: attribution - 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: /mailboxes/length/: get: tags: - senders summary: Count mailboxes description: How many mailboxes match the filters the list takes. operationId: get_mailboxes_count parameters: - in: query name: search required: false schema: anyOf: - maxLength: 320 type: string - type: 'null' description: Narrow to addresses matching this text. title: Search description: Narrow to addresses matching this text. - description: >- The stored grant state. `connected` means anything that is not broken, which includes a grant nobody has checked yet. in: query name: connection_status required: false schema: anyOf: - $ref: '#/components/schemas/MailboxConnectionStatus' - type: 'null' description: >- The stored grant state. `connected` means anything that is not broken, which includes a grant nobody has checked yet. title: Connection Status - description: >- The three-way split the Status column draws: `verified` passed its latest check, `connected` has not passed one yet or its latest check got a definite error back that was not a refusal, `disconnected` was refused. in: query name: health required: false schema: anyOf: - $ref: '#/components/schemas/MailboxHealth' - type: 'null' description: >- The three-way split the Status column draws: `verified` passed its latest check, `connected` has not passed one yet or its latest check got a definite error back that was not a refusal, `disconnected` was refused. title: Health - description: Narrow to one mail provider. in: query name: provider required: false schema: anyOf: - $ref: '#/components/schemas/MailboxProvider' - type: 'null' description: Narrow to one mail provider. title: Provider - in: query name: sender_profile_id required: false schema: anyOf: - format: uuid type: string - type: 'null' description: Narrow to the mailboxes carrying one sender. title: Sender Profile Id description: Narrow to the mailboxes carrying one sender. - description: Narrow to mailboxes that sent on their sender's today or yesterday. in: query name: sent_on required: false schema: anyOf: - $ref: '#/components/schemas/SentOn' - type: 'null' description: >- Narrow to mailboxes that sent on their sender's today or yesterday. title: Sent On responses: '200': content: application/json: schema: $ref: '#/components/schemas/MailboxCountSchema' 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: MailboxConnectionStatus: description: Whether the mailbox's grant currently authenticates. enum: - connected - disconnected title: MailboxConnectionStatus type: string MailboxHealth: description: >- The three states the Status column draws, as one filterable value. DERIVED, never stored: it folds ``connection_status`` together with whether ``last_verified_at`` holds a stamp. A mailbox nobody has checked since it connected and one checked this morning are different answers to "is this grant still good?", and the ops screen has to be able to ask for either. Deliberately NOT members of :class:`MailboxConnectionStatus`. That enum is the stored column type and the value on every mailbox response, and eleven places in the domain compare against ``CONNECTED`` by identity. A third member there would put a value on the wire that no row can hold and would silently weaken every one of those checks. Two callers also already send ``connection_status=connected`` meaning "not broken" (the send-a-test picker and the notification settings page), and they must keep that meaning. enum: - verified - connected - disconnected title: MailboxHealth type: string MailboxProvider: description: >- Which email provider a mailbox connects through. Only Google Workspace ships so far; every provider is implemented behind ``providers.EmailProviderBase`` so Office 365 and IMAP/SMTP can be added later without touching callers. ``GOOGLE_WORKSPACE`` holds a per-mailbox OAuth grant (consent screen, refresh token). ``GOOGLE_WORKSPACE_DWD`` holds no grant at all: tokens are minted on demand via domain-wide delegation as the platform service account, so its rows carry an empty ``refresh_token`` forever. It is the path imported fleets (e.g. InboxKit) connect through. enum: - google_workspace - google_workspace_dwd title: MailboxProvider type: string SentOn: description: >- Which of a mailbox's days the Mailboxes grid narrows to: its sender's today or yesterday. enum: - today - yesterday title: SentOn type: string MailboxCountSchema: properties: count: title: Count type: integer required: - count title: MailboxCountSchema 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 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 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.