1. API reference
  2. Workflows
  3. Check a workflow definition
Open Specter
  • Overview
  • GETRead the board
  • POSTAdd rows
  • GETList your jobs
  • POSTDeclare a job's files
  • POSTStart a job
  • GETGet a job
  • GETList a deal's files
  • POSTAdd a file to a deal
  • POSTProcess a deal
  • GETGet a deal's latest job
  • GETGet a deal's findings
  • GETGet a deal's financials
  • GETList the custom boards
  • POSTMake a board
  • POSTCopy a board or a page into a new board
  • POSTImport rows into a board
  • POSTImport a spreadsheet onto a board, mapping it for you
  • POSTRead the cells an import column could not, with the model
  • GETRead one board, whole
  • DELETEDelete a board and everything on it
  • PATCHRename a board or switch its view to table or kanban
  • PATCHWrite many rows' cells at once
  • POSTPreview board transfer mappings
  • GETRead a board's workspace access
  • PUTSet a board's workspace access
  • GETThe buttons on a board's action bar
  • POSTAdd a button to a board's action bar
  • PUTReorder a board's action bar
  • DELETERemove a board's action button
  • PATCHChange a board's action button
  • GETIngestion keys minted on a board
  • POSTMint an ingestion key for a board
  • DELETERevoke a board's ingestion key
  • GETWhat one board key has done lately
  • GETWhich columns are locked on a board
  • GETWhat this caller gets on a board
  • PUTLock a column on a board
  • DELETEUnlock a column on a board
  • POSTAdd a column to a board
  • PUTReorder a board's columns
  • DELETETake a column off a board
  • PATCHRename or reconfigure a board column
  • PUTChoose the figure the calculations strip shows under a board column
  • PUTSet a board column's formula expression
  • POSTAdd a choice to a board's select column
  • PUTReorder a board column's choices
  • DELETERemove a choice from a board column
  • PATCHChange a dropdown choice's colour, group or label
  • GETWho else can reach this board
  • PUTShare a board with a colleague
  • DELETEStop sharing a board
  • GETBoard import history
  • POSTRecord a board import run
  • POSTUndo a board import
  • GETRead a page of a board's rows
  • POSTAdd a row to a board
  • POSTAct on every board record a filter matches
  • POSTDelete records from a board
  • PATCHChange one board record's cells
  • GETFiles pinned to one board record
  • POSTAttach a file to a board record
  • POSTDuplicate or move a board record safely
  • GETSaved views on a board
  • POSTSave a view on a board
  • PUTReorder a board's saved views
  • DELETEDelete a saved board view
  • PATCHChange a saved board view
  • GETRead the lenders a capital source backs
  • GETList the pages (leads, deals, merchants, lenders, contacts, tasks…) and their keys
  • GETRead a page's definition: its columns, statuses and roles
  • PATCHChange definitions key
  • GETSum, count or average a page's records
  • POSTSet who a page is shown to
  • PATCHWrite many records' cells at once
  • GETList the child pages a page accepts
  • PUTDeclare the child pages a page accepts
  • POSTCreate definitions key credit-memos id transition
  • DELETEDelete a credit record
  • GETRead a page's filter facets
  • GETList a page's record names
  • POSTPull the next record from a work queue
  • GETWho wrote last on each record
  • GETRead what this page's moves ask for
  • PUTSet what one move asks for
  • GETRead a pack page's workspace access
  • PUTSet a pack page's workspace access
  • GETList a page's row actions
  • POSTAdd a row action to a page
  • PUTReorder a page's row actions
  • DELETERemove a row action from a page
  • PATCHChange definitions key actions actionId
  • GETRead definitions key api-keys
  • POSTCreate definitions key api-keys
  • DELETERemove definitions key api-keys keyId
  • GETWhat one page API key has done lately
  • GETRead a page's column locks
  • GETRead the column locks in force for the caller
  • PUTLock or unlock a column
  • DELETEClear a column's lock
  • POSTAdd a column to a page
  • PUTReorder a page's columns
  • DELETERemove a column from a page
  • PATCHChange definitions key columns columnId
  • PUTChoose the figure the calculations strip shows under a page column
  • POSTAdd choices to a page's select column
  • PUTReorder a page column's choices
  • DELETERemove a choice from a page's column
  • PATCHRelabel or recolour one choice on a page
  • GETList relationships on this page
  • POSTName a relationship
  • DELETEDissolve a relationship
  • PATCHRename a relationship or set its principal
  • GETRead a relationship's members
  • POSTPut records into a relationship
  • DELETETake one record out of a relationship
  • GETWho is held back on a pack page
  • PUTHold a member back on a pack page
  • DELETEGive a member a pack page back
  • GETList a page's record groups
  • POSTCreate a record group on a page
  • POSTMove records between groups
  • POSTTake records out of their groups
  • DELETEDelete a record group
  • PATCHRename, recolour or file a record group
  • GETList the records in a group
  • POSTAdd records to a group
  • POSTRemove records from a group
  • POSTImport rows into a page
  • POSTImport a spreadsheet, mapping it for you
  • POSTImport rows as a job
  • GETRead an import job's progress
  • GETList a page's imports
  • POSTImport a spreadsheet into a page
  • POSTUndo an import batch
  • GETList or search a page's records
  • POSTCreate a record on a page (lead, deal, merchant, lender, contact, task)
  • POSTAct on many records at once — by filter or by ids
  • POSTAdopt a shared record onto this page
  • POSTAssign one person to many records
  • GETPick the next assignee in a rotation
  • POSTAdd or remove people on many records
  • POSTUpdate many records at once
  • POSTDelete records from a page
  • GETLeads due today
  • GETCount a page's records by column value
  • POSTTake in a new lead from a form or a call
  • POSTOnboard a lead
  • GETRead one record
  • PATCHChange definitions key rows rowId
  • POSTReveal an authorized account number
  • GETList what can be done to a record
  • GETRead a record's activity feed
  • GETRead a deal's AI insights
  • POSTRegenerate a deal's AI insights
  • POSTRun business research on a deal
  • GETRead a lender's API connection
  • PUTConnect a lender's API
  • DELETEDisconnect a lender's API
  • POSTArchive a record
  • PUTPut one person in a role on a record
  • POSTEmail whoever holds a role on a deal
  • POSTPreview the email to a deal's role holder
  • GETRead who is assigned to a record, by role
  • PUTSet who holds a role on a record
  • POSTPut one person on a role on a record
  • DELETETake one person off a role on a record
  • GETList a record's bank statements
  • POSTClose a deal
  • GETHow this deal ended
  • POSTDraw up a deal's contract
  • GETList a deal's contract documents
  • POSTAdd a document to a deal's contract
  • POSTSend the contract for signature
  • GETList a deal's signature requests
  • GETRead the signed contract
  • POSTConvert a lead into a deal
  • GETRead a deal's credit records
  • POSTRecord a credit record
  • GETList a record's credit reports
  • GETList a record's debt schedules
  • POSTAdd a debt schedule to a record
  • PATCHChange definitions key rows rowId debt-schedules scheduleId
  • POSTCreate definitions key rows rowId debt-schedules scheduleId issue
  • GETRead one record in full: cells, people, files, activity
  • GETRead a submission's financing disclosure
  • POSTGenerate a submission's financing disclosure
  • GETList a record's document analyses
  • GETList the documents requested from a record
  • POSTRequest documents from a record's contact
  • GETRead a deal's document checklist
  • PUTSet a document's standing on a deal
  • GETRead a record's merged feed
  • PUTReact to a feed item
  • DELETERemove a reaction from a record's feed
  • GETList a record's files
  • POSTAttach a file to a record
  • PUTFile a document into a folder
  • GETRead a record's financials
  • GETList a record's document folders
  • POSTCreate a document folder
  • DELETEDelete an empty document folder
  • PATCHRename or move a document folder
  • PUTFollow a record
  • DELETEUnfollow a record
  • POSTMint a form link for a record
  • POSTFund a deal
  • GETRead a record's health score
  • GETList the heartbeat's proposed actions for a record
  • GETRead a record's intake conflicts
  • POSTAccept an intake conflict
  • POSTReject an intake conflict
  • GETRead this deal's lender recommendations
  • GETList the lenders eligible for a deal
  • GETRead a deal's lifecycle stage
  • GETRead a record's links, both ways
  • POSTMatch and connect records
  • GETList the invitations sent to a merchant
  • POSTInvite a merchant to their portal
  • DELETEWithdraw a merchant invitation
  • GETList a record's notes
  • POSTAdd a record note
  • PATCHEdit a record note
  • GETList a deal's offers
  • POSTAdd an offer to a deal
  • POSTFinish a bank link for a deal
  • GETA deal's (or merchant's) linked banks
  • DELETEUnlink a bank from a deal
  • POSTCheck an expected bank payment
  • POSTRequest fresh bank transactions
  • POSTSync one merchant bank
  • POSTSearch imported bank transactions
  • POSTStart a bank link for a deal
  • GETRead merchant monthly monitoring
  • PUTSet merchant monthly monitoring
  • POSTPull a deal's linked banks
  • GETList a record's prefilled links
  • POSTMint a prefilled form link to copy
  • DELETERevoke a prefilled link
  • POSTProcess a record's documents
  • GETRead a record's document-processing status
  • POSTRecord feedback on a processed financial metric
  • POSTReactivate an archived record
  • GETList a record's related records
  • GETRead a record's call script
  • DELETERemove a record's call script
  • POSTAsk for help with a record's call script
  • POSTGenerate a call script for a record
  • POSTSeat one team on a record
  • GETSigning requests on a record
  • GETList a record's e-signature events
  • GETRead one record's SLA state
  • POSTSnooze a lead
  • GETList a record's statements
  • POSTChange a record's status
  • GETRead a record's status history
  • POSTRequest stipulations
  • GETRead saved deal submission notes
  • PUTSave deal submission notes
  • GETList the form answers filed on a record
  • GETRead contract request review context
  • GETList lender mailer operations
  • POSTQueue a lender submission email action
  • POSTReconcile an uncertain lender mailer operation
  • POSTSubmit one deal to many lenders
  • GETList a record's subrecords
  • POSTAttach or create a subrecord
  • DELETEDetach a subrecord
  • GETRead a record's Super KYC links
  • POSTCreate a Super KYC link
  • GETRead a Super KYC link's findings
  • DELETEStop a Super KYC link
  • POSTAcknowledge a Super KYC finding
  • GETList the bank transactions behind a Super KYC link
  • GETList a record's tax returns
  • GETList a record's discussion threads
  • POSTStart a discussion thread on a record
  • POSTMove a deal's status
  • GETWhat a move needs first
  • GETRead a deal's underwriting result
  • POSTRun underwriting on a deal
  • POSTEvaluate a deal against the published rules
  • GETList a deal's rule evaluations
  • GETRead one rule evaluation
  • GETList the rule namespace for a deal
  • GETRead a record's vendor slots
  • PUTName the vendor for one slot
  • DELETEEmpty one vendor slot
  • GETList a page's call scripts
  • POSTAdd a call script to a page
  • DELETERemove a call script from a page
  • PATCHChange definitions key scripts scriptId
  • POSTAdd a status to a page
  • PUTReorder a page's statuses
  • DELETERemove a status from a page
  • PATCHChange a status's colour, group or tab, or archive it
  • GETRead a discussion thread
  • DELETEDelete a thread
  • PATCHChange definitions key threads threadId
  • GETList a thread's messages
  • POSTPost a message on a thread
  • DELETEDelete a thread message
  • PATCHChange definitions key threads threadId messages messageId
  • POSTPin a thread message
  • GETList who is on a thread
  • POSTAdd someone to a thread
  • DELETETake someone off a thread
  • POSTMark a thread read
  • POSTResolve a thread
  • PATCHChange definitions key underwriting id
  • PUTSet an underwriting rule set's criteria
  • POSTEvaluate a deal against an underwriting rule set
  • POSTSave a view of a page
  • DELETEDelete a saved view
  • PATCHChange definitions key views viewId
  • GETThe workspace's forms
  • POSTBuild a form
  • POSTMake a form for a board
  • GETRead one form
  • DELETEDelete a form and its answers
  • PATCHChange a form
  • GETForm analytics
  • GETWhere this form lives on the web
  • POSTPublish a form
  • GETWho has their own link to a form
  • POSTGive people their own link to a form
  • DELETETurn off a person's form link
  • PATCHHand a form link to somebody else
  • GETThe applications one form took
  • GETThe visit that filed one application
  • GETWhat people filed through one form
  • POSTMint a correction link for one submission
  • GETWhich correction links stand open
  • DELETERevoke an edit link
  • POSTUnpublish a form
  • GETEveryone who visited one form
  • POSTCheck a business for ISO conflicts
  • POSTRun an ISO conflict check
  • GETRead the ISO network roster
  • GETLead snapshot
  • GETList every lender and how a submission reaches it
  • GETList the lenders linked to a Specter workspace
  • PUTLink a lender record to its Specter workspace
  • DELETEUnlink a lender record from its Specter workspace
  • GETLender analytics
  • POSTInstall a pack
  • GETThe score bands offers are priced against
  • GETFind a record by name
  • GETList the deals sent to lenders through Specter
  • POSTSend one deal to one lender
  • GETLender decision rates for deals sent through Specter
  • POSTSubmit a deal to several lenders at once
  • POSTMove a submission to a lender
  • GETRead table-preferences
  • GETRead table-preferences tableKey
  • PUTReplace table-preferences tableKey
  • DELETERemove table-preferences tableKey
  • GETRead the blasts
  • POSTCompose a blast to many people
  • GETList the merge fields a blast can use
  • GETRead blast statistics
  • PATCHChange a blast's words
  • POSTAdd people to a blast's audience
  • POSTAim a blast at a board
  • POSTCancel a blast
  • POSTSend a scheduled blast
  • GETPreview how a blast will land
  • GETRead a blast's report
  • POSTSchedule a blast
  • GETRead the calendar
  • POSTBook a meeting
  • POSTPut an existing meeting on a record
  • DELETECall a meeting off
  • PATCHChange a meeting
  • GETInspect Google Meet task sync
  • POSTEnable Google Meet transcript tasks
  • GETRead the call log
  • POSTPlace a call from a record
  • GETRead a connected account's aliases
  • POSTImport a Gmail account's aliases and signatures
  • GETRead a connected account's contact import
  • POSTImport a connected account's contacts
  • GETList conversations
  • POSTOpen a conversation with an address
  • GETRead one conversation
  • PATCHStar, pin or archive a conversation
  • POSTLog a call that already happened
  • PUTLabel a conversation
  • DELETETake a label off a conversation
  • GETRead a conversation's messages
  • POSTSend a message on a conversation
  • POSTPreview a message on a conversation
  • POSTMute a conversation
  • GETRead who is on a conversation
  • POSTAdd somebody to a conversation
  • DELETETake somebody off a conversation
  • POSTMark a conversation read
  • POSTFile a conversation under a record
  • DELETEUnfile a conversation from a record
  • PATCHChange who may see a conversation
  • POSTDraft a message with Neo
  • POSTRecord a text that arrived
  • GETRead the addresses the desktop rail may upload
  • GETRead the workspace's inboxes
  • PUTPut somebody on an inbox
  • DELETETake somebody off an inbox
  • PUTSet one inbox's privacy
  • GETList inbox labels
  • POSTCreate an inbox label
  • DELETEDelete an inbox label
  • PATCHRename or recolour an inbox label
  • DELETEDelete a message
  • POSTCancel a queued message
  • PATCHRecord a message's delivery status
  • GETRead a message and its replies
  • GETRead the workspace's phone numbers
  • POSTBuy a phone number
  • GETSearch phone numbers for sale
  • DELETERelease a phone number
  • GETRead the do-not-contact list
  • POSTAdd an address to the do-not-contact list
  • DELETETake an address off the do-not-contact list
  • POSTClaim outbound sends
  • POSTRecord a carrier's delivery receipt
  • POSTReport what became of a send
  • GETRead one call recording
  • DELETERemove a call recording
  • POSTSummarise a call recording
  • GETRead a record's contact addresses
  • POSTMark a record's conversations read
  • GETRead a records call recordings
  • POSTSend a text or an email to an address
  • POSTPreview a send to an address
  • GETList the lines I can send from
  • GETRead who may see messages by default
  • PUTSet who may see messages by default
  • GETRead the email signatures
  • PUTSet an address's email signature
  • DELETEStop signing an address
  • GETRead the text message log
  • GETList connected mailbox folders
  • PUTChoose folders to scan
  • GETRead one email blast
  • GETFind a message in mailbox folders
  • POSTChange a mailbox folder or message flags
  • GETRead the workspace's connected mailboxes
  • POSTConnect a mailbox
  • DELETEDisconnect a mailbox
  • GETRead the standing message rules
  • POSTArm a standing message rule
  • DELETEDelete a standing message rule
  • PATCHChange a standing message rule
  • GETRead the approval queue
  • POSTWrite a draft for somebody to look over
  • DELETEDelete a draft
  • PATCHChange message-drafts id
  • POSTApprove a draft
  • POSTCancel a draft
  • POSTDispatch a saved draft
  • GETList the placeholders a message template can use
  • GETRead the message templates
  • POSTKeep a reusable message body
  • POSTGive a workspace the starter templates
  • DELETEDelete a message template
  • PATCHChange a message template
  • POSTSee what a template would say
  • POSTMake a template the default
  • GETRead your notification settings
  • PATCHChange your notification settings
  • GETRead the notification types
  • POSTAdd a notification type
  • DELETERetire a notification type
  • POSTRaise a notification
  • GETList notifications
  • POSTDismiss notifications
  • POSTMark every notification read
  • POSTMark notifications read
  • GETCount your unread notifications
  • POSTQueue personalized messages
  • GETRead push public-key
  • GETRead push subscriptions
  • POSTCreate push subscriptions
  • DELETERemove push subscriptions id
  • GETRead one text blast
  • POSTCount who a text blast would be resent to
  • POSTSend a blast again to whoever did not reply
  • POSTResume staff mailbox consent
  • POSTStart staff mailbox consent
  • GETList discussion threads
  • GETList accounting grants
  • PUTGrant a seat the books
  • DELETERevoke a seat's accounting grant
  • GETList allocations
  • POSTAllocate a bank transaction
  • DELETEUndo an allocation
  • GETList bank transactions
  • POSTRecord a bank transaction
  • GETRead a bank transaction
  • PUTCategorize and tag a transaction
  • GETRead workspace transaction categories
  • POSTCreate a transaction category
  • PUTSave a transaction category
  • DELETEDelete an unused transaction category
  • PUTReorder transaction categories
  • GETRead the accounting dashboard
  • GETList deal costs
  • POSTRecord a deal cost
  • POSTMark a deal cost paid
  • GETList deal splits
  • POSTCreate a deal split
  • GETRead a deal split
  • PATCHChange accounting deal-splits id
  • POSTDeactivate a deal split
  • GETList deals in the ledger
  • POSTAdd a deal to the ledger
  • GETRead a ledger deal
  • DELETERemove a deal from the ledger
  • PATCHChange accounting deals id
  • GETRead accounting correction history
  • GETRead a ledger deal in full
  • GETList accounting exceptions
  • POSTReview and apply accounting hold rules
  • GETRead the caller's accounting access
  • GETRead the caller's own available balance
  • GETList the caller's payout methods
  • POSTAdd a payout method
  • POSTFinish a bank sign-in for a payout method
  • POSTStart a bank sign-in for a payout method
  • DELETERemove a payout method
  • POSTReveal an authorized account number
  • POSTMake a payout method the default
  • GETList payout requests
  • POSTRequest a payout
  • GETRead a payout request
  • POSTApprove a payout
  • POSTCancel a payout request
  • GETOpen a payout's destination
  • POSTMark a payout paid
  • POSTReject a payout
  • POSTSend an approved payout to the bank
  • GETList company bank feeds
  • POSTFinish a company bank link
  • POSTStart a company bank link
  • DELETEUnlink a company bank
  • PUTSelect company accounts for the ledger
  • POSTCheck an expected bank payment
  • POSTRequest fresh bank transactions
  • POSTSync a company bank feed
  • POSTSearch imported bank transactions
  • GETGenerate cash profit and loss
  • GETRead accounting settings
  • PUTSave accounting settings
  • GETRead the workspace's billing
  • POSTBuy the bank login package
  • POSTCancel at the end of the period
  • GETRead what can be bought
  • GETRead the AI credit balance and ledger
  • POSTBuy a credit pack
  • GETRead the billing history
  • POSTOpen the Stripe customer portal
  • POSTChange the plan or the seat count
  • GETRead this period's usage
  • GETList cash flows
  • POSTCreate a cash flow
  • GETRead a cash flow
  • POSTMark a cash flow failed
  • POSTMark a cash flow missed
  • POSTRecord a payment against a cash flow
  • GETList credit memos
  • POSTCreate a credit memo
  • GETRead a credit memo
  • DELETEDelete a credit memo
  • PATCHChange credit-memos id
  • POSTPut a deal's merchant on the payment rail
  • GETRead the money moved through Finix
  • GETWhat is owed on the deals
  • POSTRaise an obligation
  • GETRead one obligation
  • PATCHChange an obligation
  • POSTComplete an obligation
  • POSTMark an obligation overdue
  • POSTWaive an obligation
  • GETThe repayment schedules being collected
  • POSTRaise a repayment schedule
  • GETRead one repayment schedule
  • DELETEDestroy a schedule and its instalments
  • POSTClose out a schedule
  • POSTPause collection on a schedule
  • GETThe instalments under one schedule
  • GETHow one schedule is performing
  • POSTResume a paused schedule
  • GETA schedule's debit authorisations
  • POSTAsk the merchant to authorise the debit
  • GETThe instalments still to come
  • GETRead one instalment
  • POSTCollect a due payment through Finix
  • POSTMark an instalment failed on the rail
  • POSTMark an instalment missed
  • POSTAgree an instalment against the bank
  • POSTRecord money collected on an instalment
  • POSTReverse a booked receipt
  • POSTForgive an instalment
  • GETPortfolio aging
  • GETPortfolio health
  • GETCollections projection
  • POSTRecord the merchant's consent to debit
  • POSTWithdraw an unanswered authorisation request
  • POSTRevoke a live debit authorisation
  • GETThe deals that are behind
  • POSTOpen a delinquency case
  • POSTFind delinquent facilities now
  • POSTLog chasing a delinquent borrower
  • POSTResolve a delinquency case
  • GETHow facilities ended
  • POSTRecord how a facility ended
  • GETRead a picked cloud file's bytes
  • GETList outstanding document requests
  • POSTCancel a document request
  • POSTFulfil a document request
  • GETList document templates
  • POSTCreate a document template
  • GETSigning requests on a document
  • POSTSend a document for signature
  • GETBrowse the caller's Google Drive
  • GETRead a Google Sheet as a file
  • GETGlance at a Google Sheet's tabs
  • GETList the workspace's files
  • POSTUpload a file
  • DELETEDelete a file
  • PATCHRename or classify a file
  • POSTAnalyse a document
  • GETDownload a file
  • POSTConfirm a file's upload landed
  • POSTLink a file to a record
  • DELETEUnlink a file from a record
  • POSTReplace a file's contents
  • GETRead what a document's results did to the record
  • POSTAccept a document's held change
  • POSTReject a document's held change
  • POSTShare a file by link
  • PUTStar a file
  • DELETEUnstar a file
  • GETBrowse the caller's OneDrive
  • GETList the caller's SharePoint libraries
  • GETRead the workbook behind an Excel share link
  • GETRead a signing request
  • POSTCancel a signing request
  • GETRead the executed document
  • POSTRemind a request's signers
  • GETRead storage-accounts
  • POSTCreate storage-accounts
  • DELETERemove storage-accounts id
  • GETRead the workspace's activity feed
  • GETAgent performance
  • GETRead what an agent brought in
  • GETRead integrations
  • GETRead managed phone setup
  • PUTSave managed phone setup
  • GETRead verified managed phone prices
  • GETRecover managed phone orders
  • POSTCreate a managed phone order
  • GETRead managed phone order status
  • POSTCheck current managed phone subscription
  • POSTOpen managed phone payment checkout
  • GETRead managed phone review
  • POSTRequest managed phone review
  • GETRead the Plaid onboarding
  • POSTApply for Plaid through Specter
  • DELETERemove the Plaid end customer
  • POSTEnable the Plaid end customer
  • POSTCheck the Plaid onboarding with Plaid
  • GETRead Plaid readiness
  • DELETEDelete integrations zoom connection
  • GETRead integrations zoom oauth authorize
  • POSTFinish connecting Zoom
  • GETRead integrations zoom phone-numbers
  • GETCheck whether Zoom is connected
  • GETRead integrations zoom users
  • GETRead integrations provider
  • PUTReplace integrations provider
  • DELETERemove integrations provider
  • POSTCreate integrations provider test
  • POSTEvaluate workflow data with Neo
  • GETRead what Neo remembers about you
  • POSTRemember something about you
  • DELETEForget something Neo remembers
  • PATCHChange something Neo remembers
  • GETWhat a report can be built from
  • POSTRun an unsaved report definition
  • DELETERevoke a public report link
  • GETThe saved reports
  • POSTSave a report
  • DELETEDelete a saved report
  • PATCHChange a saved report
  • POSTRun a saved report
  • GETPublic links on one report
  • POSTPublish a public report link
  • GETList tasks
  • POSTCreate a task
  • GETRead task figures
  • PATCHChange a task
  • GETRead a task's comments
  • POSTComment on a task
  • POSTMark a task done
  • GETRead webhooks
  • POSTCreate webhooks
  • GETRead webhooks id
  • DELETERemove webhooks id
  • PATCHChange webhooks id
  • GETRead webhooks id deliveries
  • POSTCreate webhooks id rotate
  • POSTCreate webhooks id test
  • GETList workflows
  • POSTStart a workflow draft
  • GETThe workflow vocabulary
  • GETWorkflow steps waiting on a person
  • POSTAnswer a workflow review
  • GETWorkflow runs, newest first
  • GETOne run, its steps and its reviews
  • POSTStop a running workflow run
  • POSTCheck a workflow definition
  • GETOne workflow and its draft's problems
  • DELETEDelete an unpublished draft
  • PATCHEdit a workflow draft
  • POSTPublish a workflow — it goes live
  • POSTRun a published workflow by hand
  • GETEvery publish of one workflow
  • POSTCreate client errors
  • POSTReport client timings
  • POSTSet my photo
  • GETRead your calendar settings
  • PATCHChange your calendar settings
  • GETRead everything about who is asking
  • GETRead my day
  • GETRead my Getting Started checklist
  • POSTFinish my Getting Started checklist
  • GETRead the records I opened recently
  • POSTFile a record I opened
  • GETRead my screen-capture protection
  • POSTAllow screen capture of my window for a while
  • GETRead my call-script template
  • PUTReplace my call-script template
  • GETRead my usage summary
  • GETRead preferences
  • GETRead preferences key
  • PUTReplace preferences key
  • GETRead workspace preferences
  • GETRead workspace preferences key
  • PUTReplace workspace preferences key
  • GETRead my undo history
  • POSTUndo my last change
  • PATCHChange workspace
  • GETRead the workspace's refused calls
  • GETRead the workspace's automated emails
  • PUTReplace the workspace's automated emails
  • GETRead the states this workspace discloses in
  • PUTReplace the states this workspace adds
  • GETList the workspace's document types
  • GETBrowse Drive folders
  • GETRead the execution profile
  • PUTSave the execution profile
  • DELETERemove an inbound address
  • PATCHRe-aim or pause an inbound address
  • PUTReplace workspace kyc
  • POSTCreate workspace kyc submit
  • GETList the published lender catalogue
  • POSTUpload the workspace logo
  • GETRead workspace mcp usage
  • GETBrowse OneDrive folders
  • GETList businesses that appear on more than one page
  • POSTUpload a form logo or the workspace logo
  • GETRead the workspace's plan and seats
  • GETRead what the workspace still needs set up
  • GETRead the SLA dashboard tile
  • GETRead workspace staff-access
  • GETRead the workspace at a glance
  • GETRead the workspace's Super KYC settings
  • PUTReplace the workspace's Super KYC settings
  • GETRead which teams' records the caller sees
  • GETComplete a value the way this workspace spells it
  • POSTPOST /v1/workspace/vocabulary
  • GETRead workspace agreements kind
  • POSTCreate workspace agreements kind sign
  • POSTCreate workspace agreements kind viewed
  • GETRead workspace api-keys
  • POSTCreate workspace api-keys
  • DELETERemove workspace api-keys keyId
  • GETRead a key's partner-API state
  • POSTCreate workspace api-keys keyId rotate
  • GETRead the workspace's compliance reports
  • POSTGenerate a compliance report
  • DELETEDelete a compliance report
  • PATCHChange a compliance report
  • POSTRun a compliance report now
  • GETRead a report's runs
  • GETRead one compliance run
  • POSTSign off, reject or reopen a run
  • GETRead workspace delegation
  • PUTReplace workspace delegation
  • DELETERemove workspace delegation
  • POSTCreate workspace delegation microsoft start
  • POSTCreate workspace delegation sync
  • GETList the connected directory's people
  • POSTInvite people from the directory
  • PUTSet directory provisioning
  • POSTSync seats against the directory
  • GETList workspace domains
  • POSTAdd a workspace domain
  • GETRead one workspace domain
  • DELETERemove a workspace domain
  • PUTServe forms from a workspace domain
  • DELETEStop serving forms from a workspace domain
  • GETList a domain's inbound addresses
  • POSTAdd an inbound address
  • POSTRecheck a domain's DNS
  • GETList Drive watches
  • POSTWatch a Drive folder
  • DELETEStop watching a Drive folder
  • POSTSweep a Drive watch now
  • GETRead workspace heartbeat
  • PUTReplace workspace heartbeat
  • GETRead workspace heartbeat actions
  • POSTDecide heartbeat items in bulk
  • POSTApply a heartbeat action
  • POSTDefer a heartbeat item
  • POSTRefuse a heartbeat action
  • POSTTake back a heartbeat decision
  • PUTElect yourself in or out of heartbeat follow-ups
  • GETList the heartbeat's runs
  • GETList conversations the heartbeat is stopped for
  • PUTStop or resume the heartbeat for a conversation
  • GETList open invites
  • POSTInvite someone to the workspace
  • DELETEWithdraw an invite
  • GETList the workspace's members and their roles
  • DELETERemove a member from the workspace
  • PATCHChange workspace members accountId
  • POSTPause a member's seat
  • POSTLet a paused member back in
  • GETRead where the workspace's applications arrive
  • DELETERemove an alias from the workspace's intake mailbox
  • DELETEDisconnect the workspace's intake mailbox
  • POSTAdd an alias to the workspace's intake mailbox
  • GETList an intake mailbox's existing Gmail aliases
  • GETRead what counts as a processed deal
  • PUTChange what counts as a processed deal
  • POSTTest the processor criteria on recent mail
  • GETRead a file type's examples
  • POSTTeach a file type with an example
  • DELETERemove an example from a file type
  • POSTConnect the workspace's own intake mailbox
  • PUTChoose where applications arrive
  • POSTConnect the workspace's own Outlook intake mailbox
  • GETRead where file types' results go
  • PUTSave where a file type's results go on a board
  • PUTChoose the submission email
  • GETRead the workspace's processor whitelist
  • POSTLet a seatless sender email the processor
  • DELETERemove a sender from the workspace's processor whitelist
  • GETRead workspace rep
  • GETRead workspace rep thread
  • POSTCreate workspace rep thread messages
  • GETRead the sidebar folders
  • POSTMake a sidebar folder
  • PUTReorder the sidebar folders
  • DELETEDelete a sidebar folder
  • PATCHRename or move a sidebar folder
  • PUTFile items into a sidebar folder
  • GETRead the workspace's SLA policies
  • POSTPromise a stage an SLA
  • DELETEWithdraw a stage's SLA
  • PATCHChange a stage's SLA
  • GETList support tickets
  • POSTOpen a support ticket
  • GETRead a support ticket
  • POSTComment on a support ticket
  • GETList the workspace's teams
  • POSTCreate a team
  • DELETEDelete a team
  • PATCHChange workspace teams teamId
  • PUTPut a member on a team
  • DELETETake a member off a team
  • GETRead the workspace's underwriting criteria
  • PUTSet the workspace's underwriting criteria
  • POSTSeed the workspace's underwriting criteria
  • GETList the underwriting rule sets
  • POSTCreate an underwriting rule set
  • POSTSeed the default underwriting rule set
  • GETRead one underwriting rule set
  • PATCHChange an underwriting rule set
  • POSTPublish an underwriting rule set
  • POSTAdd an underwriting rule
  • DELETEDelete an underwriting rule
  • PATCHChange an underwriting rule
  • GETRead the underwriting settings
  • PUTSave the underwriting settings
  • GETRead workspace usage events
  • GETRead workspace usage per member
  • GETRead workspace usage summary
  • GETRead the workspace's vendors
  • POSTEngage a vendor
  • DELETERemove a vendor
  • PATCHChange a vendor
  • POSTPin a document to a vendor
  • DELETEUnpin a vendor's document
