Pages through projects in a stable order. Filter with filter[<key>][<op>]=<value> (conditions are ANDed; in and nin repeat the parameter). Operators: eq, gt, gte, lt, lte, in, nin, contains, starts_with, exists, not_exists. Each field accepts a subset, and anything else is a 422 naming what that field supports. Text eq ignores case, except on ids (account, assignee), which match exactly; in and nin match exactly. priority and source take the values a record shows. Dates are YYYY-MM-DD and compare as whole days. Standard fields sit at the top level and custom fields under fields, keyed as GET /v1/fields?object=project lists them. A project’s name is title (there is no name). account holds an account’s id and account_name its name; assignee and creator hold user ids; template the id of the template the project was created from. status is the status’s name and status_group its group: not_started, active, done or archived. priority is low, medium or high. source is where the project came from: statisfy, or the tool it is synced from (wrike, jira, rocketlane, …), whose next sync replaces its values. Dates are YYYY-MM-DD; created_at and updated_at are their UTC day. Deleted projects are never returned; a project whose status is in the archived group is.
An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.
Query Parameters
fields
string[] | null
Custom field keys to return (comma-separated); all of them when omitted
limit
integer
default:25
Required range: 1 <= x <= 100
cursor
string | null
next_cursor from the previous page
filter
object
Filter with query parameters filter[<key>][<op>]=<value>, all ANDed; in
and nin take the parameter repeated. Keys are those GET /v1/fields?object=project lists.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Statisfy","description":"Statisfy is an agentic platform for customer intelligence, supporting both pre-sales and post-sales workflows with unified customer context across the entire customer lifecycle.","colors":{"primary":"#6366F1","light":"#818CF8","dark":"#4F46E5"},"logo":{"light":"https://mintcdn.com/statisfy/-mEFnxVd9s5kL3ir/resources/logo-light.svg?fit=max\u0026auto=format\u0026n=-mEFnxVd9s5kL3ir\u0026q=85\u0026s=c42ea5d3e828945c05d618cdb0f658b9","dark":"https://mintcdn.com/statisfy/-mEFnxVd9s5kL3ir/resources/logo-dark.svg?fit=max\u0026auto=format\u0026n=-mEFnxVd9s5kL3ir\u0026q=85\u0026s=252d43adf6de24dd1079dcd2cd276f72","href":"https://statisfy.com"},"favicon":"https://mintcdn.com/statisfy/-mEFnxVd9s5kL3ir/favicon.svg?fit=max\u0026auto=format\u0026n=-mEFnxVd9s5kL3ir\u0026q=85\u0026s=d8936b2ddf2ff2af5ad66c7673c2a97e","navbar":{"links":[{"href":"mailto:support@statisfy.com","label":"Support"}]},"footer":{"socials":{"linkedin":"https://linkedin.com/company/statisfy"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"statisfy","hasAudioNarration":false,"actualSubdomain":"statisfy","customDomains":["help.statisfy.com"],"gitSource":{"type":"github","owner":"statisfy-us","repo":"repo","deployBranch":"main","contentDirectory":"help-docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afc440724a397d42d541e36","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"default","tag":"Statisfy API","count":314},{"language":"default","tag":"Endpoints","count":310},{"language":"default","tag":"Documentation","count":134},{"language":"default","tag":"Integrations","count":60},{"language":"default","tag":"integrations","count":52},{"language":"default","tag":"automations","count":29},{"language":"default","tag":"Admin","count":25},{"language":"default","tag":"Portals","count":20},{"language":"default","tag":"Settings","count":18},{"language":"default","tag":"API Reference","count":14}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@statisfy.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"rest-api/reference/projects/list-projects","slug":"/rest-api/reference/projects/list-projects","pageMetadata":{"title":"List projects","description":"Pages through projects in a stable order. Filter with `filter[\u003ckey>][\u003cop>]=\u003cvalue>` (conditions are ANDed; `in` and `nin` repeat the parameter). Operators: eq, gt, gte, lt, lte, in, nin, contains, starts_with, exists, not_exists. Each field accepts a subset, and anything else is a 422 naming what that field supports. Text `eq` ignores case, except on ids (`account`, `assignee`), which match exactly; `in` and `nin` match exactly. `priority` and `source` take the values a record shows. Dates are YYYY-MM-DD and compare as whole days. Standard fields sit at the top level and custom fields under `fields`, keyed as GET /v1/fields?object=project lists them. A project's name is `title` (there is no `name`). `account` holds an account's id and `account_name` its name; `assignee` and `creator` hold user ids; `template` the id of the template the project was created from. `status` is the status's name and `status_group` its group: not_started, active, done or archived. `priority` is low, medium or high. `source` is where the project came from: `statisfy`, or the tool it is synced from (`wrike`, `jira`, `rocketlane`, ...), whose next sync replaces its values. Dates are YYYY-MM-DD; `created_at` and `updated_at` are their UTC day. Deleted projects are never returned; a project whose status is in the archived group is.","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/objects/project/records","href":"/rest-api/reference/projects/list-projects","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Pages through projects in a stable order. Filter with \", _jsx(_components.code, {\n children: \"filter[\u003ckey>][\u003cop>]=\u003cvalue>\"\n }), \" (conditions are ANDed; \", _jsx(_components.code, {\n children: \"in\"\n }), \" and \", _jsx(_components.code, {\n children: \"nin\"\n }), \" repeat the parameter). Operators: eq, gt, gte, lt, lte, in, nin, contains, starts_with, exists, not_exists. Each field accepts a subset, and anything else is a 422 naming what that field supports. Text \", _jsx(_components.code, {\n children: \"eq\"\n }), \" ignores case, except on ids (\", _jsx(_components.code, {\n children: \"account\"\n }), \", \", _jsx(_components.code, {\n children: \"assignee\"\n }), \"), which match exactly; \", _jsx(_components.code, {\n children: \"in\"\n }), \" and \", _jsx(_components.code, {\n children: \"nin\"\n }), \" match exactly. \", _jsx(_components.code, {\n children: \"priority\"\n }), \" and \", _jsx(_components.code, {\n children: \"source\"\n }), \" take the values a record shows. Dates are YYYY-MM-DD and compare as whole days. Standard fields sit at the top level and custom fields under \", _jsx(_components.code, {\n children: \"fields\"\n }), \", keyed as GET /v1/fields?object=project lists them. A project’s name is \", _jsx(_components.code, {\n children: \"title\"\n }), \" (there is no \", _jsx(_components.code, {\n children: \"name\"\n }), \"). \", _jsx(_components.code, {\n children: \"account\"\n }), \" holds an account’s id and \", _jsx(_components.code, {\n children: \"account_name\"\n }), \" its name; \", _jsx(_components.code, {\n children: \"assignee\"\n }), \" and \", _jsx(_components.code, {\n children: \"creator\"\n }), \" hold user ids; \", _jsx(_components.code, {\n children: \"template\"\n }), \" the id of the template the project was created from. \", _jsx(_components.code, {\n children: \"status\"\n }), \" is the status’s name and \", _jsx(_components.code, {\n children: \"status_group\"\n }), \" its group: not_started, active, done or archived. \", _jsx(_components.code, {\n children: \"priority\"\n }), \" is low, medium or high. \", _jsx(_components.code, {\n children: \"source\"\n }), \" is where the project came from: \", _jsx(_components.code, {\n children: \"statisfy\"\n }), \", or the tool it is synced from (\", _jsx(_components.code, {\n children: \"wrike\"\n }), \", \", _jsx(_components.code, {\n children: \"jira\"\n }), \", \", _jsx(_components.code, {\n children: \"rocketlane\"\n }), \", …), whose next sync replaces its values. Dates are YYYY-MM-DD; \", _jsx(_components.code, {\n children: \"created_at\"\n }), \" and \", _jsx(_components.code, {\n children: \"updated_at\"\n }), \" are their UTC day. Deleted projects are never returned; a project whose status is in the archived group is.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List projects","description":"Pages through projects in a stable order. Filter with `filter[\u003ckey>][\u003cop>]=\u003cvalue>` (conditions are ANDed; `in` and `nin` repeat the parameter). Operators: eq, gt, gte, lt, lte, in, nin, contains, starts_with, exists, not_exists. Each field accepts a subset, and anything else is a 422 naming what that field supports. Text `eq` ignores case, except on ids (`account`, `assignee`), which match exactly; `in` and `nin` match exactly. `priority` and `source` take the values a record shows. Dates are YYYY-MM-DD and compare as whole days. Standard fields sit at the top level and custom fields under `fields`, keyed as GET /v1/fields?object=project lists them. A project's name is `title` (there is no `name`). `account` holds an account's id and `account_name` its name; `assignee` and `creator` hold user ids; `template` the id of the template the project was created from. `status` is the status's name and `status_group` its group: not_started, active, done or archived. `priority` is low, medium or high. `source` is where the project came from: `statisfy`, or the tool it is synced from (`wrike`, `jira`, `rocketlane`, ...), whose next sync replaces its values. Dates are YYYY-MM-DD; `created_at` and `updated_at` are their UTC day. Deleted projects are never returned; a project whose status is in the archived group is.","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/objects/project/records","href":"/rest-api/reference/projects/list-projects","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Pages through projects in a stable order. Filter with `filter[\u003ckey>][\u003cop>]=\u003cvalue>` (conditions are ANDed; `in` and `nin` repeat the parameter). Operators: eq, gt, gte, lt, lte, in, nin, contains, starts_with, exists, not_exists. Each field accepts a subset, and anything else is a 422 naming what that field supports. Text `eq` ignores case, except on ids (`account`, `assignee`), which match exactly; `in` and `nin` match exactly. `priority` and `source` take the values a record shows. Dates are YYYY-MM-DD and compare as whole days. Standard fields sit at the top level and custom fields under `fields`, keyed as GET /v1/fields?object=project lists them. A project's name is `title` (there is no `name`). `account` holds an account's id and `account_name` its name; `assignee` and `creator` hold user ids; `template` the id of the template the project was created from. `status` is the status's name and `status_group` its group: not_started, active, done or archived. `priority` is low, medium or high. `source` is where the project came from: `statisfy`, or the tool it is synced from (`wrike`, `jira`, `rocketlane`, ...), whose next sync replaces its values. Dates are YYYY-MM-DD; `created_at` and `updated_at` are their UTC day. Deleted projects are never returned; a project whose status is in the archived group is.","operationId":"projects_list","parameters":["f3939f50-9053-4386-ac56-d61a2c6cdef6","3b91da38-3f7c-475a-83ea-aa681dc7d6a3","cf9d6d93-267b-4d73-b12d-7727169f5025","18f1b3fd-8c9c-4d88-8bca-e0daa3c23cac"],"responses":{"200":"aee7b2c0-3b08-41e3-99ff-e9d928d162d2"},"security":["cedbc257-7cfc-4a66-b750-7963aaf665b2"],"summary":"List projects","tags":["projects"],"x-capability-id":"projects.list","x-required-scope":"projects:read","method":"get","type":"path","servers":["96d28bbe-8b23-4fbd-b189-be6b2ecb3cdc"],"path":"/v1/objects/project/records","baseUrlOptions":["https://api.statisfy.com"],"title":"List projects","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"f3939f50-9053-4386-ac56-d61a2c6cdef6":{"description":"Custom field keys to return (comma-separated); all of them when omitted","explode":false,"in":"query","name":"fields","required":false,"schema":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Custom field keys to return (comma-separated); all of them when omitted","uniqueKey":"oneOf.0","typeLabel":"string[]"},{"type":"null","description":"Custom field keys to return (comma-separated); all of them when omitted","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string[] | null"},"style":"form"},"3b91da38-3f7c-475a-83ea-aa681dc7d6a3":{"in":"query","name":"limit","required":false,"schema":{"default":25,"maximum":100,"minimum":1,"type":"integer","isRequired":false,"uniqueKey":"","typeLabel":"integer"}},"cf9d6d93-267b-4d73-b12d-7727169f5025":{"description":"`next_cursor` from the previous page","in":"query","name":"cursor","required":false,"schema":{"oneOf":[{"type":"string","description":"`next_cursor` from the previous page","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","description":"`next_cursor` from the previous page","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"18f1b3fd-8c9c-4d88-8bca-e0daa3c23cac":{"description":"Filter with query parameters ``filter[\u003ckey>][\u003cop>]=\u003cvalue>``, all ANDed; ``in``\nand ``nin`` take the parameter repeated. Keys are those GET /v1/fields?object=project lists.\n\nOperators: `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`, `contains`, `not_contains`, `starts_with`, `ends_with`, `exists`, `not_exists`.","explode":true,"in":"query","name":"filter","required":false,"schema":{"additionalProperties":{"additionalProperties":true,"type":"object","uniqueKey":"additionalProperties","typeLabel":"object"},"type":"object","isRequired":false,"description":"Filter with query parameters ``filter[\u003ckey>][\u003cop>]=\u003cvalue>``, all ANDed; ``in``\nand ``nin`` take the parameter repeated. Keys are those GET /v1/fields?object=project lists.\n\nOperators: `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`, `contains`, `not_contains`, `starts_with`, `ends_with`, `exists`, `not_exists`.","uniqueKey":"","typeLabel":"object"},"style":"deepObject"}},"responses":{"aee7b2c0-3b08-41e3-99ff-e9d928d162d2":{"content":{"application/json":{"schema":{"properties":{"data":{"items":{"properties":{"id":{"title":"Id","type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].id","typeLabel":"string"},"account":{"oneOf":[{"type":"string","title":"Account","description":"The id of the account the project is on","uniqueKey":"data.items.[INDEX].account.oneOf.0","typeLabel":"string"},{"type":"null","title":"Account","description":"The id of the account the project is on","uniqueKey":"data.items.[INDEX].account.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].account","typeLabel":"string | null"},"account_name":{"oneOf":[{"type":"string","title":"Account Name","uniqueKey":"data.items.[INDEX].account_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Account Name","uniqueKey":"data.items.[INDEX].account_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].account_name","typeLabel":"string | null"},"assignee":{"oneOf":[{"type":"string","title":"Assignee","description":"The assignee's user id","uniqueKey":"data.items.[INDEX].assignee.oneOf.0","typeLabel":"string"},{"type":"null","title":"Assignee","description":"The assignee's user id","uniqueKey":"data.items.[INDEX].assignee.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].assignee","typeLabel":"string | null"},"created_at":{"oneOf":[{"type":"string","title":"Created At","uniqueKey":"data.items.[INDEX].created_at.oneOf.0","typeLabel":"string"},{"type":"null","title":"Created At","uniqueKey":"data.items.[INDEX].created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].created_at","typeLabel":"string | null"},"creator":{"oneOf":[{"type":"string","title":"Creator","description":"The creator's user id","uniqueKey":"data.items.[INDEX].creator.oneOf.0","typeLabel":"string"},{"type":"null","title":"Creator","description":"The creator's user id","uniqueKey":"data.items.[INDEX].creator.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].creator","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","title":"Description","uniqueKey":"data.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","title":"Description","uniqueKey":"data.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].description","typeLabel":"string | null"},"due_date":{"oneOf":[{"type":"string","title":"Due Date","uniqueKey":"data.items.[INDEX].due_date.oneOf.0","typeLabel":"string"},{"type":"null","title":"Due Date","uniqueKey":"data.items.[INDEX].due_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].due_date","typeLabel":"string | null"},"fields":{"additionalProperties":true,"title":"Fields","type":"object","uniqueKey":"data.items.[INDEX].fields","typeLabel":"Fields · object"},"priority":{"oneOf":[{"type":"string","title":"Priority","enum":["low","medium","high"],"uniqueKey":"data.items.[INDEX].priority.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Priority","uniqueKey":"data.items.[INDEX].priority.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].priority","typeLabel":"enum\u003cstring> | null"},"source":{"oneOf":[{"type":"string","title":"Source","uniqueKey":"data.items.[INDEX].source.oneOf.0","typeLabel":"string"},{"type":"null","title":"Source","uniqueKey":"data.items.[INDEX].source.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].source","typeLabel":"string | null"},"start_date":{"oneOf":[{"type":"string","title":"Start Date","uniqueKey":"data.items.[INDEX].start_date.oneOf.0","typeLabel":"string"},{"type":"null","title":"Start Date","uniqueKey":"data.items.[INDEX].start_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].start_date","typeLabel":"string | null"},"status":{"oneOf":[{"type":"string","title":"Status","uniqueKey":"data.items.[INDEX].status.oneOf.0","typeLabel":"string"},{"type":"null","title":"Status","uniqueKey":"data.items.[INDEX].status.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].status","typeLabel":"string | null"},"status_group":{"oneOf":[{"type":"string","title":"Status Group","enum":["not_started","active","done","archived"],"uniqueKey":"data.items.[INDEX].status_group.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Status Group","uniqueKey":"data.items.[INDEX].status_group.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].status_group","typeLabel":"enum\u003cstring> | null"},"template":{"oneOf":[{"type":"string","title":"Template","description":"The id of the template the project was created from","uniqueKey":"data.items.[INDEX].template.oneOf.0","typeLabel":"string"},{"type":"null","title":"Template","description":"The id of the template the project was created from","uniqueKey":"data.items.[INDEX].template.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].template","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","title":"Title","uniqueKey":"data.items.[INDEX].title.oneOf.0","typeLabel":"string"},{"type":"null","title":"Title","uniqueKey":"data.items.[INDEX].title.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].title","typeLabel":"string | null"},"updated_at":{"oneOf":[{"type":"string","title":"Updated At","uniqueKey":"data.items.[INDEX].updated_at.oneOf.0","typeLabel":"string"},{"type":"null","title":"Updated At","uniqueKey":"data.items.[INDEX].updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].updated_at","typeLabel":"string | null"}},"required":["id"],"title":"Project","type":"object","uniqueKey":"data.items.[INDEX]","typeLabel":"Project · object"},"title":"Data","type":"array","isRequired":true,"uniqueKey":"data","typeLabel":"Project · object[]"},"has_more":{"default":false,"title":"Has More","type":"boolean","uniqueKey":"has_more","typeLabel":"boolean"},"next_cursor":{"oneOf":[{"type":"string","title":"Next Cursor","uniqueKey":"next_cursor.oneOf.0","typeLabel":"string"},{"type":"null","title":"Next Cursor","uniqueKey":"next_cursor.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_cursor","typeLabel":"string | null"}},"required":["data"],"title":"ProjectPage","type":"object","uniqueKey":"","typeLabel":"ProjectPage · object"},"examples":{"Example":{"title":"Example","value":{"data":[{"id":"\u003cstring>","account":"\u003cstring>","account_name":"\u003cstring>","assignee":"\u003cstring>","created_at":"\u003cstring>","creator":"\u003cstring>","description":"\u003cstring>","due_date":"\u003cstring>","fields":{},"priority":"low","source":"\u003cstring>","start_date":"\u003cstring>","status":"\u003cstring>","status_group":"not_started","template":"\u003cstring>","title":"\u003cstring>","updated_at":"\u003cstring>"}],"has_more":false,"next_cursor":"\u003cstring>"}}},"exampleType":"generated"}},"description":"Successful Response","exampleType":"generated"}},"security":{"cedbc257-7cfc-4a66-b750-7963aaf665b2":{"HTTPBearer":{"scheme":"bearer","type":"http","description":"An API key, sent as `Authorization: Bearer stfy_live_…`. See [Authentication](/rest-api/authentication) for how to get one and which scopes it needs.","scopes":[],"schemeName":"HTTPBearer"}}},"servers":{"96d28bbe-8b23-4fbd-b189-be6b2ecb3cdc":{"url":"https://api.statisfy.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"scheme":"bearer","type":"http","description":"An API key, sent as `Authorization: Bearer stfy_live_…`. See [Authentication](/rest-api/authentication) for how to get one and which scopes it needs.","scopes":[],"schemeName":"HTTPBearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An API key, sent as `Authorization: Bearer stfy_live_…`. See [Authentication](/rest-api/authentication) for how to get one and which scopes it needs.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"HTTPBearer","name":"Authorization"}],"title":"HTTPBearer"}]},"originalFileLocation":"api/statisfy-api.openapi.json"},"subdomain":"statisfy","siteName":"Statisfy","title":"List projects - Statisfy","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-17T12:09:54.525Z","originalFileLocation":"rest-api/reference/projects/list-projects.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Pages through projects in a stable order. Filter with filter= (conditions are ANDed; in and nin repeat the parameter). Operators: eq, gt, gte, lt, lte, in, nin, contains, starts_with, exists, not_exists. Each field accepts a subset, and anything else is a 422 naming what that field supports. Text eq ignores case, except on ids (account, assignee), which match exactly; in and nin match exactly. priority and source take the values a record shows. Dates are YYYY-MM-DD and compare as whole days. Standard fields sit at the top level and custom fields under fields, keyed as GET /v1/fields?object=project lists them. A project\u0026#x27;s name is title (there is no name). account holds an account\u0026#x27;s id and account_name its name; assignee and creator hold user ids; template the id of the template the project was created from. status is the status\u0026#x27;s name and status_group its group: not_started, active, done or archived. priority is low, medium or high. source is where the project came from: statisfy, or the tool it is synced from (wrike, jira, rocketlane, ...), whose next sync replaces its values. Dates are YYYY-MM-DD; created_at and updated_at are their UTC day. Deleted projects are never returned; a project whose status is in the archived group is.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Statisfy\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/statisfy/ZxOxPYgd4D__ShIN/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/statisfy/ZxOxPYgd4D__ShIN/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/statisfy/ZxOxPYgd4D__ShIN/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/statisfy/ZxOxPYgd4D__ShIN/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/statisfy/ZxOxPYgd4D__ShIN/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/statisfy/ZxOxPYgd4D__ShIN/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/statisfy/ZxOxPYgd4D__ShIN/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/statisfy/ZxOxPYgd4D__ShIN/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/statisfy/ZxOxPYgd4D__ShIN/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List projects - Statisfy\">\u003cmeta data-mint-head property=\"og:description\" content=\"Pages through projects in a stable order. Filter with filter= (conditions are ANDed; in and nin repeat the parameter). Operators: eq, gt, gte, lt, lte, in, nin, contains, starts_with, exists, not_exists. Each field accepts a subset, and anything else is a 422 naming what that field supports. Text eq ignores case, except on ids (account, assignee), which match exactly; in and nin match exactly. priority and source take the values a record shows. Dates are YYYY-MM-DD and compare as whole days. Standard fields sit at the top level and custom fields under fields, keyed as GET /v1/fields?object=project lists them. A project\u0026#x27;s name is title (there is no name). account holds an account\u0026#x27;s id and account_name its name; assignee and creator hold user ids; template the id of the template the project was created from. status is the status\u0026#x27;s name and status_group its group: not_started, active, done or archived. priority is low, medium or high. source is where the project came from: statisfy, or the tool it is synced from (wrike, jira, rocketlane, ...), whose next sync replaces its values. Dates are YYYY-MM-DD; created_at and updated_at are their UTC day. Deleted projects are never returned; a project whose status is in the archived group is.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Statisfy\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://help.statisfy.com/rest-api/reference/projects/list-projects\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://statisfy.mintlify.site/_mintlify/api/og/v2?division=projects\u0026amp;title=List+projects\u0026amp;description=Pages+through+projects+in+a+stable+order.+Filter+with+%60filter%5B%3Ckey%3E%5D%5B%3Cop%3E%5D%3D%3Cvalue%3E%60+%28conditions+are+ANDed%3B+%60in%60+and+%60nin%60+repeat+the+parameter%29.+Operators%3A+eq%2C+\u0026amp;theme=d0d553b77df82a6b94d02599\u0026amp;signature=9fe2c82be57097900cf5932e287dec6e07c0691d7842a79c37898c43c9179f41\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List projects - Statisfy\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Pages through projects in a stable order. Filter with filter= (conditions are ANDed; in and nin repeat the parameter). Operators: eq, gt, gte, lt, lte, in, nin, contains, starts_with, exists, not_exists. Each field accepts a subset, and anything else is a 422 naming what that field supports. Text eq ignores case, except on ids (account, assignee), which match exactly; in and nin match exactly. priority and source take the values a record shows. Dates are YYYY-MM-DD and compare as whole days. Standard fields sit at the top level and custom fields under fields, keyed as GET /v1/fields?object=project lists them. A project\u0026#x27;s name is title (there is no name). account holds an account\u0026#x27;s id and account_name its name; assignee and creator hold user ids; template the id of the template the project was created from. status is the status\u0026#x27;s name and status_group its group: not_started, active, done or archived. priority is low, medium or high. source is where the project came from: statisfy, or the tool it is synced from (wrike, jira, rocketlane, ...), whose next sync replaces its values. Dates are YYYY-MM-DD; created_at and updated_at are their UTC day. Deleted projects are never returned; a project whose status is in the archived group is.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://statisfy.mintlify.site/_mintlify/api/og/v2?division=projects\u0026amp;title=List+projects\u0026amp;description=Pages+through+projects+in+a+stable+order.+Filter+with+%60filter%5B%3Ckey%3E%5D%5B%3Cop%3E%5D%3D%3Cvalue%3E%60+%28conditions+are+ANDed%3B+%60in%60+and+%60nin%60+repeat+the+parameter%29.+Operators%3A+eq%2C+\u0026amp;theme=d0d553b77df82a6b94d02599\u0026amp;signature=9fe2c82be57097900cf5932e287dec6e07c0691d7842a79c37898c43c9179f41\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/statisfy/ZxOxPYgd4D__ShIN/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Statisfy\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6366F1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://help.statisfy.com/rest-api/reference/projects/list-projects\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/rest-api/reference/projects/list-projects.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://help.statisfy.com/#organization\",\"name\":\"Statisfy\",\"url\":\"https://help.statisfy.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/statisfy/-mEFnxVd9s5kL3ir/resources/logo-light.svg?fit=max\u0026auto=format\u0026n=-mEFnxVd9s5kL3ir\u0026q=85\u0026s=c42ea5d3e828945c05d618cdb0f658b9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://help.statisfy.com#website\",\"name\":\"Statisfy\",\"url\":\"https://help.statisfy.com\",\"publisher\":{\"@id\":\"https://help.statisfy.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://help.statisfy.com/rest-api/reference/projects/list-projects#webpage\",\"url\":\"https://help.statisfy.com/rest-api/reference/projects/list-projects\",\"name\":\"List projects\",\"description\":\"Pages through projects in a stable order. Filter with filter= (conditions are ANDed; in and nin repeat the parameter). Operators: eq, gt, gte, lt, lte, in, nin, contains, starts_with, exists, not_exists. Each field accepts a subset, and anything else is a 422 naming what that field supports. Text eq ignores case, except on ids (account, assignee), which match exactly; in and nin match exactly. priority and source take the values a record shows. Dates are YYYY-MM-DD and compare as whole days. Standard fields sit at the top level and custom fields under fields, keyed as GET /v1/fields?object=project lists them. A project's name is title (there is no name). account holds an account's id and account_name its name; assignee and creator hold user ids; template the id of the template the project was created from. status is the status's name and status_group its group: not_started, active, done or archived. priority is low, medium or high. source is where the project came from: statisfy, or the tool it is synced from (wrike, jira, rocketlane, ...), whose next sync replaces its values. Dates are YYYY-MM-DD; created_at and updated_at are their UTC day. Deleted projects are never returned; a project whose status is in the archived group is.\",\"dateModified\":\"2026-11-17T12:09:54.525Z\",\"isPartOf\":{\"@id\":\"https://help.statisfy.com#website\"},\"breadcrumb\":{\"@id\":\"https://help.statisfy.com/rest-api/reference/projects/list-projects#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://help.statisfy.com/rest-api/reference/projects/list-projects#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://help.statisfy.com/rest-api/reference/activities/list-activities\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List projects\",\"item\":\"https://help.statisfy.com/rest-api/reference/projects/list-projects\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://help.statisfy.com/rest-api/reference/projects/list-projects#apireference\",\"headline\":\"List projects\",\"name\":\"List projects\",\"description\":\"Pages through projects in a stable order. Filter with filter= (conditions are ANDed; in and nin repeat the parameter). Operators: eq, gt, gte, lt, lte, in, nin, contains, starts_with, exists, not_exists. Each field accepts a subset, and anything else is a 422 naming what that field supports. Text eq ignores case, except on ids (account, assignee), which match exactly; in and nin match exactly. priority and source take the values a record shows. Dates are YYYY-MM-DD and compare as whole days. Standard fields sit at the top level and custom fields under fields, keyed as GET /v1/fields?object=project lists them. A project's name is title (there is no name). account holds an account's id and account_name its name; assignee and creator hold user ids; template the id of the template the project was created from. status is the status's name and status_group its group: not_started, active, done or archived. priority is low, medium or high. source is where the project came from: statisfy, or the tool it is synced from (wrike, jira, rocketlane, ...), whose next sync replaces its values. Dates are YYYY-MM-DD; created_at and updated_at are their UTC day. Deleted projects are never returned; a project whose status is in the archived group is.\",\"url\":\"https://help.statisfy.com/rest-api/reference/projects/list-projects\",\"mainEntityOfPage\":{\"@id\":\"https://help.statisfy.com/rest-api/reference/projects/list-projects#webpage\"},\"dateModified\":\"2026-11-17T12:09:54.525Z\",\"publisher\":{\"@id\":\"https://help.statisfy.com/#organization\"},\"isPartOf\":{\"@id\":\"https://help.statisfy.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Statisfy\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Statisfy\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/rest-api/reference/projects/list-projects.md","siteName":"Statisfy","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/getting-started/introduction"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/salesforce"}]},{"tab":"Agent Studio","pages":[{"title":"Agent Studio","href":"/agent-studio/overview"}]},{"tab":"Admin","pages":[{"title":"Admin","href":"/admin/user_management_and_roles_guide"}]},{"tab":"Resources","pages":[{"title":"Resources","href":"/resources/faq"}]},{"tab":"AI Sales","hidden":true,"pages":[{"title":"AI Sales","href":"/ai-sales/overview"}]},{"tab":"Statisfy API","groups":[{"group":"Guides","pages":[{"title":"Statisfy API overview","href":"/rest-api/overview"},{"title":"Authentication","href":"/rest-api/authentication"},{"title":"Working with the API","href":"/rest-api/requests"},{"title":"Survey definition and theme","href":"/rest-api/survey_definition"}]},{"group":"Endpoints","pages":[{"group":"activities","pages":[{"title":"List activities","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/activities","href":"/rest-api/reference/activities/list-activities"},{"title":"Push an activity","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json put /v1/activities","href":"/rest-api/reference/activities/push-an-activity"},{"title":"Push activities","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/activities/batch/upsert","href":"/rest-api/reference/activities/push-activities"},{"title":"Get one activity","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/activities/{activity_id}","href":"/rest-api/reference/activities/get-one-activity"},{"title":"Delete a pushed activity","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json delete /v1/activities/{activity_id}","href":"/rest-api/reference/activities/delete-a-pushed-activity"},{"title":"Get what was written in an activity","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/activities/{activity_id}/content","href":"/rest-api/reference/activities/get-what-was-written-in-an-activity"}]},{"group":"agents","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/agents","href":"/rest-api/reference/agents/list-agents"},{"title":"Get one agent","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/agents/{agent_id}","href":"/rest-api/reference/agents/get-one-agent"}]},{"group":"approvals","pages":[{"title":"List approvals","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/approvals","href":"/rest-api/reference/approvals/list-approvals"},{"title":"Approve or reject approvals (your own key)","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/approvals/decisions","href":"/rest-api/reference/approvals/approve-or-reject-approvals-your-own-key"},{"title":"Get one approval with what it would send","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/approvals/{approval_id}","href":"/rest-api/reference/approvals/get-one-approval-with-what-it-would-send"},{"title":"Edit a pending approval before deciding (your own key)","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/approvals/{approval_id}","href":"/rest-api/reference/approvals/edit-a-pending-approval-before-deciding-your-own-key"},{"title":"Read an approval's attachment","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/approvals/{approval_id}/attachments/{attachment_id}","href":"/rest-api/reference/approvals/read-an-approvals-attachment"}]},{"group":"audit_logs","pages":[{"title":"List audit events","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/audit-logs","href":"/rest-api/reference/audit_logs/list-audit-events"},{"title":"Search audit events","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/audit-logs/search","href":"/rest-api/reference/audit_logs/search-audit-events"}]},{"group":"automations","pages":[{"title":"List the steps a flow can use","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/automations/components","href":"/rest-api/reference/automations/list-the-steps-a-flow-can-use"},{"title":"Get one step's settings and the fields it returns","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/automations/components/{component}","href":"/rest-api/reference/automations/get-one-steps-settings-and-the-fields-it-returns"},{"title":"List the workspace's options for a step's dropdown","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/automations/components/{component}/options/{setting}","href":"/rest-api/reference/automations/list-the-workspaces-options-for-a-steps-dropdown"},{"title":"Get how to write each of a step's settings","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/automations/components/{component}/settings","href":"/rest-api/reference/automations/get-how-to-write-each-of-a-steps-settings"},{"title":"List flows","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/automations/flows","href":"/rest-api/reference/automations/list-flows"},{"title":"Create a flow from a spec, off","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/automations/flows","href":"/rest-api/reference/automations/create-a-flow-from-a-spec-off"},{"title":"Get one flow","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/automations/flows/{flow_id}","href":"/rest-api/reference/automations/get-one-flow"},{"title":"Replace a flow's spec","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json put /v1/automations/flows/{flow_id}","href":"/rest-api/reference/automations/replace-a-flows-spec"},{"title":"Delete a flow that is off","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json delete /v1/automations/flows/{flow_id}","href":"/rest-api/reference/automations/delete-a-flow-that-is-off"},{"title":"Turn a flow off","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/automations/flows/{flow_id}/disable","href":"/rest-api/reference/automations/turn-a-flow-off"},{"title":"Turn a flow on (admins)","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/automations/flows/{flow_id}/enable","href":"/rest-api/reference/automations/turn-a-flow-on-admins"},{"title":"What turning a flow on will do","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/automations/flows/{flow_id}/enable-preview","href":"/rest-api/reference/automations/what-turning-a-flow-on-will-do"},{"title":"Get any flow as a spec, including one built in the editor","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/automations/flows/{flow_id}/spec","href":"/rest-api/reference/automations/get-any-flow-as-a-spec-including-one-built-in-the-editor"},{"title":"Run a flow up to a step on a real record, in a sandbox","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/automations/flows/{flow_id}/test","href":"/rest-api/reference/automations/run-a-flow-up-to-a-step-on-a-real-record-in-a-sandbox"},{"title":"How to build, test and turn on an automation (an Agent Studio flow or workflow)","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/automations/guide","href":"/rest-api/reference/automations/how-to-build-test-and-turn-on-an-automation-an-agent-studio-flow-or-workflow"},{"title":"List account roles a step can address (CSM, owner)","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/automations/roles","href":"/rest-api/reference/automations/list-account-roles-a-step-can-address-csm-owner"},{"title":"List flow runs","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/automations/runs","href":"/rest-api/reference/automations/list-flow-runs"},{"title":"Get one flow run","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/automations/runs/{run_id}","href":"/rest-api/reference/automations/get-one-flow-run"},{"title":"List the shapes a step's settings take","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/automations/shapes","href":"/rest-api/reference/automations/list-the-shapes-a-steps-settings-take"},{"title":"Get one value shape's JSON Schema","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/automations/shapes/{shape}","href":"/rest-api/reference/automations/get-one-value-shapes-json-schema"},{"title":"List flow templates","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/automations/templates","href":"/rest-api/reference/automations/list-flow-templates"},{"title":"Save a flow of the Templates folder as a template","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/automations/templates","href":"/rest-api/reference/automations/save-a-flow-of-the-templates-folder-as-a-template"},{"title":"List flow template categories","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/automations/templates/categories","href":"/rest-api/reference/automations/list-flow-template-categories"},{"title":"Get one flow template","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/automations/templates/{template_id}","href":"/rest-api/reference/automations/get-one-flow-template"},{"title":"Delete a flow template","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json delete /v1/automations/templates/{template_id}","href":"/rest-api/reference/automations/delete-a-flow-template"},{"title":"Change a flow template's categories","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/automations/templates/{template_id}","href":"/rest-api/reference/automations/change-a-flow-templates-categories"},{"title":"Create a flow from a template, off","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/automations/templates/{template_id}/flows","href":"/rest-api/reference/automations/create-a-flow-from-a-template-off"},{"title":"List workflows","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/automations/workflows","href":"/rest-api/reference/automations/list-workflows"},{"title":"Get one workflow","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/automations/workflows/{workflow_id}","href":"/rest-api/reference/automations/get-one-workflow"}]},{"group":"campaigns","pages":[{"title":"List campaigns","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/campaigns","href":"/rest-api/reference/campaigns/list-campaigns"},{"title":"Create a campaign","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/campaigns","href":"/rest-api/reference/campaigns/create-a-campaign"},{"title":"List audiences","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/campaigns/audiences","href":"/rest-api/reference/campaigns/list-audiences"},{"title":"List account roles","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/campaigns/roles","href":"/rest-api/reference/campaigns/list-account-roles"},{"title":"Get one campaign","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/campaigns/{campaign_id}","href":"/rest-api/reference/campaigns/get-one-campaign"},{"title":"Delete a campaign","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json delete /v1/campaigns/{campaign_id}","href":"/rest-api/reference/campaigns/delete-a-campaign"},{"title":"Change a campaign","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/campaigns/{campaign_id}","href":"/rest-api/reference/campaigns/change-a-campaign"},{"title":"Publish a campaign","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/campaigns/{campaign_id}/publish","href":"/rest-api/reference/campaigns/publish-a-campaign"},{"title":"List a campaign's recipients","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/campaigns/{campaign_id}/recipients","href":"/rest-api/reference/campaigns/list-a-campaigns-recipients"},{"title":"Get a campaign's numbers","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/campaigns/{campaign_id}/stats","href":"/rest-api/reference/campaigns/get-a-campaigns-numbers"},{"title":"Send a test email","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/campaigns/{campaign_id}/test-email","href":"/rest-api/reference/campaigns/send-a-test-email"},{"title":"Unpublish (pause) a campaign","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/campaigns/{campaign_id}/unpublish","href":"/rest-api/reference/campaigns/unpublish-pause-a-campaign"}]},{"group":"clips","pages":[{"title":"List clips","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/clips","href":"/rest-api/reference/clips/list-clips"},{"title":"Create a clip","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/clips","href":"/rest-api/reference/clips/create-a-clip"},{"title":"Get one clip","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/clips/{clip_id}","href":"/rest-api/reference/clips/get-one-clip"},{"title":"Delete a clip","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json delete /v1/clips/{clip_id}","href":"/rest-api/reference/clips/delete-a-clip"},{"title":"Change a clip","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/clips/{clip_id}","href":"/rest-api/reference/clips/change-a-clip"},{"title":"Share a clip","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/clips/{clip_id}/share","href":"/rest-api/reference/clips/share-a-clip"}]},{"group":"comments","pages":[{"title":"Get one comment","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/comments/{comment_id}","href":"/rest-api/reference/comments/get-one-comment"},{"title":"Delete a comment","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json delete /v1/comments/{comment_id}","href":"/rest-api/reference/comments/delete-a-comment"},{"title":"Edit a comment","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/comments/{comment_id}","href":"/rest-api/reference/comments/edit-a-comment"},{"title":"List a project's comments","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/objects/project/records/{project_id}/comments","href":"/rest-api/reference/comments/list-a-projects-comments"},{"title":"Comment on a project","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/objects/project/records/{project_id}/comments","href":"/rest-api/reference/comments/comment-on-a-project"},{"title":"List a task's comments","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/objects/task/records/{task_id}/comments","href":"/rest-api/reference/comments/list-a-tasks-comments"},{"title":"Comment on a task","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/objects/task/records/{task_id}/comments","href":"/rest-api/reference/comments/comment-on-a-task"}]},{"group":"conversations","pages":[{"title":"List conversations","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/conversations","href":"/rest-api/reference/conversations/list-conversations"},{"title":"Get one conversation","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/conversations/{conversation_id}","href":"/rest-api/reference/conversations/get-one-conversation"},{"title":"List a conversation's messages","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/conversations/{conversation_id}/messages","href":"/rest-api/reference/conversations/list-a-conversations-messages"},{"title":"List a conversation's internal notes","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/conversations/{conversation_id}/notes","href":"/rest-api/reference/conversations/list-a-conversations-internal-notes"}]},{"group":"credits","pages":[{"title":"List AI credit usage by flow","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/credits/flows","href":"/rest-api/reference/credits/list-ai-credit-usage-by-flow"},{"title":"List the AI credit usage log","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/credits/log","href":"/rest-api/reference/credits/list-the-ai-credit-usage-log"},{"title":"Get the AI credit summary","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/credits/summary","href":"/rest-api/reference/credits/get-the-ai-credit-summary"}]},{"group":"digital_workers","pages":[{"title":"List digital workers","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/digital_workers","href":"/rest-api/reference/digital_workers/list-digital-workers"},{"title":"Create a digital worker","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/digital_workers","href":"/rest-api/reference/digital_workers/create-a-digital-worker"},{"title":"Get one digital worker","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/digital_workers/{worker_id}","href":"/rest-api/reference/digital_workers/get-one-digital-worker"},{"title":"Change, activate, stop or archive a digital worker","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/digital_workers/{worker_id}","href":"/rest-api/reference/digital_workers/change-activate-stop-or-archive-a-digital-worker"},{"title":"List the accounts a worker covers","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/digital_workers/{worker_id}/accounts","href":"/rest-api/reference/digital_workers/list-the-accounts-a-worker-covers"},{"title":"Try a worker on one message","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/digital_workers/{worker_id}/preview","href":"/rest-api/reference/digital_workers/try-a-worker-on-one-message"},{"title":"List a worker's proactive tasks","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/digital_workers/{worker_id}/tasks","href":"/rest-api/reference/digital_workers/list-a-workers-proactive-tasks"},{"title":"Add a proactive task","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/digital_workers/{worker_id}/tasks","href":"/rest-api/reference/digital_workers/add-a-proactive-task"},{"title":"Get one proactive task","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/digital_workers/{worker_id}/tasks/{task_id}","href":"/rest-api/reference/digital_workers/get-one-proactive-task"},{"title":"Delete a proactive task","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json delete /v1/digital_workers/{worker_id}/tasks/{task_id}","href":"/rest-api/reference/digital_workers/delete-a-proactive-task"},{"title":"Change or close a proactive task","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/digital_workers/{worker_id}/tasks/{task_id}","href":"/rest-api/reference/digital_workers/change-or-close-a-proactive-task"},{"title":"See what a proactive task did this period","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/digital_workers/{worker_id}/tasks/{task_id}/coverage","href":"/rest-api/reference/digital_workers/see-what-a-proactive-task-did-this-period"},{"title":"List a worker's saved versions","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/digital_workers/{worker_id}/versions","href":"/rest-api/reference/digital_workers/list-a-workers-saved-versions"},{"title":"Restore a saved version","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/digital_workers/{worker_id}/versions/{version_id}/restore","href":"/rest-api/reference/digital_workers/restore-a-saved-version"}]},{"group":"evaluations","pages":[{"title":"List a worker's sets","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/evaluations/case_sets","href":"/rest-api/reference/evaluations/list-a-workers-sets"},{"title":"Create a set of test situations","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/evaluations/case_sets","href":"/rest-api/reference/evaluations/create-a-set-of-test-situations"},{"title":"Read a set and its cases","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/evaluations/case_sets/{case_set_id}","href":"/rest-api/reference/evaluations/read-a-set-and-its-cases"},{"title":"Score one result","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/evaluations/results/score","href":"/rest-api/reference/evaluations/score-one-result"},{"title":"List a worker's runs","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/evaluations/runs","href":"/rest-api/reference/evaluations/list-a-workers-runs"},{"title":"Start a run","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/evaluations/runs","href":"/rest-api/reference/evaluations/start-a-run"},{"title":"Read a run","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/evaluations/runs/{run_id}","href":"/rest-api/reference/evaluations/read-a-run"},{"title":"Read what a run produced","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/evaluations/runs/{run_id}/results","href":"/rest-api/reference/evaluations/read-what-a-run-produced"}]},{"group":"fields","pages":[{"title":"List every field definition on an object (the describe API)","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/fields","href":"/rest-api/reference/fields/list-every-field-definition-on-an-object-the-describe-api"},{"title":"Create a custom field definition on an object","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/fields","href":"/rest-api/reference/fields/create-a-custom-field-definition-on-an-object"},{"title":"Get one field definition by key","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/fields/{field_key}","href":"/rest-api/reference/fields/get-one-field-definition-by-key"},{"title":"Delete a custom field","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json delete /v1/fields/{field_key}","href":"/rest-api/reference/fields/delete-a-custom-field"},{"title":"Update a field definition's display name, visibility, or requiredness","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/fields/{field_key}","href":"/rest-api/reference/fields/update-a-field-definitions-display-name-visibility-or-requiredness"},{"title":"Replace the picklist options of a text picklist field","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json put /v1/fields/{field_key}/options","href":"/rest-api/reference/fields/replace-the-picklist-options-of-a-text-picklist-field"},{"title":"Recompute a formula field on every record","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/fields/{field_key}/recompute","href":"/rest-api/reference/fields/recompute-a-formula-field-on-every-record"},{"title":"List the functions a formula expression can use","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/formulas/functions","href":"/rest-api/reference/fields/list-the-functions-a-formula-expression-can-use"},{"title":"Compute a formula on a few records without saving it","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/formulas/preview","href":"/rest-api/reference/fields/compute-a-formula-on-a-few-records-without-saving-it"},{"title":"Check a formula before you save it","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/formulas/validate","href":"/rest-api/reference/fields/check-a-formula-before-you-save-it"}]},{"group":"health","pages":[{"title":"List account health","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/health","href":"/rest-api/reference/health/list-account-health"}]},{"group":"integrations","pages":[{"title":"List integrations","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/integrations","href":"/rest-api/reference/integrations/list-integrations"},{"title":"List file imports","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/integrations/imports","href":"/rest-api/reference/integrations/list-file-imports"},{"title":"List file import feeds","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/integrations/imports/feeds","href":"/rest-api/reference/integrations/list-file-import-feeds"},{"title":"Create a file import feed","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/integrations/imports/feeds","href":"/rest-api/reference/integrations/create-a-file-import-feed"},{"title":"Get one file import feed","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/integrations/imports/feeds/{name}","href":"/rest-api/reference/integrations/get-one-file-import-feed"},{"title":"Delete a file import feed","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json delete /v1/integrations/imports/feeds/{name}","href":"/rest-api/reference/integrations/delete-a-file-import-feed"},{"title":"Change a file import feed","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/integrations/imports/feeds/{name}","href":"/rest-api/reference/integrations/change-a-file-import-feed"},{"title":"Import one file now with a feed","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/integrations/imports/feeds/{name}/run","href":"/rest-api/reference/integrations/import-one-file-now-with-a-feed"},{"title":"Read a sample file's columns","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/integrations/imports/sample","href":"/rest-api/reference/integrations/read-a-sample-files-columns"},{"title":"List where a file's columns can go","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/integrations/imports/targets","href":"/rest-api/reference/integrations/list-where-a-files-columns-can-go"},{"title":"Test a feed's mapping on a sample","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/integrations/imports/test","href":"/rest-api/reference/integrations/test-a-feeds-mapping-on-a-sample"},{"title":"Get one file import","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/integrations/imports/{import_id}","href":"/rest-api/reference/integrations/get-one-file-import"},{"title":"List the Pendo account fields","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/integrations/pendo/account-fields","href":"/rest-api/reference/integrations/list-the-pendo-account-fields"},{"title":"List Pendo pages, features, track types or apps","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/integrations/pendo/catalog/{kind}","href":"/rest-api/reference/integrations/list-pendo-pages-features-track-types-or-apps"},{"title":"Get the Pendo config","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/integrations/pendo/config","href":"/rest-api/reference/integrations/get-the-pendo-config"},{"title":"Change the Pendo config","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/integrations/pendo/config","href":"/rest-api/reference/integrations/change-the-pendo-config"},{"title":"Preview a Pendo query","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/integrations/pendo/preview","href":"/rest-api/reference/integrations/preview-a-pendo-query"},{"title":"List the saved Pendo queries","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/integrations/pendo/queries","href":"/rest-api/reference/integrations/list-the-saved-pendo-queries"},{"title":"Save a new Pendo query","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/integrations/pendo/queries","href":"/rest-api/reference/integrations/save-a-new-pendo-query"},{"title":"Get one saved Pendo query","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/integrations/pendo/queries/{query_id}","href":"/rest-api/reference/integrations/get-one-saved-pendo-query"},{"title":"Delete a saved Pendo query","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json delete /v1/integrations/pendo/queries/{query_id}","href":"/rest-api/reference/integrations/delete-a-saved-pendo-query"},{"title":"Change a saved Pendo query","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/integrations/pendo/queries/{query_id}","href":"/rest-api/reference/integrations/change-a-saved-pendo-query"},{"title":"Check a Pendo query","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/integrations/pendo/query/validate","href":"/rest-api/reference/integrations/check-a-pendo-query"},{"title":"List the Pendo reports","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/integrations/pendo/reports","href":"/rest-api/reference/integrations/list-the-pendo-reports"},{"title":"List the Pendo NPS guides","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/integrations/pendo/surveys","href":"/rest-api/reference/integrations/list-the-pendo-nps-guides"},{"title":"Count the NPS answers of Pendo guides","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/integrations/pendo/surveys/answer-counts","href":"/rest-api/reference/integrations/count-the-nps-answers-of-pendo-guides"},{"title":"Preview the Pendo survey job","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/integrations/pendo/surveys/preview","href":"/rest-api/reference/integrations/preview-the-pendo-survey-job"},{"title":"Run the Pendo NPS survey job now","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/integrations/pendo/surveys/runs","href":"/rest-api/reference/integrations/run-the-pendo-nps-survey-job-now"},{"title":"Check a Pendo Sentiment survey ID","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/integrations/pendo/surveys/sentiment/{survey_id}","href":"/rest-api/reference/integrations/check-a-pendo-sentiment-survey-id"},{"title":"Get one integration","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/integrations/{key}","href":"/rest-api/reference/integrations/get-one-integration"},{"title":"List an integration's channels","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/integrations/{key}/channels","href":"/rest-api/reference/integrations/list-an-integrations-channels"},{"title":"Get one channel","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/integrations/{key}/channels/{channel_id}","href":"/rest-api/reference/integrations/get-one-channel"},{"title":"Get an integration's config","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/integrations/{key}/config","href":"/rest-api/reference/integrations/get-an-integrations-config"},{"title":"Change an integration's config","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/integrations/{key}/config","href":"/rest-api/reference/integrations/change-an-integrations-config"},{"title":"Test an integration's connection (a SQL warehouse or Pendo)","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/integrations/{key}/connection/test","href":"/rest-api/reference/integrations/test-an-integrations-connection-a-sql-warehouse-or-pendo"},{"title":"List an integration's connections","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/integrations/{key}/connections","href":"/rest-api/reference/integrations/list-an-integrations-connections"},{"title":"List a warehouse's schemas","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/integrations/{key}/discover/schemas","href":"/rest-api/reference/integrations/list-a-warehouses-schemas"},{"title":"List a schema's tables","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/integrations/{key}/discover/schemas/{schema_name}/tables","href":"/rest-api/reference/integrations/list-a-schemas-tables"},{"title":"List a table's columns","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/integrations/{key}/discover/schemas/{schema_name}/tables/{table_name}/columns","href":"/rest-api/reference/integrations/list-a-tables-columns"},{"title":"Preview a query","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/integrations/{key}/preview","href":"/rest-api/reference/integrations/preview-a-query"},{"title":"List saved queries","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/integrations/{key}/queries","href":"/rest-api/reference/integrations/list-saved-queries"},{"title":"Save a new query","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/integrations/{key}/queries","href":"/rest-api/reference/integrations/save-a-new-query"},{"title":"Get one saved query","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/integrations/{key}/queries/{query_id}","href":"/rest-api/reference/integrations/get-one-saved-query"},{"title":"Delete a saved query","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json delete /v1/integrations/{key}/queries/{query_id}","href":"/rest-api/reference/integrations/delete-a-saved-query"},{"title":"Change a saved query","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/integrations/{key}/queries/{query_id}","href":"/rest-api/reference/integrations/change-a-saved-query"},{"title":"List recent runs (any app, Pendo included)","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/integrations/{key}/runs","href":"/rest-api/reference/integrations/list-recent-runs-any-app-pendo-included"},{"title":"Run a saved query now (a SQL warehouse or Pendo)","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/integrations/{key}/runs","href":"/rest-api/reference/integrations/run-a-saved-query-now-a-sql-warehouse-or-pendo"},{"title":"Get one run (any app, Pendo included)","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/integrations/{key}/runs/{run_id}","href":"/rest-api/reference/integrations/get-one-run-any-app-pendo-included"},{"title":"Get an integration's schedule (any app, Pendo included)","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/integrations/{key}/schedule","href":"/rest-api/reference/integrations/get-an-integrations-schedule-any-app-pendo-included"},{"title":"Set an integration's schedule (a SQL warehouse or Pendo)","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json put /v1/integrations/{key}/schedule","href":"/rest-api/reference/integrations/set-an-integrations-schedule-a-sql-warehouse-or-pendo"},{"title":"Run SQL against the warehouse","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/integrations/{key}/sql","href":"/rest-api/reference/integrations/run-sql-against-the-warehouse"},{"title":"Check SQL","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/integrations/{key}/sql/validate","href":"/rest-api/reference/integrations/check-sql"}]},{"group":"knowledge_bases","pages":[{"title":"List knowledge bases","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/knowledge_bases","href":"/rest-api/reference/knowledge_bases/list-knowledge-bases"},{"title":"Create a knowledge base","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/knowledge_bases","href":"/rest-api/reference/knowledge_bases/create-a-knowledge-base"},{"title":"Search knowledge as a worker would","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/knowledge_bases/search","href":"/rest-api/reference/knowledge_bases/search-knowledge-as-a-worker-would"},{"title":"Get one knowledge base","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/knowledge_bases/{knowledge_base_id}","href":"/rest-api/reference/knowledge_bases/get-one-knowledge-base"},{"title":"Delete a knowledge base","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json delete /v1/knowledge_bases/{knowledge_base_id}","href":"/rest-api/reference/knowledge_bases/delete-a-knowledge-base"},{"title":"Change a knowledge base","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/knowledge_bases/{knowledge_base_id}","href":"/rest-api/reference/knowledge_bases/change-a-knowledge-base"},{"title":"List a knowledge base's documents","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/knowledge_bases/{knowledge_base_id}/documents","href":"/rest-api/reference/knowledge_bases/list-a-knowledge-bases-documents"},{"title":"Create or update a document","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json put /v1/knowledge_bases/{knowledge_base_id}/documents","href":"/rest-api/reference/knowledge_bases/create-or-update-a-document"},{"title":"Delete documents","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/knowledge_bases/{knowledge_base_id}/documents/batch/delete","href":"/rest-api/reference/knowledge_bases/delete-documents"},{"title":"Create or update documents","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/knowledge_bases/{knowledge_base_id}/documents/batch/upsert","href":"/rest-api/reference/knowledge_bases/create-or-update-documents"},{"title":"Get one document","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/knowledge_bases/{knowledge_base_id}/documents/{document_id}","href":"/rest-api/reference/knowledge_bases/get-one-document"},{"title":"Delete a document","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json delete /v1/knowledge_bases/{knowledge_base_id}/documents/{document_id}","href":"/rest-api/reference/knowledge_bases/delete-a-document"}]},{"group":"meetings","pages":[{"title":"List notetaker meetings","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/meetings","href":"/rest-api/reference/meetings/list-notetaker-meetings"},{"title":"Get one notetaker meeting","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/meetings/{meeting_id}","href":"/rest-api/reference/meetings/get-one-notetaker-meeting"},{"title":"Get a notetaker meeting's transcript files","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/meetings/{meeting_id}/transcript","href":"/rest-api/reference/meetings/get-a-notetaker-meetings-transcript-files"}]},{"group":"meta","pages":[{"title":"List every capability this API exposes, with schemas","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/meta/capabilities","href":"/rest-api/reference/meta/list-every-capability-this-api-exposes-with-schemas"},{"title":"Echo the authenticated identity behind this key","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/meta/whoami","href":"/rest-api/reference/meta/echo-the-authenticated-identity-behind-this-key"}]},{"group":"notification_rules","pages":[{"title":"List notification rules","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/notification-rules","href":"/rest-api/reference/notification_rules/list-notification-rules"},{"title":"Create a notification rule","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/notification-rules","href":"/rest-api/reference/notification_rules/create-a-notification-rule"},{"title":"List the channels a rule can send to","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/notification-rules/channels","href":"/rest-api/reference/notification_rules/list-the-channels-a-rule-can-send-to"},{"title":"Get one notification rule","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/notification-rules/{rule_id}","href":"/rest-api/reference/notification_rules/get-one-notification-rule"},{"title":"Delete a notification rule","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json delete /v1/notification-rules/{rule_id}","href":"/rest-api/reference/notification_rules/delete-a-notification-rule"},{"title":"Update a notification rule","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/notification-rules/{rule_id}","href":"/rest-api/reference/notification_rules/update-a-notification-rule"}]},{"group":"objects","pages":[{"title":"List the record objects","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/objects","href":"/rest-api/reference/objects/list-the-record-objects"},{"title":"Create a custom object","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/objects","href":"/rest-api/reference/objects/create-a-custom-object"},{"title":"Get one record object, with its fields","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/objects/{object}","href":"/rest-api/reference/objects/get-one-record-object-with-its-fields"},{"title":"Rename a custom object","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/objects/{object}","href":"/rest-api/reference/objects/rename-a-custom-object"}]},{"group":"accounts","pages":[{"title":"List accounts","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/objects/account/records","href":"/rest-api/reference/accounts/list-accounts"},{"title":"Update the matching account, or create it","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json put /v1/objects/account/records","href":"/rest-api/reference/accounts/update-the-matching-account-or-create-it"},{"title":"Create an account","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/objects/account/records","href":"/rest-api/reference/accounts/create-an-account"},{"title":"Update up to 100 accounts, each with its own values","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/objects/account/records/batch/update","href":"/rest-api/reference/accounts/update-up-to-100-accounts-each-with-its-own-values"},{"title":"Search accounts with AND/OR filters","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/objects/account/records/search","href":"/rest-api/reference/accounts/search-accounts-with-andor-filters"},{"title":"Get one account","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/objects/account/records/{account_id}","href":"/rest-api/reference/accounts/get-one-account"},{"title":"Delete an account","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json delete /v1/objects/account/records/{account_id}","href":"/rest-api/reference/accounts/delete-an-account"},{"title":"Update an account","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/objects/account/records/{account_id}","href":"/rest-api/reference/accounts/update-an-account"}]},{"group":"contacts","pages":[{"title":"List contacts","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/objects/contact/records","href":"/rest-api/reference/contacts/list-contacts"},{"title":"Update the contact with an address, or create it","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json put /v1/objects/contact/records","href":"/rest-api/reference/contacts/update-the-contact-with-an-address-or-create-it"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/objects/contact/records","href":"/rest-api/reference/contacts/create-a-contact"},{"title":"Update up to 100 contacts, each with its own values","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/objects/contact/records/batch/update","href":"/rest-api/reference/contacts/update-up-to-100-contacts-each-with-its-own-values"},{"title":"Search contacts with AND/OR filters","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/objects/contact/records/search","href":"/rest-api/reference/contacts/search-contacts-with-andor-filters"},{"title":"Get one contact","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/objects/contact/records/{contact_id}","href":"/rest-api/reference/contacts/get-one-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/objects/contact/records/{contact_id}","href":"/rest-api/reference/contacts/update-a-contact"}]},{"group":"opportunities","pages":[{"title":"List opportunities","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/objects/opportunity/records","href":"/rest-api/reference/opportunities/list-opportunities"},{"title":"Update the matching opportunity, or create it","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json put /v1/objects/opportunity/records","href":"/rest-api/reference/opportunities/update-the-matching-opportunity-or-create-it"},{"title":"Create an opportunity","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/objects/opportunity/records","href":"/rest-api/reference/opportunities/create-an-opportunity"},{"title":"Update up to 100 opportunities, each with its own values","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/objects/opportunity/records/batch/update","href":"/rest-api/reference/opportunities/update-up-to-100-opportunities-each-with-its-own-values"},{"title":"Search opportunities with AND/OR filters","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/objects/opportunity/records/search","href":"/rest-api/reference/opportunities/search-opportunities-with-andor-filters"},{"title":"Get one opportunity","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/objects/opportunity/records/{opportunity_id}","href":"/rest-api/reference/opportunities/get-one-opportunity"},{"title":"Delete an opportunity","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json delete /v1/objects/opportunity/records/{opportunity_id}","href":"/rest-api/reference/opportunities/delete-an-opportunity"},{"title":"Update an opportunity","description":"Changes only the keys sent: standard fields at the top level (name, description, stage, type, amount, close_date, owner), custom fields under `fields`. `null` clears a field that may be empty: not name, stage or type, nor a mandatory custom field. A change to a standard field is the app's own edit: until your CRM has received it, the CRM sync does not overwrite the opportunity. Where your workspace syncs opportunities with Salesforce or HubSpot (describe's `syncs_to_crm` says which fields) and the account is linked to an account in that CRM (a company, in HubSpot), the next push sends name, amount, stage, type and close date, plus owner to Salesforce (never description), and creates the opportunity there if it has no `crm_opportunity_id` yet. An update that sends only `fields` leaves the standard fields to the CRM sync. A new `stage` sets `is_closed` and `is_won` from that stage. Every key is checked before anything is written, and any problem refuses the whole request with a 422 listing each one in `details`: a stage outside your stage list (where one is set up), an owner who is not a user, a field describe marks `writable: false`. Once the keys pass, your admin's validation rules run over the merged record; a change that breaks one is a 422 whose `details` name each rule, and nothing is written. The API does not move an opportunity to another account (`account` is not writable); your CRM sync may. Returns the updated opportunity.","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/objects/opportunity/records/{opportunity_id}","href":"/rest-api/reference/opportunities/update-an-opportunity"}]},{"group":"projects","pages":[{"title":"List projects","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/objects/project/records","href":"/rest-api/reference/projects/list-projects"},{"title":"Create a project","description":"Creates a project and returns it with 201: the app's own create, with `source` statisfy and no creator. `title` is required. `account` (a live account's id), `description`, `priority` (low, medium or high), `start_date` (today, US Pacific, when not sent), `due_date` (30 days from now when not sent), `assignee` (a user's id), `status` (a status's name) and custom fields under `fields` are optional; the project may not end before it starts, defaults included. Without `status`, it starts in your workspace's `TODO` status unless its template has a status template (below); a sent `status` must be one of that template's statuses. With `template` (an id from GET /v1/project_templates) it is made from that template, as in the app: its tasks are created, scheduled from `start_date`; it starts in the first status of the template's status template, if it has one; it is due the template's number of days from now when `due_date` is not sent; a template for an account's projects needs `account`, and one that assigns the project from an account field needs that field filled on the account (a sent `assignee` still wins). A template task the app refuses is skipped and named in the answer's `warnings`: its subtasks are created at the top level, and its dependencies are left out. `warnings` also names a task created without its custom values and a custom field the template names that no longer exists. Every key is checked before anything is written, and any problem refuses the whole request with a 422 listing each one in `details`. A 500 that says the project was created names it in `details` (`project_ids`): do not create it again. Send an `Idempotency-Key` header to make a retry safe: the same key replays the first answer, including such a 500.","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/objects/project/records","href":"/rest-api/reference/projects/create-a-project"},{"title":"Update up to 100 projects, each with its own values","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/objects/project/records/batch/update","href":"/rest-api/reference/projects/update-up-to-100-projects-each-with-its-own-values"},{"title":"Search projects with AND/OR filters","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/objects/project/records/search","href":"/rest-api/reference/projects/search-projects-with-andor-filters"},{"title":"Get one project","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/objects/project/records/{project_id}","href":"/rest-api/reference/projects/get-one-project"},{"title":"Delete a project","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json delete /v1/objects/project/records/{project_id}","href":"/rest-api/reference/projects/delete-a-project"},{"title":"Update a project","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/objects/project/records/{project_id}","href":"/rest-api/reference/projects/update-a-project"},{"title":"Add a custom field to a project","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json put /v1/objects/project/records/{project_id}/fields/{field_key}","href":"/rest-api/reference/projects/add-a-custom-field-to-a-project"},{"title":"Remove a custom field from a project","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json delete /v1/objects/project/records/{project_id}/fields/{field_key}","href":"/rest-api/reference/projects/remove-a-custom-field-from-a-project"},{"title":"List project templates","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/project_templates","href":"/rest-api/reference/projects/list-project-templates"},{"title":"Add a custom field to a project template","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json put /v1/project_templates/{template_id}/fields/{field_key}","href":"/rest-api/reference/projects/add-a-custom-field-to-a-project-template"},{"title":"Remove a custom field from a project template","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json delete /v1/project_templates/{template_id}/fields/{field_key}","href":"/rest-api/reference/projects/remove-a-custom-field-from-a-project-template"}]},{"group":"tasks","pages":[{"title":"List tasks","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/objects/task/records","href":"/rest-api/reference/tasks/list-tasks"},{"title":"Create a task","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/objects/task/records","href":"/rest-api/reference/tasks/create-a-task"},{"title":"Update up to 100 tasks, each with its own values","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/objects/task/records/batch/update","href":"/rest-api/reference/tasks/update-up-to-100-tasks-each-with-its-own-values"},{"title":"Search tasks with AND/OR filters","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/objects/task/records/search","href":"/rest-api/reference/tasks/search-tasks-with-andor-filters"},{"title":"Get one task","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/objects/task/records/{task_id}","href":"/rest-api/reference/tasks/get-one-task"},{"title":"Delete a task","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json delete /v1/objects/task/records/{task_id}","href":"/rest-api/reference/tasks/delete-a-task"},{"title":"Update a task","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/objects/task/records/{task_id}","href":"/rest-api/reference/tasks/update-a-task"}]},{"group":"users","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/objects/user/records","href":"/rest-api/reference/users/list-users"},{"title":"Update up to 100 users, each with its own values","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/objects/user/records/batch/update","href":"/rest-api/reference/users/update-up-to-100-users-each-with-its-own-values"},{"title":"Search users with AND/OR filters","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/objects/user/records/search","href":"/rest-api/reference/users/search-users-with-andor-filters"},{"title":"Get one user","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/objects/user/records/{user_id}","href":"/rest-api/reference/users/get-one-user"},{"title":"Update a user","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/objects/user/records/{user_id}","href":"/rest-api/reference/users/update-a-user"}]},{"group":"custom_objects","pages":[{"title":"List a custom object's records","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/objects/{object}/records","href":"/rest-api/reference/custom_objects/list-a-custom-objects-records"},{"title":"Create or update a custom object record by external_id","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json put /v1/objects/{object}/records","href":"/rest-api/reference/custom_objects/create-or-update-a-custom-object-record-by-external_id"},{"title":"Create a custom object record","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/objects/{object}/records","href":"/rest-api/reference/custom_objects/create-a-custom-object-record"},{"title":"Update many custom object records","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/objects/{object}/records/batch/update","href":"/rest-api/reference/custom_objects/update-many-custom-object-records"},{"title":"Search a custom object's records with AND/OR filters","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/objects/{object}/records/search","href":"/rest-api/reference/custom_objects/search-a-custom-objects-records-with-andor-filters"},{"title":"Get one custom object record","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/objects/{object}/records/{record_id}","href":"/rest-api/reference/custom_objects/get-one-custom-object-record"},{"title":"Delete a custom object record","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json delete /v1/objects/{object}/records/{record_id}","href":"/rest-api/reference/custom_objects/delete-a-custom-object-record"},{"title":"Update a custom object record","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/objects/{object}/records/{record_id}","href":"/rest-api/reference/custom_objects/update-a-custom-object-record"}]},{"group":"outreach_emails","pages":[{"title":"List outreach emails","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/outreach_emails","href":"/rest-api/reference/outreach_emails/list-outreach-emails"},{"title":"Count outreach emails and what became of them","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/outreach_emails/stats","href":"/rest-api/reference/outreach_emails/count-outreach-emails-and-what-became-of-them"},{"title":"Get one outreach email","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/outreach_emails/{email_id}","href":"/rest-api/reference/outreach_emails/get-one-outreach-email"}]},{"group":"products","pages":[{"title":"List products and their dimensions","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/products","href":"/rest-api/reference/products/list-products-and-their-dimensions"},{"title":"Create or update a product and its dimensions","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json put /v1/products","href":"/rest-api/reference/products/create-or-update-a-product-and-its-dimensions"},{"title":"Create a product","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/products","href":"/rest-api/reference/products/create-a-product"},{"title":"Get one product and its dimensions","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/products/{product_id}","href":"/rest-api/reference/products/get-one-product-and-its-dimensions"},{"title":"Delete a product","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json delete /v1/products/{product_id}","href":"/rest-api/reference/products/delete-a-product"},{"title":"Update a product","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/products/{product_id}","href":"/rest-api/reference/products/update-a-product"},{"title":"Add a dimension to a product","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/products/{product_id}/dimensions","href":"/rest-api/reference/products/add-a-dimension-to-a-product"},{"title":"Delete a dimension","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json delete /v1/products/{product_id}/dimensions/{dimension_id}","href":"/rest-api/reference/products/delete-a-dimension"},{"title":"Update a dimension","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/products/{product_id}/dimensions/{dimension_id}","href":"/rest-api/reference/products/update-a-dimension"}]},{"group":"usage","pages":[{"title":"List a product's usage values","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/products/{product_id}/usage","href":"/rest-api/reference/usage/list-a-products-usage-values"},{"title":"Write a product's usage values","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/products/{product_id}/usage","href":"/rest-api/reference/usage/write-a-products-usage-values"}]},{"group":"reports","pages":[{"title":"List reports","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/reports","href":"/rest-api/reference/reports/list-reports"},{"title":"Create a report","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/reports","href":"/rest-api/reference/reports/create-a-report"},{"title":"Run report SQL","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/reports/query","href":"/rest-api/reference/reports/run-report-sql"},{"title":"List report views","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/reports/sources","href":"/rest-api/reference/reports/list-report-views"},{"title":"Get one report","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/reports/{report_id}","href":"/rest-api/reference/reports/get-one-report"},{"title":"Delete a report","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json delete /v1/reports/{report_id}","href":"/rest-api/reference/reports/delete-a-report"},{"title":"Change a report","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/reports/{report_id}","href":"/rest-api/reference/reports/change-a-report"},{"title":"Add a widget to a report","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/reports/{report_id}/widgets","href":"/rest-api/reference/reports/add-a-widget-to-a-report"},{"title":"Delete a widget","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json delete /v1/reports/{report_id}/widgets/{widget_id}","href":"/rest-api/reference/reports/delete-a-widget"},{"title":"Change a widget","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/reports/{report_id}/widgets/{widget_id}","href":"/rest-api/reference/reports/change-a-widget"}]},{"group":"sender_domains","pages":[{"title":"List sender domains","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/sender-domains","href":"/rest-api/reference/sender_domains/list-sender-domains"},{"title":"Add a sender domain","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/sender-domains","href":"/rest-api/reference/sender_domains/add-a-sender-domain"},{"title":"Get one sender domain","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/sender-domains/{domain}","href":"/rest-api/reference/sender_domains/get-one-sender-domain"},{"title":"Remove a sender domain","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json delete /v1/sender-domains/{domain}","href":"/rest-api/reference/sender_domains/remove-a-sender-domain"},{"title":"Verify a sender domain","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/sender-domains/{domain}/verify","href":"/rest-api/reference/sender_domains/verify-a-sender-domain"}]},{"group":"settings","pages":[{"title":"Get the workspace settings","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/settings","href":"/rest-api/reference/settings/get-the-workspace-settings"},{"title":"Change workspace settings","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/settings","href":"/rest-api/reference/settings/change-workspace-settings"},{"title":"Get the Company Context","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/settings/company-context","href":"/rest-api/reference/settings/get-the-company-context"},{"title":"Get the CRM write-back settings","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/settings/crm-sync","href":"/rest-api/reference/settings/get-the-crm-write-back-settings"},{"title":"List the workspace's features","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/settings/features","href":"/rest-api/reference/settings/list-the-workspaces-features"},{"title":"Get the health settings","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/settings/health","href":"/rest-api/reference/settings/get-the-health-settings"},{"title":"List the workspace's licenses","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/settings/licenses","href":"/rest-api/reference/settings/list-the-workspaces-licenses"},{"title":"List who holds a seat","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/settings/licenses/{license_id}/users","href":"/rest-api/reference/settings/list-who-holds-a-seat"},{"title":"Get the renewal settings","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/settings/renewals","href":"/rest-api/reference/settings/get-the-renewal-settings"}]},{"group":"skills","pages":[{"title":"List skills","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/skills","href":"/rest-api/reference/skills/list-skills"},{"title":"Create a skill","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/skills","href":"/rest-api/reference/skills/create-a-skill"},{"title":"Get one skill","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/skills/{key}","href":"/rest-api/reference/skills/get-one-skill"},{"title":"Archive a skill","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json delete /v1/skills/{key}","href":"/rest-api/reference/skills/archive-a-skill"},{"title":"Change a skill","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/skills/{key}","href":"/rest-api/reference/skills/change-a-skill"},{"title":"Copy a skill","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/skills/{key}/clone","href":"/rest-api/reference/skills/copy-a-skill"},{"title":"Read one of a skill's files","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/skills/{key}/file","href":"/rest-api/reference/skills/read-one-of-a-skills-files"},{"title":"Make a version live","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/skills/{key}/live","href":"/rest-api/reference/skills/make-a-version-live"},{"title":"List a skill's versions","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/skills/{key}/versions","href":"/rest-api/reference/skills/list-a-skills-versions"},{"title":"Get one version of a skill","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/skills/{key}/versions/{version}","href":"/rest-api/reference/skills/get-one-version-of-a-skill"},{"title":"Read a file of one version","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/skills/{key}/versions/{version}/file","href":"/rest-api/reference/skills/read-a-file-of-one-version"}]},{"group":"surveys","pages":[{"title":"List surveys","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/surveys","href":"/rest-api/reference/surveys/list-surveys"},{"title":"Create a survey","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/surveys","href":"/rest-api/reference/surveys/create-a-survey"},{"title":"Get one survey","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/surveys/{survey_id}","href":"/rest-api/reference/surveys/get-one-survey"},{"title":"Delete a survey","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json delete /v1/surveys/{survey_id}","href":"/rest-api/reference/surveys/delete-a-survey"},{"title":"Change or publish a survey","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/surveys/{survey_id}","href":"/rest-api/reference/surveys/change-or-publish-a-survey"},{"title":"Duplicate a survey","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/surveys/{survey_id}/duplicate","href":"/rest-api/reference/surveys/duplicate-a-survey"},{"title":"List a survey's responses","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/surveys/{survey_id}/responses","href":"/rest-api/reference/surveys/list-a-surveys-responses"}]},{"group":"templates","pages":[{"title":"List email templates","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/templates","href":"/rest-api/reference/templates/list-email-templates"},{"title":"Create an email template","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/templates","href":"/rest-api/reference/templates/create-an-email-template"},{"title":"List merge tags","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/templates/merge-tags","href":"/rest-api/reference/templates/list-merge-tags"},{"title":"Get one email template","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/templates/{template_id}","href":"/rest-api/reference/templates/get-one-email-template"},{"title":"Delete an email template","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json delete /v1/templates/{template_id}","href":"/rest-api/reference/templates/delete-an-email-template"},{"title":"Change an email template","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json patch /v1/templates/{template_id}","href":"/rest-api/reference/templates/change-an-email-template"},{"title":"Preview an email template","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/templates/{template_id}/preview","href":"/rest-api/reference/templates/preview-an-email-template"}]},{"group":"views","pages":[{"title":"List saved views and segments","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/views","href":"/rest-api/reference/views/list-saved-views-and-segments"},{"title":"List every member's saved views and segments","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/views/all","href":"/rest-api/reference/views/list-every-members-saved-views-and-segments"},{"title":"Get one saved view or segment","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json get /v1/views/{view_id}","href":"/rest-api/reference/views/get-one-saved-view-or-segment"},{"title":"Change a view's owner","deprecated":null,"version":null,"openapi":"/api/statisfy-api.openapi.json post /v1/views/{view_id}/owner","href":"/rest-api/reference/views/change-a-views-owner"}]}]}]},{"tab":"AI Support","hidden":true,"pages":[{"title":"AI Support","href":"/ai-support/overview"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/overview"}]}]},"basePath":"","title":"List projects - Statisfy","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BgGj2PGS.js","utils-BhNOqRKb.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BAgRNUZo.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CGkb0TPw.js","snippetPresets-ChLkL1a6.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-Ef10Jrbx.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DlVCnjU8.js","shallow-BA55zJxQ.js","getApiPlaygroundDisplay-DR09dKtp.js","CodeSnippet-BZ8J8Kll.js","CodeSnippets-CcguVheG.js","Page-C7x-eUfk.js","getPastedJson-D5UqeqBp.js","icon-DpD0l99C.js","MethodPill-Wg2NXsp_.js","DuplicateIcon-CCSyX8lh.js","createIcon-C4Ukv9HX.js","DynamicMarkdown-RhjEuCHC.js","SectionHeading-DL1MykRq.js","axios-vUo_bRtp.js","Markdown-BwQ4RMdp.js","dist-CiVXVcSh.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-Dic2Jtb2.js"]}