> ## Documentation Index > Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt > Use this file to discover all available pages before exploring further. # Preview who an end-user notification reaches > Who a notification sent through the workspace's end-user Teams app would reach, per company. Only people who have the app in Teams can receive one; a person whose organization has the app only in its catalog is not counted. Leave out `end_company_ids` for everyone the app reaches: every linked company, then one group with `end_company_id` null for organizations linked to no company. `has_microsoft_365_tenant` false means the company is linked to no Microsoft 365 tenant, so nobody there can be reached. `shares_tenant_with` lists other companies on the same tenant: a person there who never chatted with the app goes under the first company named. `has_end_user_teams_app` false means the workspace has no active end-user Teams app, so a send is refused. Needs an admin or owner, or a member an admin gave the Send end-user notifications permission, else `403 insufficient_scope`. A triggered or scheduled agent run, with no person behind it, gets `403` too. ## OpenAPI ````yaml https://api.neoagent.io/public-api/openapi.json get /public-api/end-user-notifications/reach openapi: 3.1.0 info: description: >- Neo's public contract for the dashboard ChatAgent, partner integrations, and MSP automation. Every response is wrapped in a `{data, meta}` envelope; errors use `{error: {code, message, details?}, meta: {request_id}}`. Authenticate with a `Bearer neo_sk__` API key (service account) or a Microsoft Entra ID JWT (dashboard user). Signed-URL endpoints (end-user feedback links) take a `signature` query parameter instead. title: Neo Public API version: 1.0.0 servers: - url: https://api.neoagent.io security: [] tags: - description: Service metadata — health, OpenAPI. name: Meta - description: Agents and workflows — read, version history, delete, stats. name: Agents - description: Agent/workflow execution history, sub-resources, retry/cancel. name: Executions - description: >- Every tool call the tenant's agents made in the last 30 days, within the caller's workflow access. name: Audit Log - description: PSA webhook events and their workflow-match results. name: Callbacks - description: Technician-in-the-loop approval requests. name: TIL requests - description: RMM script executions triggered by agents. name: RMM scripts - description: Dispatch-agent field-update decisions. name: Dispatch - description: The authenticated tenant. name: Tenant - description: Agent-builder schema catalogs (raw JSON payloads). name: Schemas - description: Escalate to the Neo team (HubSpot ticket). name: Escalation - description: Tenant settings. name: Settings - description: Tenant API-key management (dashboard JWT only). name: API keys - description: End-user feedback links (signed-URL auth). name: Feedback - description: End-client companies (CRUD + bulk-update). name: End companies - description: Channels — bind a CONVERSATIONAL agent to a transport (Teams or Slack). name: Channels - description: PSA/RMM/M365 integration status and connection management. name: Integrations - description: Technician roster (controls TIL routing and paging). name: Technicians - description: Future runs queued for TRIGGERED agents. name: Scheduled work - description: Subscription state and customer-facing credit usage (no provider $). name: Billing - description: Inbox messages and announcements. name: Inbox & Comms - description: Tenant-authored agent skills (CRUD) and the built-in skill catalog. name: Skills paths: /public-api/end-user-notifications/reach: get: tags: - End-user notifications summary: Preview who an end-user notification reaches description: >- Who a notification sent through the workspace's end-user Teams app would reach, per company. Only people who have the app in Teams can receive one; a person whose organization has the app only in its catalog is not counted. Leave out `end_company_ids` for everyone the app reaches: every linked company, then one group with `end_company_id` null for organizations linked to no company. `has_microsoft_365_tenant` false means the company is linked to no Microsoft 365 tenant, so nobody there can be reached. `shares_tenant_with` lists other companies on the same tenant: a person there who never chatted with the app goes under the first company named. `has_end_user_teams_app` false means the workspace has no active end-user Teams app, so a send is refused. Needs an admin or owner, or a member an admin gave the Send end-user notifications permission, else `403 insufficient_scope`. A triggered or scheduled agent run, with no person behind it, gets `403` too. operationId: public_api.end_user_notifications_reach_get parameters: - description: >- Comma-separated `psa_company_id`s, at most 1,000. Leave out for everyone. in: query name: end_company_ids required: false schema: type: string - description: >- `true` for only people who chatted with the app in the last 90 days (default false). in: query name: only_recent_chatters required: false schema: type: boolean - description: >- `true` to list each person by name with `user_id`, for a pick (default false: counts only). in: query name: include_people required: false schema: type: boolean responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/PublicEndUserNotificationReach' meta: $ref: '#/components/schemas/SuccessMeta' required: - data - meta type: object description: Success. '400': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Bad request — malformed input. '401': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Unauthenticated — missing or invalid credentials. '403': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Forbidden — authenticated but not allowed. '404': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Not found. '409': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Conflict — the resource is in a state that blocks this operation. '422': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Request validation failed. '429': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Rate limited — see Retry-After. '500': content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Internal server error. security: - bearerAuth: [] components: schemas: PublicEndUserNotificationReach: description: >- Who a notification would reach. Only people who have the end-user app in Teams can receive one: a person whose organization has the app only in its catalog is not counted. properties: companies: items: $ref: '#/components/schemas/PublicCompanyReach' title: Companies type: array has_end_user_teams_app: title: Has End User Teams App type: boolean only_recent_chatters: title: Only Recent Chatters type: boolean total_people: title: Total People type: integer required: - has_end_user_teams_app - only_recent_chatters - total_people - companies title: PublicEndUserNotificationReach type: object SuccessMeta: properties: pagination: $ref: '#/components/schemas/Pagination' request_id: format: uuid type: string timings_ms: additionalProperties: type: number type: object warnings: description: >- Non-fatal warnings about the created/updated resource (e.g. an unhealthy PSA callback). items: type: string type: array required: - request_id - timings_ms type: object ErrorEnvelope: properties: error: properties: code: description: Stable machine-readable error code. type: string details: additionalProperties: true type: object message: type: string required: - code - message type: object meta: properties: request_id: format: uuid type: - string - 'null' type: object required: - error - meta type: object PublicCompanyReach: description: >- Who a notification reaches in one company. `end_company_id` null is the group of people whose Microsoft 365 tenant is linked to no company; it appears only when the request names no companies. properties: company_name: anyOf: - type: string - type: 'null' title: Company Name end_company_id: anyOf: - type: string - type: 'null' title: End Company Id has_microsoft_365_tenant: title: Has Microsoft 365 Tenant type: boolean people: anyOf: - items: $ref: '#/components/schemas/PublicReachablePerson' type: array - type: 'null' title: People people_count: title: People Count type: integer shares_tenant_with: items: type: string title: Shares Tenant With type: array required: - end_company_id - company_name - has_microsoft_365_tenant - shares_tenant_with - people_count - people title: PublicCompanyReach type: object Pagination: properties: has_more: type: boolean next_cursor: type: - string - 'null' required: - next_cursor - has_more type: object PublicReachablePerson: description: 'A person the end-user bot can message: they have the app in Teams.' properties: last_chat_at: anyOf: - format: date-time type: string - type: 'null' title: Last Chat At user_id: title: User Id type: string user_name: anyOf: - type: string - type: 'null' title: User Name required: - user_id - user_name - last_chat_at title: PublicReachablePerson type: object securitySchemes: bearerAuth: description: >- `Authorization: Bearer ` where `` is either a `neo_sk__` API key (service account) or a Microsoft Entra ID access token (dashboard user). scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.