POST/v1/workflows/validate

Check a workflow definition

Answers whether a workflow definition would run — valid plus a list of problems, each with a code and the step it is about. It CHANGES NOTHING and publishes nothing, so this is the safe way to ask "is this rule right". Body: definition as {trigger, steps}. It is the same code post_workflows_id_publish refuses on, and catches an unknown action or event, a duplicate or missing step id, a jump to nowhere, a backward jump, an expression or template that will not parse, a {{steps.x}} naming a step that runs later, and wait / review / stop / each nested inside an each.

Access class: workspace.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL
Bearer tokensessionoptional
Stored only in this browser for the session security scheme and reused on every API page in this group.

Request body

application/jsonrequired
definitionobjectoptional

Responses

201application/json

the action's answer

{
  "data": {
    "problems": [
      {
        "code": "string",
        "field": "string",
        "message": "string"
      }
    ],
    "valid": true
  }
}
datarequired
defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}
errorstringrequired
Stop a running workflow run< PreviousOne workflow and its draft's problemsNext >
curl --request POST \  'https://neo-app-api-prod-836053680024.us-central1.run.app/v1/workflows/validate' \  --header 'Content-Type: application/json' \  --data '{  "definition": "string"}'
{  "data": {    "problems": [      {        "code": "string",        "field": "string",        "message": "string"      }    ],    "valid": true  }}