> ## 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. # Draft an account's org chart > Ask AI to draft the reporting lines no source gives, from the people's titles, and name up to three likely budget holders. Free, and kept until the people change: asking again over the same people reuses the draft (200, nothing asked) rather than making one (201). A workspace has 25 free drafts a day; past that the ask is refused (409) and the chart stays as it was. Never overrides a line a rep, a table or the researcher gives. ## OpenAPI ````yaml /openapi.json post /accounts/{account_key}/org-chart/drafts/ 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 listing, checking and deleting integrations. name: integrations - description: >- Create, preview and update an integration of any type: the body's integration_type picks the config and credentials it takes. name: integration-specific - 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: >- Accounts: every company the workspace's tables name, with the people at it, its key facts, its tables, its org chart and what went to its people; the tables that feed it (Sources) and the merges a person made. name: accounts - 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: /accounts/{account_key}/org-chart/drafts/: post: tags: - accounts summary: Draft an account's org chart description: >- Ask AI to draft the reporting lines no source gives, from the people's titles, and name up to three likely budget holders. Free, and kept until the people change: asking again over the same people reuses the draft (200, nothing asked) rather than making one (201). A workspace has 25 free drafts a day; past that the ask is refused (409) and the chart stays as it was. Never overrides a line a rep, a table or the researcher gives. operationId: create_account_org_chart_draft parameters: - in: path name: account_key required: true schema: $ref: '#/components/schemas/AccountKeyPath' - description: >- Draw only this many levels of each tree, while 400 cards last, and send only the people drawn and the ones the page names. Left out, the whole chart. in: query name: levels required: false schema: anyOf: - maximum: 12 minimum: 1 type: integer - type: 'null' description: >- Draw only this many levels of each tree, while 400 cards last, and send only the people drawn and the ones the page names. Left out, the whole chart. title: Levels - description: 'With levels: people whose reports are drawn whatever their level.' in: query name: expand required: false schema: description: 'With levels: people whose reports are drawn whatever their level.' items: format: uuid type: string maxItems: 500 title: Expand type: array - description: 'With levels: a person to draw the way down to.' in: query name: focus required: false schema: anyOf: - format: uuid type: string - type: 'null' description: 'With levels: a person to draw the way down to.' title: Focus - description: 'With levels: how many people with no line either way to draw.' in: query name: loose required: false schema: default: 30 description: 'With levels: how many people with no line either way to draw.' maximum: 5000 minimum: 0 title: Loose type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/AccountChartDraftReadSchema' description: 'The draft on file was made over these same people: it was reused.' '201': content: application/json: schema: $ref: '#/components/schemas/AccountChartDraftReadSchema' 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 '404': content: application/json: schema: $ref: '#/components/schemas/NotFoundResponse' description: No account by that key in this workspace. '409': description: >- No free drafts are left. The org chart says when the next one frees up. '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/AccountDraftFailedSchema' description: The draft could not be made. '503': content: application/json: schema: $ref: '#/components/schemas/ServerErrorResponse' description: Service unavailable. security: - APIKeyHeader: [] - HTTPBearer: [] components: schemas: AccountKeyPath: description: >- The account's key: its domain (acme.com), or its LinkedIn page (li-co:acme). maxLength: 320 minLength: 1 pattern: ^(?:[^/.][^/]*|\.[^/.][^/]*|\.\.[^/]+)$ type: string AccountChartDraftReadSchema: description: What an ask for the free draft did, and the chart after it. properties: changed_person_ids: description: >- Each person whose line this draft drew new or moved, most senior first. Empty when it changed nothing, and for a reused draft. items: format: uuid type: string title: Changed Person Ids type: array chart: $ref: '#/components/schemas/AccountOrgChartSchema' dropped_person_ids: description: >- Each person whose drafted line this draft took away: the draft guessed no line for them this time, or one a person had called wrong. items: format: uuid type: string title: Dropped Person Ids type: array outcome: $ref: '#/components/schemas/AccountDraftOutcome' description: >- drafted; reused (the people had not changed, nothing was asked); capped (no free drafts left); failed (try again). required: - outcome - chart title: AccountChartDraftReadSchema 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 NotFoundResponse: properties: detail: description: The detail of why the resource was not found. title: Detail type: string required: - detail title: NotFoundResponse 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 AccountDraftFailedSchema: description: >- Why a draft could not be made: written to be read as it is, by a person or an AI. The 502's own model, not the shared ``ServerErrorResponse``: a route that documents a 5xx with a model of its own is saying its body is written to be read, so the AI Assistant relays it rather than calling the product broken (``relayable_5xx``). properties: detail: description: What happened, and that nothing on the chart changed. title: Detail type: string required: - detail title: AccountDraftFailedSchema type: object AccountOrgChartSchema: description: >- An account's org chart: every person with their line, hidden people last. properties: budget_holder_candidates: description: >- Up to three people the draft thinks may hold the budget; a rep decides. items: $ref: '#/components/schemas/AccountBudgetCandidateReadSchema' title: Budget Holder Candidates type: array draft_current: description: Whether the draft was made over the people shown now. title: Draft Current type: boolean draft_guesses: default: 0 description: >- Of the people a draft reads, those with no confirmed line: the ones it guesses a line for. title: Draft Guesses type: integer draft_reads: default: 0 description: >- People a draft reads: the most senior shown, up to 150. Past that, the more junior are left out. title: Draft Reads type: integer drafted_at: anyOf: - format: date-time type: string - type: 'null' description: When the free draft was made, if ever. title: Drafted At drafts_left: description: Free drafts left in the rolling 24 hours. title: Drafts Left type: integer drafts_reset_at: anyOf: - format: date-time type: string - type: 'null' description: When the next free draft frees up, once none is left. title: Drafts Reset At likely_lines: default: 0 description: >- Lines drawn from the draft now, each Likely until a person confirms it: GET /accounts/{account_key}/org-chart/drafted-lines/ lists them. title: Likely Lines type: integer loops: description: >- Each loop of reporting lines no person has decided (the tables', the researcher's, or lines people set that a merge brought together): the chart leaves one of its lines out. A person picks one by setting a person's manager (PATCH /accounts/{account_key}/people/{person_id}/); in a loop of lines people set, the others are handed back first (manager_choice null), as a line to them would loop. items: $ref: '#/components/schemas/AccountChartLoopReadSchema' title: Loops type: array lost: description: >- Each role or line a rep set whose person is no longer at the account, newest first. What the rep set is kept, and comes back if the person does. items: $ref: '#/components/schemas/AccountChartLossReadSchema' title: Lost type: array manager_offers: description: >- Each people table here with a column labelled like a manager (Manager, Reports to) that is not its manager column yet. Nothing is drawn from it until a person picks it: PATCH /accounts/sources/{table_id}/ with manager_column_id. items: $ref: '#/components/schemas/AccountManagerColumnOfferReadSchema' title: Manager Offers type: array people: items: $ref: '#/components/schemas/AccountChartPersonReadSchema' title: People type: array top_person_id: anyOf: - format: uuid type: string - type: 'null' description: >- The account's top person when no line says so yet: the head of the biggest tree, with no line of their own (none drawn, none left out for a loop) and no other person at the top of the chart as senior. The page reads them as Top of the account. title: Top Person Id tree_heads: description: >- Each person heading a tree (no manager drawn, someone under them), the most people under them first: the order the chart lists its trees in. Hidden people are never counted. With levels, only the heads this answer sends. items: format: uuid type: string title: Tree Heads type: array window: anyOf: - $ref: '#/components/schemas/AccountChartWindowReadSchema' - type: 'null' description: 'With levels: the part of the chart sent. None: all of it.' required: - people - budget_holder_candidates - drafted_at - draft_current - drafts_left - drafts_reset_at - lost title: AccountOrgChartSchema type: object AccountDraftOutcome: description: What one ask for the free draft did. enum: - drafting - drafted - reused - capped - failed title: AccountDraftOutcome 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 AccountBudgetCandidateReadSchema: description: One person the draft thinks may hold the budget. properties: person_id: format: uuid title: Person Id type: string reason: title: Reason type: string required: - person_id - reason title: AccountBudgetCandidateReadSchema type: object AccountChartLoopReadSchema: description: >- Lines the sources state that loop back on themselves, for a person to pick from. properties: steps: description: >- The loop's lines in turn, each manager the next one's person, the last back to the first. The chart draws every line but the first. items: $ref: '#/components/schemas/AccountChartLoopStepReadSchema' title: Steps type: array required: - steps title: AccountChartLoopReadSchema type: object AccountChartLossReadSchema: description: >- A rep's word on the chart that lost its person: what it said, and where they are now. properties: can_return: description: Whether what was set comes back if a row names them here again. title: Can Return type: boolean cause: $ref: '#/components/schemas/AccountChartLossCause' description: >- moved: their row now names another company (now_at_key, when it is found); table_off: their table no longer feeds Accounts; table_trashed: their table is in the Trash; replaced: their row is still here but names someone else now; row_deleted: their row is gone; not_found: no row puts them here, and none was kept to say why. kind: $ref: '#/components/schemas/AccountChartLossKind' description: >- person: the person a rep gave a role or a line to is no longer at the account. manager: the manager a rep said someone reports to is no longer at the account; their line falls back to the chart's own sources meanwhile. name: anyOf: - type: string - type: 'null' description: Their name when the rep set it, if known. title: Name now_at_key: anyOf: - type: string - type: 'null' description: 'With moved: the account their rows put them at.' title: Now At Key now_at_name: anyOf: - type: string - type: 'null' description: That account's name. title: Now At Name person_key: description: The person who is gone, as forget takes them. title: Person Key type: string role: anyOf: - $ref: '#/components/schemas/AccountPersonRole' - type: 'null' description: The part the rep said they play, with kind person. subject_person_id: anyOf: - format: uuid type: string - type: 'null' description: 'With kind manager: the person on the chart whose line named them.' title: Subject Person Id required: - kind - person_key - name - role - subject_person_id - cause - now_at_key - now_at_name - can_return title: AccountChartLossReadSchema type: object AccountManagerColumnOfferReadSchema: description: >- A people table's column the chart could be drawn from, once a person picks it. properties: column_id: format: uuid title: Column Id type: string column_name: title: Column Name type: string table_id: format: uuid title: Table Id type: string table_name: title: Table Name type: string required: - table_id - table_name - column_id - column_name title: AccountManagerColumnOfferReadSchema type: object AccountChartPersonReadSchema: description: One person on the chart, the line drawn for them, and what reps set. properties: edited_at: anyOf: - format: date-time type: string - type: 'null' title: Edited At edited_by_user_id: anyOf: - type: string - type: 'null' title: Edited By User Id hidden: description: Whether a rep hid them from the chart. title: Hidden type: boolean hidden_reason: anyOf: - $ref: '#/components/schemas/AccountHiddenReason' - type: 'null' description: >- With hidden: why. left: they left the company; wrong_person: the row is not someone at this company; not_relevant: here, but not part of the deal. Null when shown, or when no reason was given. line: anyOf: - $ref: '#/components/schemas/AccountChartLineReadSchema' - type: 'null' description: The line drawn; None when no source gives one. other_lines: description: What weaker sources say, where they name a different manager. items: $ref: '#/components/schemas/AccountChartLineReadSchema' title: Other Lines type: array person: $ref: '#/components/schemas/AccountPersonReadSchema' role: anyOf: - $ref: '#/components/schemas/AccountPersonRole' - type: 'null' description: Their part in a deal, as a rep set it. role_set_at: anyOf: - format: date-time type: string - type: 'null' description: When the role was set. title: Role Set At role_set_by_user_id: anyOf: - type: string - type: 'null' description: Who set the role, when one is set. title: Role Set By User Id required: - person - line - other_lines - role - hidden - edited_by_user_id - edited_at - role_set_by_user_id - role_set_at title: AccountChartPersonReadSchema type: object AccountChartWindowReadSchema: description: The part of a chart sent when only part was asked for (``levels``). properties: focus_path: description: 'With focus: the way down to them, from the top of their tree.' items: format: uuid type: string title: Focus Path type: array loose_count: description: 'People with no line either way: no manager, no reports.' title: Loose Count type: integer loose_shown: description: How many of those are drawn. title: Loose Shown type: integer reports: additionalProperties: type: integer description: >- How many report to each drawn person, drawn or not, for each who has any. propertyNames: format: uuid title: Reports type: object shown: description: >- The people drawn, top down. people also holds the ones the page names elsewhere: the hidden, role holders, the draft's candidates, a lost line's subject. items: format: uuid type: string title: Shown type: array top_count: description: 'People at the top of a tree: no manager, some reports.' title: Top Count type: integer top_shown: description: How many of those are drawn. title: Top Shown type: integer visible_count: description: Everyone on the chart who is not hidden. title: Visible Count type: integer required: - shown - reports - visible_count - loose_count - loose_shown - top_count - top_shown - focus_path title: AccountChartWindowReadSchema type: object AccountChartLoopStepReadSchema: description: >- One line of a loop: a person, and the manager a source says they report to. properties: manager_id: format: uuid title: Manager Id type: string manager_name: anyOf: - type: string - type: 'null' title: Manager Name name: anyOf: - type: string - type: 'null' title: Name person_id: format: uuid title: Person Id type: string source: $ref: '#/components/schemas/AccountLineSource' description: Who states the line. table_id: anyOf: - format: uuid type: string - type: 'null' description: The table that states it, for a table's line. title: Table Id table_name: anyOf: - type: string - type: 'null' description: That table's name. title: Table Name required: - person_id - name - manager_id - manager_name - source - table_id - table_name title: AccountChartLoopStepReadSchema type: object AccountChartLossCause: description: Why someone a rep placed is no longer on the account. enum: - moved - table_off - table_trashed - replaced - row_deleted - not_found title: AccountChartLossCause type: string AccountChartLossKind: description: >- Whom a rep's word on the chart lost: the person it was about, or the manager it named. enum: - person - manager title: AccountChartLossKind type: string AccountPersonRole: description: 'The part a rep says a person plays in a deal. None: not known.' enum: - champion - budget_holder - decision_maker - influencer - user - blocker title: AccountPersonRole type: string AccountHiddenReason: description: 'Why a rep hid a person from the chart (review AC-33). None: not said.' enum: - left - wrong_person - not_relevant title: AccountHiddenReason type: string AccountChartLineReadSchema: description: One reporting line, and where it came from. properties: column_id: anyOf: - format: uuid type: string - type: 'null' description: The column that states it, for a table's line. title: Column Id confidence: $ref: '#/components/schemas/AccountLineConfidence' description: Confirmed when a source states it; likely when the draft guessed it. loops: default: false description: >- On a line not drawn: drawing it would close a loop, so the chart leaves it out. The chart's loops name each one a person has not decided. title: Loops type: boolean manager_id: anyOf: - format: uuid type: string - type: 'null' description: >- The manager's person id; None at the top of the chart, or for a manager not on this account. title: Manager Id manager_name: anyOf: - type: string - type: 'null' description: A manager not on this account, as the source wrote them. title: Manager Name reason: anyOf: - type: string - type: 'null' description: The draft's reason, for a likely line. title: Reason set_at: anyOf: - format: date-time type: string - type: 'null' description: 'With a rep''s line: when it was set.' title: Set At set_by_user_id: anyOf: - type: string - type: 'null' description: 'With a rep''s line: who set it.' title: Set By User Id source: $ref: '#/components/schemas/AccountLineSource' description: >- Who gave it: a rep, a table's manager column, the Person researcher, or the free draft. table_id: anyOf: - format: uuid type: string - type: 'null' description: The table that states it, for a table's line. title: Table Id required: - source - confidence - manager_id - manager_name - reason - table_id - column_id - set_by_user_id - set_at title: AccountChartLineReadSchema type: object AccountPersonReadSchema: description: One person at the account, once however many rows name them. properties: data_at: description: 'How old what is shown is: when their title last changed.' format: date-time title: Data At type: string department: anyOf: - $ref: '#/components/schemas/AccountDepartment' - type: 'null' description: The department their title names, read off its words; null if none. email: anyOf: - type: string - type: 'null' title: Email email_status: anyOf: - $ref: '#/components/schemas/AccountEmailStatus' - type: 'null' description: >- What is known of their address: the verdict of the Verify email column over it, or `bounced`; null when nothing checked it. enrolments: items: $ref: '#/components/schemas/AccountPersonEnrolmentReadSchema' title: Enrolments type: array id: description: 'The person''s id: what a URL or an edit names them by.' format: uuid title: Id type: string key: description: 'The person''s key: their LinkedIn profile, else their address.' title: Key type: string last_contacted_at: anyOf: - format: date-time type: string - type: 'null' title: Last Contacted At linkedin_url: anyOf: - type: string - type: 'null' title: Linkedin Url matched_on: $ref: '#/components/schemas/AccountKeyKind' description: >- What put them on this account: their company's website, its LinkedIn page, or their work address. name: anyOf: - type: string - type: 'null' title: Name namesake_count: description: How many others at the account go by the same name, all of them. title: Namesake Count type: integer namesakes: description: >- The others at the account going by the same name, likely the same first, at most 10; their address or profile tells them apart. items: $ref: '#/components/schemas/AccountNamesakeReadSchema' title: Namesakes type: array replied_at: anyOf: - format: date-time type: string - type: 'null' title: Replied At role: anyOf: - $ref: '#/components/schemas/AccountPersonRole' - type: 'null' description: The part a rep says they play in a deal, set on the org chart. seniority: anyOf: - $ref: '#/components/schemas/AccountSeniority' - type: 'null' description: >- How senior their title says they are, read off its words; null with no title. `other` is a title with no rank word. sources: items: $ref: '#/components/schemas/AccountPersonSourceReadSchema' title: Sources type: array title: anyOf: - type: string - type: 'null' title: Title required: - id - key - name - title - email - linkedin_url - matched_on - data_at - last_contacted_at - replied_at - sources - enrolments - seniority - department - email_status - role - namesakes - namesake_count title: AccountPersonReadSchema type: object AccountLineSource: description: Where a reporting line came from. enum: - rep - table - research - draft title: AccountLineSource type: string AccountLineConfidence: description: >- How sure a line is: stated somewhere (confirmed), or the draft's guess (likely). enum: - confirmed - likely title: AccountLineConfidence type: string AccountDepartment: description: >- The part of a company a person's title names (review AC-12). None: it names none. Read off the title's words by a fixed rule (``org_chart.title_department``). enum: - sales - marketing - customer_success - product - design - engineering - data - it - security - finance - people - operations - legal title: AccountDepartment type: string AccountEmailStatus: description: >- What is known of a person's address (review AC-12). None: nothing checked it. The verdict of the Verify email column over the address on their row, the words that column writes; BOUNCED when an email to them bounced, whatever a check said. enum: - valid - catch_all - risky - unknown - invalid - disposable - bounced title: AccountEmailStatus type: string AccountPersonEnrolmentReadSchema: properties: bounced: description: Whether an email to the person bounced. title: Bounced type: boolean enrolment_id: format: uuid title: Enrolment Id type: string failure_code: anyOf: - $ref: '#/components/schemas/EnrolmentFailureCode' - type: 'null' description: What failed, on a failed enrolment only. last_sent_at: anyOf: - format: date-time type: string - type: 'null' title: Last Sent At replied_at: anyOf: - format: date-time type: string - type: 'null' title: Replied At sequence_id: format: uuid title: Sequence Id type: string sequence_name: title: Sequence Name type: string status: $ref: '#/components/schemas/EnrolmentStatus' stop_reason: anyOf: - $ref: '#/components/schemas/StopReason' - type: 'null' description: Why a stopped enrolment stopped, such as a reply; null otherwise. required: - enrolment_id - sequence_id - sequence_name - status - last_sent_at - replied_at - stop_reason - bounced - failure_code title: AccountPersonEnrolmentReadSchema type: object AccountKeyKind: description: Which value of a row named its account. enum: - website - company_page - email_domain title: AccountKeyKind type: string AccountNamesakeReadSchema: description: Another person at the account going by the same name (review AC-19). properties: email: anyOf: - type: string - type: 'null' title: Email id: description: Their person id. format: uuid title: Id type: string kind: $ref: '#/components/schemas/AccountNamesake' description: >- `likely_same`: nothing tells the two apart, so they are likely one person found twice (a merge often leaves them). `same_name`: each has a LinkedIn profile of their own, or the name is short of a full one (one word, or a lone letter). linkedin_url: anyOf: - type: string - type: 'null' title: Linkedin Url required: - id - email - linkedin_url - kind title: AccountNamesakeReadSchema type: object AccountSeniority: description: >- How senior a person's title says they are (review AC-12). None: no title. Read off the title's words by a fixed rule (``org_chart.title_seniority``): a title with no rank word in it is OTHER, never guessed at. enum: - executive - vp - head - director - manager - senior - other title: AccountSeniority type: string AccountPersonSourceReadSchema: properties: record_id: format: uuid title: Record Id type: string table_id: format: uuid title: Table Id type: string table_name: title: Table Name type: string required: - table_id - table_name - record_id title: AccountPersonSourceReadSchema type: object EnrolmentFailureCode: description: >- Which kind of failure stopped a FAILED contact, where the product treats one differently. Stored beside ``failure_reason`` and cleared with it. Most failures carry no code: Retry runs the step that broke again. ``CONNECTED_BEFORE_WITHDRAW`` is a Withdraw that found the person already connected: there is nothing to withdraw and nothing to retry, so no Retry offers it. ``INVITE_LOOK_UNREADABLE`` is the profile look a connection request queued to learn its answer, which could not read the relationship: Retry queues a fresh look rather than sending the request again. ``MISSING_VALUES`` is a Browser use step the contact lacked a value for. enum: - connected_before_withdraw - invite_look_unreadable - missing_values title: EnrolmentFailureCode type: string EnrolmentStatus: description: >- Where one contact stands in one sequence. ACTIVE rows carry a ``due_at`` and are what the tick claims; CLAIMED is the in-flight guard between claim and outcome. PAUSED is a deliberate per-contact hold: unclaimable because the tick claims strictly on ACTIVE, yet still LIVE. It keeps its step and its one-live-sequence slot, and a compliance stop (reply, unsubscribe) reaches it. Everything else is settled: COMPLETED walked off the end; STOPPED was halted (reply, unsubscribe, bounce, manual, company pause); FAILED is terminal; SUPPRESSED was on the do-not-contact list; SKIPPED_DUPLICATE lost the one-live-sequence-per-contact rule, with the reason visible in the grid. A contact the workspace's recontact rule refuses is STOPPED with ``StopReason.COOLDOWN``. There is deliberately no held state: a cooldown settles a contact rather than parking them, so nothing here waits on a date and nothing lets itself out later. AWAITING_ACTION is a contact parked behind a task that needs a person or a channel, modelled on PAUSED: live, keeps its step and its one-live-sequence slot, unclaimable because the tick claims strictly on ACTIVE, and a compliance stop reaches it. Unlike PAUSED nobody wakes it by hand: only the outreach-task sweep does, once the task it waits on is decided or delivered. Deliberately not "awaiting approval": an AUTO-mode LinkedIn park is waiting for a browser rather than for anyone's approval, and this value is the word the Contacts tab shows for both. PENDING is a draft's roster: in, standing on a step, and NOT live. Binding an audience enrols on the spot so the Contacts tab can show who is in, but a sequence nobody has launched must not hold anybody's one-live-sequence slot, or a second sequence written for the same people skips them all. ``uq_sequence_enrolment_one_live`` leaves PENDING out, the tick never claims it, and launch turns each row ACTIVE, settling the ones another sequence took meanwhile as SKIPPED_DUPLICATE. enum: - pending - active - claimed - paused - awaiting_action - completed - stopped - failed - suppressed - skipped_duplicate title: EnrolmentStatus type: string StopReason: enum: - reply - unsubscribe - bounce - manual - company_reply - row_left_audience - row_left_paused - step_removed - removed - cooldown - rejected - mailbox_removed - unread_reply - declined - trashed - trashed_paused title: StopReason type: string AccountNamesake: description: >- What another person at the account going by the same name is to someone (review AC-19). Names match as their words, case, accents and punctuation gone. LIKELY_SAME: a full name (two words or more, none a lone letter) and nothing tells them apart (at most one of them has a LinkedIn profile), so they are likely one person found twice, as a merge leaves them. SAME_NAME: each has a LinkedIn profile of their own, so they are two people, or the name is short of a full one, which says too little. A placeholder ("LinkedIn Member") is no name, and names no namesakes. enum: - likely_same - same_name title: AccountNamesake type: string 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.