{"items":[{"type":"link","label":"Grinfi.io API","link":"/openapi","routeSlug":"/openapi","content":{"contentType":"overview","meta":{"name":"Grinfi.io API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://grinfi.io","url":"https://grinfi.io"},{"kind":"email","title":"Grinfi.io Support","email":"support@grinfi.io","label":"support@grinfi.io","withCopyButton":true,"copyContent":"support@grinfi.io"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Copyright","url":"https://grinfi.io/terms"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Grinfi.io API (2.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Complete API reference for Grinfi.io — the all-in-one LinkedIn & email outreach platform."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this API to manage your CRM contacts, run outreach automations, send messages, and integrate Grinfi with your own tools."},"children":[]}]}]}]}],"sectionId":"/openapi"}],"sectionId":"/openapi"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All requests require a Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"leadgen.grinfi.io"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Go to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings → API Keys"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Copy your key and pass it as:"},"children":[]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Bearer YOUR_API_KEY\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Bearer YOUR_API_KEY\n"},"children":[]}]}]}]}]}],"sectionId":"/openapi/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/pagination"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List endpoints support "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default 20) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"offset"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default 0) query parameters. Responses include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" count and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_more"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" boolean."},"children":[]}]}]}]}],"sectionId":"/openapi/section/pagination"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/filtering"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most list endpoints accept a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object. Supported value types:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Type | Example | SQL equivalent | |------|---------|----------------| | Scalar | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"status\": \"ok\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"= 'ok'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | | Array | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"status\": [\"ok\", \"pending\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN ('ok', 'pending')"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | | Object | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"created_at\": {\">=\": \"2024-01-01\"}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">= '2024-01-01'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"is_null\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"email\": \"is_null\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IS NULL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"is_not_null\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"email\": \"is_not_null\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IS NOT NULL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" |"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported operators: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"!="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<>"},"children":[]}]}]}]}],"sectionId":"/openapi/section/filtering"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/rate-limits"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Limits"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API requests are rate-limited to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"300 requests per minute"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" per API key. If you exceed the limit, you'll receive a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response. Use exponential backoff when retrying."},"children":[]}]}]}]}],"sectionId":"/openapi/section/rate-limits"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/contact-deduplication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact Deduplication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating contacts via upsert, the system checks for duplicates using the following field priority (first match wins):"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ln_member_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (LinkedIn member ID)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ln_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (LinkedIn public ID)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sn_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Sales Navigator ID)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LinkedIn nickname"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"work_email"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"personal_email"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" combination"},"children":[]}]}]}]}]}],"sectionId":"/openapi/section/contact-deduplication"}]}]}},{"type":"link","label":"Authentication","link":"/openapi/section/authentication","routeSlug":"/openapi/section/authentication","content":null},{"type":"link","label":"Pagination","link":"/openapi/section/pagination","routeSlug":"/openapi/section/pagination","content":null},{"type":"link","label":"Filtering","link":"/openapi/section/filtering","routeSlug":"/openapi/section/filtering","content":null},{"type":"link","label":"Rate Limits","link":"/openapi/section/rate-limits","routeSlug":"/openapi/section/rate-limits","content":null},{"type":"link","label":"Contact Deduplication","link":"/openapi/section/contact-deduplication","routeSlug":"/openapi/section/contact-deduplication","content":null},{"type":"separator","label":"Account","content":null},{"type":"group","label":"User","link":"/openapi/user","routeSlug":"/openapi/user","items":[{"label":"Get current user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/user/getcurrentuser","routeSlug":"/openapi/user/getcurrentuser","metadata":{"seo":{"title":"Get current user","description":"Retrieve the authenticated user's profile and configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCurrentUser","name":"Get current user","isWebhook":false,"pointer":"/paths/~1id~1api~1users~1current/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get current user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the authenticated user's profile and configuration."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/id/api/users/current","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/id/api/users/current","href":"user/getcurrentuser","openApiOperationId":"getCurrentUser","summary":"Get current user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current user profile.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/user"}},"schemaId":"components/schemas/user"}],"pointer":"/paths/~1id~1api~1users~1current/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/user","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/user"}}}],"examples":[]}]}]}]},"httpPath":"/id/api/users/current"}],"content":{"contentType":"group","meta":{"name":"User"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User","showPageActions":true},{"nodeType":"markdoc","content":"Get current authenticated user profile."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/id/api/users/current","summary":"Get current user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user/getcurrentuser","deprecated":false}]}]}]}]}},{"type":"group","label":"Teams","link":"/openapi/teams","routeSlug":"/openapi/teams","items":[{"label":"List teams","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/teams/listteams","routeSlug":"/openapi/teams/listteams","metadata":{"seo":{"title":"List teams","description":"List all teams (workspaces) the authenticated user has access to."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTeams","name":"List teams","isWebhook":false,"pointer":"/paths/~1id~1api~1teams/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List teams","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all teams (workspaces) the authenticated user has access to."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_153","description":"Items per page (default 20)."},{"name":"offset","in":"query","schemaId":"schema_154","description":"Items to skip (default 0)."}],"pointer":"/paths/~1id~1api~1teams/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/id/api/teams","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_153"},{"name":"offset","in":"query","required":false,"example":0,"schemaId":"schema_154"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/id/api/teams","href":"teams/listteams","openApiOperationId":"listTeams","summary":"List teams"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of teams.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_155"}},"schemaId":"schema_155"}],"pointer":"/paths/~1id~1api~1teams/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_155","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_155"}}}],"examples":[]}]}]}]},"httpPath":"/id/api/teams"},{"label":"Get a team","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/teams/getteam","routeSlug":"/openapi/teams/getteam","metadata":{"seo":{"title":"Get a team","description":"Get details of a specific team by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTeam","name":"Get a team","isWebhook":false,"pointer":"/paths/~1id~1api~1teams~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a team","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get details of a specific team by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_156","description":"Team ID.","required":true}],"pointer":"/paths/~1id~1api~1teams~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/id/api/teams/{id}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_156"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/id/api/teams/{id}","href":"teams/getteam","openApiOperationId":"getTeam","summary":"Get a team"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Team details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/team"}},"schemaId":"components/schemas/team"},{"code":"404","description":"Team not found."}],"pointer":"/paths/~1id~1api~1teams~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/team","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/team"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/id/api/teams/{id}"},{"label":"Check sender profile capacity","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/teams/checkteamlimits","routeSlug":"/openapi/teams/checkteamlimits","metadata":{"seo":{"title":"Check sender profile capacity","description":"Check whether the team has capacity for the requested number of additional sender profiles within its current subscription limits. Returns monthly and yearly usage information (or null for each if the team has no active subscription on that cycle)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"checkTeamLimits","name":"Check sender profile capacity","isWebhook":false,"pointer":"/paths/~1id~1api~1teams~1{id}~1check-limits/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check sender profile capacity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check whether the team has capacity for the requested number of additional sender profiles within its current subscription limits. Returns monthly and yearly usage information (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for each if the team has no active subscription on that cycle)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_156","description":"Team ID.","required":true}],"pointer":"/paths/~1id~1api~1teams~1{id}~1check-limits/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_157"}},"schemaId":"schema_157","pointer":"/paths/~1id~1api~1teams~1{id}~1check-limits/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/id/api/teams/{id}/check-limits","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_156"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_157"}},"responseCodes":["200","402","422"],"pointer":"/id/api/teams/{id}/check-limits","href":"teams/checkteamlimits","openApiOperationId":"checkTeamLimits","summary":"Check sender profile capacity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_157","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_157"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Capacity information.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_158"}},"schemaId":"schema_158"},{"code":"402","description":"Insufficient capacity within the current subscription."},{"code":"422","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1id~1api~1teams~1{id}~1check-limits/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_158","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_158"}}},{"code":"402"},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/id/api/teams/{id}/check-limits"}],"content":{"contentType":"group","meta":{"name":"Teams"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Teams","showPageActions":true},{"nodeType":"markdoc","content":"Manage workspaces (teams). Each team has its own contacts, automations, and sender profiles."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/id/api/teams","summary":"List teams","prefix":{"name":"get","color":"get"},"badges":[],"link":"/teams/listteams","deprecated":false},{"title":"/id/api/teams/{id}","summary":"Get a team","prefix":{"name":"get","color":"get"},"badges":[],"link":"/teams/getteam","deprecated":false},{"title":"/id/api/teams/{id}/check-limits","summary":"Check sender profile capacity","prefix":{"name":"post","color":"post"},"badges":[],"link":"/teams/checkteamlimits","deprecated":false}]}]}]}]}},{"type":"group","label":"API Keys","link":"/openapi/api-keys","routeSlug":"/openapi/api-keys","items":[{"label":"Create an API key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/api-keys/createapikey","routeSlug":"/openapi/api-keys/createapikey","metadata":{"seo":{"title":"Create an API key","description":"Create a new API key bound to your current team. The returned last_token is the actual JWT to use in the Authorization: Bearer <token> header on subsequent requests. Tokens have a 3-year expiry."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createApiKey","name":"Create an API key","isWebhook":false,"pointer":"/paths/~1id~1api~1jwt-tokens~1create-api-key/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an API key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new API key bound to your current team. The returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the actual JWT to use in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header on subsequent requests. Tokens have a 3-year expiry."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" save the token immediately — it is only returned in this response and cannot be retrieved later."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_159"}},"schemaId":"schema_159","pointer":"/paths/~1id~1api~1jwt-tokens~1create-api-key/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/id/api/jwt-tokens/create-api-key","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_159"}},"responseCodes":["200","422"],"pointer":"/id/api/jwt-tokens/create-api-key","href":"api-keys/createapikey","openApiOperationId":"createApiKey","summary":"Create an API key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_159","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_159"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"API key created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_160"}},"schemaId":"schema_160"},{"code":"422","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1id~1api~1jwt-tokens~1create-api-key/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_160","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_160"}}},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/id/api/jwt-tokens/create-api-key"}],"content":{"contentType":"group","meta":{"name":"API Keys"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"API Keys","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create API keys to authenticate against the Grinfi API. Each key is a JWT token bound to your current team with a 3-year expiry. Pass the key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header on every request."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/id/api/jwt-tokens/create-api-key","summary":"Create an API key","prefix":{"name":"post","color":"post"},"badges":[],"link":"/api-keys/createapikey","deprecated":false}]}]}]}]}},{"type":"separator","label":"CRM","content":null},{"type":"group","label":"Contacts","link":"/openapi/contacts","routeSlug":"/openapi/contacts","items":[{"label":"Find a contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contacts/findonecontact","routeSlug":"/openapi/contacts/findonecontact","metadata":{"seo":{"title":"Find a contact","description":"Look up a single contact by LinkedIn ID, email address, or name + company combination. At least one identifier must be provided. This is useful for checking if a contact already exists before creating a new one."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"findOneContact","name":"Find a contact","isWebhook":false,"pointer":"/paths/~1leads~1api~1leads~1lookup-one/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Find a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Look up a single contact by LinkedIn ID, email address, or name + company combination. At least one identifier must be provided. This is useful for checking if a contact already exists before creating a new one."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_161","exampleIds":["paths/~1leads~1api~1leads~1lookup-one/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_161","exampleIds":["paths/~1leads~1api~1leads~1lookup-one/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1leads~1api~1leads~1lookup-one/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/leads/api/leads/lookup-one","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_161","exampleIds":["paths/~1leads~1api~1leads~1lookup-one/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","404","422"],"pointer":"/leads/api/leads/lookup-one","href":"contacts/findonecontact","openApiOperationId":"findOneContact","summary":"Find a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_161","exampleIds":["paths/~1leads~1api~1leads~1lookup-one/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_161","exampleIds":["paths/~1leads~1api~1leads~1lookup-one/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Contact found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/lead"}},"schemaId":"components/schemas/lead"},{"code":"404","description":"No matching contact found."},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation error — provide at least one identifier."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1leads~1api~1leads~1lookup-one/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/lead","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/lead"}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/leads/lookup-one"},{"label":"Search contacts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contacts/searchcontacts","routeSlug":"/openapi/contacts/searchcontacts","metadata":{"seo":{"title":"Search contacts","description":"Search contacts using advanced filters with pagination and sorting. Use this to find contacts by any combination of fields — name, company, email status, pipeline stage, tags, and more."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchContacts","name":"Search contacts","isWebhook":false,"pointer":"/paths/~1leads~1api~1leads~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search contacts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search contacts using advanced filters with pagination and sorting. Use this to find contacts by any combination of fields — name, company, email status, pipeline stage, tags, and more."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_162","exampleIds":["paths/~1leads~1api~1leads~1search/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_162","exampleIds":["paths/~1leads~1api~1leads~1search/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1leads~1api~1leads~1search/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/leads/api/leads/search","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_162","exampleIds":["paths/~1leads~1api~1leads~1search/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","422"],"pointer":"/leads/api/leads/search","href":"contacts/searchcontacts","openApiOperationId":"searchContacts","summary":"Search contacts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_162","exampleIds":["paths/~1leads~1api~1leads~1search/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_162","exampleIds":["paths/~1leads~1api~1leads~1search/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of matching contacts.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_163"}},"schemaId":"schema_163"},{"code":"422","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1leads~1api~1leads~1search/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_163","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_163"}}},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/leads/search"},{"label":"Get a contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contacts/getlead","routeSlug":"/openapi/contacts/getlead","metadata":{"seo":{"title":"Get a contact","description":"Retrieve full details of a contact by their UUID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLead","name":"Get a contact","isWebhook":false,"pointer":"/paths/~1leads~1api~1leads~1{uuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve full details of a contact by their UUID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1leads~1api~1leads~1{uuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/leads/api/leads/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/leads/api/leads/{uuid}","href":"contacts/getlead","openApiOperationId":"getLead","summary":"Get a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Contact details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/lead"}},"schemaId":"components/schemas/lead"},{"code":"404","description":"Contact not found."}],"pointer":"/paths/~1leads~1api~1leads~1{uuid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/lead","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/lead"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/leads/api/leads/{uuid}"},{"label":"Update a contact","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contacts/updatelead","routeSlug":"/openapi/contacts/updatelead","metadata":{"seo":{"title":"Update a contact","description":"Update one or more fields on an existing contact. Only include the fields you want to change."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateLead","name":"Update a contact","isWebhook":false,"pointer":"/paths/~1leads~1api~1leads~1{uuid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update one or more fields on an existing contact. Only include the fields you want to change."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" this endpoint only accepts the standard contact fields listed below. Custom field values are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"silently ignored"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". To set custom fields use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Custom-Fields/operation/upsertCustomFieldValue"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /leads/api/custom-field-values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Alternatively, the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Contacts/operation/upsertContact"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upsert endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in a single request."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1leads~1api~1leads~1{uuid}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_165"}},"schemaId":"schema_165","pointer":"/paths/~1leads~1api~1leads~1{uuid}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/leads/api/leads/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_165"}},"responseCodes":["200","404"],"pointer":"/leads/api/leads/{uuid}","href":"contacts/updatelead","openApiOperationId":"updateLead","summary":"Update a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_165","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_165"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated contact.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/lead"}},"schemaId":"components/schemas/lead"},{"code":"404","description":"Contact not found."}],"pointer":"/paths/~1leads~1api~1leads~1{uuid}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/lead","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/lead"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/leads/api/leads/{uuid}"},{"label":"Delete a contact","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contacts/deletelead","routeSlug":"/openapi/contacts/deletelead","metadata":{"seo":{"title":"Delete a contact","description":"Permanently delete a contact by UUID. This creates a background deletion job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteLead","name":"Delete a contact","isWebhook":false,"pointer":"/paths/~1leads~1api~1leads~1{uuid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Permanently delete a contact by UUID. This creates a background deletion job."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1leads~1api~1leads~1{uuid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/leads/api/leads/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","422"],"pointer":"/leads/api/leads/{uuid}","href":"contacts/deletelead","openApiOperationId":"deleteLead","summary":"Delete a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Contact deleted."},{"code":"422","description":"Unable to process deletion.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1leads~1api~1leads~1{uuid}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/leads/{uuid}"},{"label":"Create or update a contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contacts/upsertcontact","routeSlug":"/openapi/contacts/upsertcontact","metadata":{"seo":{"title":"Create or update a contact","description":"Create a new contact in a list, or update an existing one if found. The contact is identified by linkedin_id. If the contact already exists and update_if_exists is true, their data will be updated. Optionally move the contact to the specified list with move_to_list."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertContact","name":"Create or update a contact","isWebhook":false,"pointer":"/paths/~1leads~1api~1leads~1upsert/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or update a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new contact in a list, or update an existing one if found. The contact is identified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the contact already exists and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"update_if_exists"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is true, their data will be updated. Optionally move the contact to the specified list with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"move_to_list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tip:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Unlike "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT /leads/api/leads/{uuid}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this endpoint accepts "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom_fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so you can set standard and custom fields in a single request."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_166","exampleIds":["paths/~1leads~1api~1leads~1upsert/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_166","exampleIds":["paths/~1leads~1api~1leads~1upsert/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1leads~1api~1leads~1upsert/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/leads/api/leads/upsert","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_166","exampleIds":["paths/~1leads~1api~1leads~1upsert/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","422"],"pointer":"/leads/api/leads/upsert","href":"contacts/upsertcontact","openApiOperationId":"upsertContact","summary":"Create or update a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_166","exampleIds":["paths/~1leads~1api~1leads~1upsert/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_166","exampleIds":["paths/~1leads~1api~1leads~1upsert/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Contact created or updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/lead"}},"schemaId":"components/schemas/lead"},{"code":"422","description":"Validation or duplicate error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1leads~1api~1leads~1upsert/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/lead","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/lead"}}},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/leads/upsert"},{"label":"Mass action on contacts","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contacts/leadsmassaction","routeSlug":"/openapi/contacts/leadsmassaction","metadata":{"seo":{"title":"Mass action on contacts","description":"Perform a bulk action on contacts matching a filter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"leadsMassAction","name":"Mass action on contacts","isWebhook":false,"pointer":"/paths/~1leads~1api~1leads~1mass-action/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Mass action on contacts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Perform a bulk action on contacts matching a filter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported action types:"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| Type | Payload | Description | |------|---------|-------------| | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_add_tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{tag_uuid}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | Add a tag | | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_remove_tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{tag_uuid}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | Remove a tag | | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_replace_tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{tag_uuids: [...]}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | Replace all tags | | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_change_list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{list_uuid}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | Move to a different list | | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_change_pipeline_stage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{pipeline_stage_uuid}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | Change pipeline stage | | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_change_custom_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{custom_field_uuid, value}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | Set custom field value | | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_add_to_flow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{flow_uuid}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | Add to automation | | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_cancel_from_flows"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{flow_uuids: [...]}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | Cancel from automations | | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | — | Delete contacts | | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_export_csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | — | Export to CSV | | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_mark_read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | — | Mark conversations as read |"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_167","exampleIds":["paths/~1leads~1api~1leads~1mass-action/put/requestBody/content/application~1json/example"]}},"schemaId":"schema_167","exampleIds":["paths/~1leads~1api~1leads~1mass-action/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1leads~1api~1leads~1mass-action/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/leads/api/leads/mass-action","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_167","exampleIds":["paths/~1leads~1api~1leads~1mass-action/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","422"],"pointer":"/leads/api/leads/mass-action","href":"contacts/leadsmassaction","openApiOperationId":"leadsMassAction","summary":"Mass action on contacts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_167","exampleIds":["paths/~1leads~1api~1leads~1mass-action/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_167","exampleIds":["paths/~1leads~1api~1leads~1mass-action/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Action executed."},{"code":"422","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1leads~1api~1leads~1mass-action/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/leads/mass-action"},{"label":"Count contacts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contacts/countcontacts","routeSlug":"/openapi/contacts/countcontacts","metadata":{"seo":{"title":"Count contacts","description":"Count contacts matching a filter without returning the full data. Use all: true to count every contact in the team, or pass an explicit list of contact UUIDs in ids (with all: false) to count a specific subset."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"countContacts","name":"Count contacts","isWebhook":false,"pointer":"/paths/~1leads~1api~1leads~1count/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Count contacts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Count contacts matching a filter without returning the full data. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to count every contact in the team, or pass an explicit list of contact UUIDs in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") to count a specific subset."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_168","exampleIds":["paths/~1leads~1api~1leads~1count/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_168","exampleIds":["paths/~1leads~1api~1leads~1count/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1leads~1api~1leads~1count/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/leads/api/leads/count","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_168","exampleIds":["paths/~1leads~1api~1leads~1count/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","422"],"pointer":"/leads/api/leads/count","href":"contacts/countcontacts","openApiOperationId":"countContacts","summary":"Count contacts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_168","exampleIds":["paths/~1leads~1api~1leads~1count/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_168","exampleIds":["paths/~1leads~1api~1leads~1count/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Count of matching contacts.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_169"}},"schemaId":"schema_169"},{"code":"422","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1leads~1api~1leads~1count/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_169","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_169"}}},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/leads/count"},{"label":"Get team-wide engagement metrics","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contacts/getleadmetrics","routeSlug":"/openapi/contacts/getleadmetrics","metadata":{"seo":{"title":"Get team-wide engagement metrics","description":"Returns aggregated outreach metrics across the whole team for the requested period."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLeadMetrics","name":"Get team-wide engagement metrics","isWebhook":false,"pointer":"/paths/~1leads~1api~1leads~1metrics/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get team-wide engagement metrics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns aggregated outreach metrics across the whole team for the requested period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" despite accepting a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, this endpoint currently returns team-wide totals only — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter.sender_profile_uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and other keys are silently ignored. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"group_by"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is also accepted but does not produce a per-group breakdown in the response. Plan for team-level reporting only."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For per-sender activity counts (without period filter), use: - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /flows/api/linkedin-messages/group-counts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter.sender_profile_uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /flows/api/tasks?filter[sender_profile_uuid][]=<uuid>&filter[status][]=<status>"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_170","exampleIds":["paths/~1leads~1api~1leads~1metrics/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_170","exampleIds":["paths/~1leads~1api~1leads~1metrics/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1leads~1api~1leads~1metrics/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/leads/api/leads/metrics","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_170","exampleIds":["paths/~1leads~1api~1leads~1metrics/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","422"],"pointer":"/leads/api/leads/metrics","href":"contacts/getleadmetrics","openApiOperationId":"getLeadMetrics","summary":"Get team-wide engagement metrics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_170","exampleIds":["paths/~1leads~1api~1leads~1metrics/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_170","exampleIds":["paths/~1leads~1api~1leads~1metrics/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Aggregated metrics for the period.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_171"}},"schemaId":"schema_171"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation error — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metrics"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must contain valid enum values."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1leads~1api~1leads~1metrics/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_171","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_171"}}},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/leads/metrics"},{"label":"Run advanced enrichment on contacts","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contacts/enrichleadsadvanced","routeSlug":"/openapi/contacts/enrichleadsadvanced","metadata":{"seo":{"title":"Run advanced enrichment on contacts","description":"Enqueue advanced LinkedIn enrichment on a set of contacts. Enrichment consumes credits — returns 402 Payment Required if your team has insufficient balance."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"enrichLeadsAdvanced","name":"Run advanced enrichment on contacts","isWebhook":false,"pointer":"/paths/~1leads~1api~1leads~1advanced-enrichment/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Run advanced enrichment on contacts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enqueue advanced LinkedIn enrichment on a set of contacts. Enrichment consumes credits — returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"402 Payment Required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if your team has insufficient balance."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_172","exampleIds":["paths/~1leads~1api~1leads~1advanced-enrichment/put/requestBody/content/application~1json/example"]}},"schemaId":"schema_172","exampleIds":["paths/~1leads~1api~1leads~1advanced-enrichment/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1leads~1api~1leads~1advanced-enrichment/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/leads/api/leads/advanced-enrichment","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_172","exampleIds":["paths/~1leads~1api~1leads~1advanced-enrichment/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","402","422"],"pointer":"/leads/api/leads/advanced-enrichment","href":"contacts/enrichleadsadvanced","openApiOperationId":"enrichLeadsAdvanced","summary":"Run advanced enrichment on contacts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_172","exampleIds":["paths/~1leads~1api~1leads~1advanced-enrichment/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_172","exampleIds":["paths/~1leads~1api~1leads~1advanced-enrichment/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Enrichment queued."},{"code":"402","description":"Insufficient credits to perform enrichment."},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation error — provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uuids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1leads~1api~1leads~1advanced-enrichment/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"402"},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/leads/advanced-enrichment"},{"label":"List enrichment queue","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contacts/listenrichmentqueue","routeSlug":"/openapi/contacts/listenrichmentqueue","metadata":{"seo":{"title":"List enrichment queue","description":"List entries in the enrichment processing queue."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEnrichmentQueue","name":"List enrichment queue","isWebhook":false,"pointer":"/paths/~1leads~1api~1enrichment-queue/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List enrichment queue","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List entries in the enrichment processing queue."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_153","description":"Items per page (default 20)."},{"name":"offset","in":"query","schemaId":"schema_154","description":"Items to skip (default 0)."},{"name":"order_field","in":"query","schemaId":"schema_173","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort field (default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"order_type","in":"query","schemaId":"schema_174","description":"Sort direction."}],"pointer":"/paths/~1leads~1api~1enrichment-queue/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/leads/api/enrichment-queue","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_153"},{"name":"offset","in":"query","required":false,"example":0,"schemaId":"schema_154"},{"name":"order_field","in":"query","required":false,"example":"created_at","schemaId":"schema_173"},{"name":"order_type","in":"query","required":false,"example":"asc","schemaId":"schema_174"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/leads/api/enrichment-queue","href":"contacts/listenrichmentqueue","openApiOperationId":"listEnrichmentQueue","summary":"List enrichment queue"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Enrichment queue entries.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_175"}},"schemaId":"schema_175"}],"pointer":"/paths/~1leads~1api~1enrichment-queue/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_175","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_175"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/enrichment-queue"},{"label":"Get enrichment usage metrics","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/contacts/getenrichmentmetrics","routeSlug":"/openapi/contacts/getenrichmentmetrics","metadata":{"seo":{"title":"Get enrichment usage metrics","description":"Return aggregate metrics about enrichment activity for the team — currently the count of enrichment jobs queued/processed in the current calendar month."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEnrichmentMetrics","name":"Get enrichment usage metrics","isWebhook":false,"pointer":"/paths/~1leads~1api~1enrichment-queue~1metrics/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get enrichment usage metrics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return aggregate metrics about enrichment activity for the team — currently the count of enrichment jobs queued/processed in the current calendar month."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_176","exampleIds":["paths/~1leads~1api~1enrichment-queue~1metrics/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_176","exampleIds":["paths/~1leads~1api~1enrichment-queue~1metrics/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1leads~1api~1enrichment-queue~1metrics/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/leads/api/enrichment-queue/metrics","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_176","exampleIds":["paths/~1leads~1api~1enrichment-queue~1metrics/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/leads/api/enrichment-queue/metrics","href":"contacts/getenrichmentmetrics","openApiOperationId":"getEnrichmentMetrics","summary":"Get enrichment usage metrics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_176","exampleIds":["paths/~1leads~1api~1enrichment-queue~1metrics/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_176","exampleIds":["paths/~1leads~1api~1enrichment-queue~1metrics/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Enrichment metrics.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_177"}},"schemaId":"schema_177"}],"pointer":"/paths/~1leads~1api~1enrichment-queue~1metrics/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_177","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_177"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/enrichment-queue/metrics"}],"content":{"contentType":"group","meta":{"name":"Contacts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contacts","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage your CRM contacts (leads). Search, create, update, and organize contacts across lists and pipeline stages."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mass action types"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT /leads/api/leads/mass-action"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_add_tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_remove_tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_replace_tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_change_list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_change_pipeline_stage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_change_custom_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_add_to_flow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_cancel_from_flows"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_export_csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_mark_read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/leads/api/leads/lookup-one","summary":"Find a contact","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/findonecontact","deprecated":false},{"title":"/leads/api/leads/search","summary":"Search contacts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/searchcontacts","deprecated":false},{"title":"/leads/api/leads/{uuid}","summary":"Get a contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/getlead","deprecated":false},{"title":"/leads/api/leads/{uuid}","summary":"Update a contact","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contacts/updatelead","deprecated":false},{"title":"/leads/api/leads/{uuid}","summary":"Delete a contact","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/contacts/deletelead","deprecated":false},{"title":"/leads/api/leads/upsert","summary":"Create or update a contact","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/upsertcontact","deprecated":false},{"title":"/leads/api/leads/mass-action","summary":"Mass action on contacts","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contacts/leadsmassaction","deprecated":false},{"title":"/leads/api/leads/count","summary":"Count contacts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/countcontacts","deprecated":false},{"title":"/leads/api/leads/metrics","summary":"Get team-wide engagement metrics","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/getleadmetrics","deprecated":false},{"title":"/leads/api/leads/advanced-enrichment","summary":"Run advanced enrichment on contacts","prefix":{"name":"put","color":"put"},"badges":[],"link":"/contacts/enrichleadsadvanced","deprecated":false},{"title":"/leads/api/enrichment-queue","summary":"List enrichment queue","prefix":{"name":"get","color":"get"},"badges":[],"link":"/contacts/listenrichmentqueue","deprecated":false},{"title":"/leads/api/enrichment-queue/metrics","summary":"Get enrichment usage metrics","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contacts/getenrichmentmetrics","deprecated":false}]}]}]}]}},{"type":"group","label":"Companies","link":"/openapi/companies","routeSlug":"/openapi/companies","items":[{"label":"List companies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/companies/listcompanies","routeSlug":"/openapi/companies/listcompanies","metadata":{"seo":{"title":"List companies","description":"Retrieve a paginated list of companies in your CRM. Supports filtering by name, domain, industry, and other fields."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCompanies","name":"List companies","isWebhook":false,"pointer":"/paths/~1leads~1api~1companies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List companies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a paginated list of companies in your CRM. Supports filtering by name, domain, industry, and other fields.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_153","description":"Items per page (default 20)."},{"name":"offset","in":"query","schemaId":"schema_154","description":"Items to skip (default 0)."},{"name":"order_field","in":"query","schemaId":"schema_173","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort field (default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"order_type","in":"query","schemaId":"schema_174","description":"Sort direction."},{"name":"filter","in":"query","schemaId":"schema_178","description":"Filters for company search."}],"pointer":"/paths/~1leads~1api~1companies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/leads/api/companies","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_153"},{"name":"offset","in":"query","required":false,"example":0,"schemaId":"schema_154"},{"name":"order_field","in":"query","required":false,"example":"created_at","schemaId":"schema_173"},{"name":"order_type","in":"query","required":false,"example":"asc","schemaId":"schema_174"},{"name":"filter","in":"query","schemaId":"schema_178"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/leads/api/companies","href":"companies/listcompanies","openApiOperationId":"listCompanies","summary":"List companies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of companies.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_179"}},"schemaId":"schema_179"}],"pointer":"/paths/~1leads~1api~1companies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_179","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_179"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/companies"},{"label":"Create companies","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/companies/createcompanies","routeSlug":"/openapi/companies/createcompanies","metadata":{"seo":{"title":"Create companies","description":"Create one or more company records. Optionally assign them to lists and a data source."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCompanies","name":"Create companies","isWebhook":false,"pointer":"/paths/~1leads~1api~1companies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create companies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create one or more company records. Optionally assign them to lists and a data source.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_180","exampleIds":["paths/~1leads~1api~1companies/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_180","exampleIds":["paths/~1leads~1api~1companies/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1leads~1api~1companies/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/leads/api/companies","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_180","exampleIds":["paths/~1leads~1api~1companies/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/leads/api/companies","href":"companies/createcompanies","openApiOperationId":"createCompanies","summary":"Create companies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_180","exampleIds":["paths/~1leads~1api~1companies/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_180","exampleIds":["paths/~1leads~1api~1companies/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Created companies.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_181"}},"schemaId":"schema_181"}],"pointer":"/paths/~1leads~1api~1companies/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_181","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_181"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/companies"},{"label":"Get a company","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/companies/getcompany","routeSlug":"/openapi/companies/getcompany","metadata":{"seo":{"title":"Get a company","description":"Retrieve full details of a company by UUID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCompany","name":"Get a company","isWebhook":false,"pointer":"/paths/~1leads~1api~1companies~1{uuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve full details of a company by UUID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1leads~1api~1companies~1{uuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/leads/api/companies/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/leads/api/companies/{uuid}","href":"companies/getcompany","openApiOperationId":"getCompany","summary":"Get a company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Company details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company"}},"schemaId":"components/schemas/company"},{"code":"404","description":"Company not found."}],"pointer":"/paths/~1leads~1api~1companies~1{uuid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/leads/api/companies/{uuid}"},{"label":"Update a company","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/companies/updatecompany","routeSlug":"/openapi/companies/updatecompany","metadata":{"seo":{"title":"Update a company","description":"Update one or more fields on an existing company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCompany","name":"Update a company","isWebhook":false,"pointer":"/paths/~1leads~1api~1companies~1{uuid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update one or more fields on an existing company."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1leads~1api~1companies~1{uuid}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_182"}},"schemaId":"schema_182","pointer":"/paths/~1leads~1api~1companies~1{uuid}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/leads/api/companies/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_182"}},"responseCodes":["200","404"],"pointer":"/leads/api/companies/{uuid}","href":"companies/updatecompany","openApiOperationId":"updateCompany","summary":"Update a company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_182","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_182"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated company.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company"}},"schemaId":"components/schemas/company"},{"code":"404","description":"Company not found."}],"pointer":"/paths/~1leads~1api~1companies~1{uuid}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/company","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/leads/api/companies/{uuid}"},{"label":"Delete a company","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/companies/deletecompany","routeSlug":"/openapi/companies/deletecompany","metadata":{"seo":{"title":"Delete a company","description":"Permanently delete a company by UUID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCompany","name":"Delete a company","isWebhook":false,"pointer":"/paths/~1leads~1api~1companies~1{uuid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a company","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Permanently delete a company by UUID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1leads~1api~1companies~1{uuid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/leads/api/companies/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","422"],"pointer":"/leads/api/companies/{uuid}","href":"companies/deletecompany","openApiOperationId":"deleteCompany","summary":"Delete a company"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Company deleted."},{"code":"422","description":"Unable to process deletion.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1leads~1api~1companies~1{uuid}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/companies/{uuid}"},{"label":"Search companies","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/companies/searchcompanies","routeSlug":"/openapi/companies/searchcompanies","metadata":{"seo":{"title":"Search companies","description":"Search and filter companies with pagination. Same filtering capabilities as GET /leads/api/companies but as a POST so you can pass complex filter objects in the request body instead of query strings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchCompanies","name":"Search companies","isWebhook":false,"pointer":"/paths/~1leads~1api~1companies~1list/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search companies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search and filter companies with pagination. Same filtering capabilities as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /leads/api/companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but as a POST so you can pass complex "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects in the request body instead of query strings."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_183","exampleIds":["paths/~1leads~1api~1companies~1list/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_183","exampleIds":["paths/~1leads~1api~1companies~1list/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1leads~1api~1companies~1list/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/leads/api/companies/list","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_183","exampleIds":["paths/~1leads~1api~1companies~1list/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","422"],"pointer":"/leads/api/companies/list","href":"companies/searchcompanies","openApiOperationId":"searchCompanies","summary":"Search companies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_183","exampleIds":["paths/~1leads~1api~1companies~1list/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_183","exampleIds":["paths/~1leads~1api~1companies~1list/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of matching companies.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_184"}},"schemaId":"schema_184"},{"code":"422","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1leads~1api~1companies~1list/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_184","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_184"}}},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/companies/list"},{"label":"Lookup companies","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/companies/lookupcompanies","routeSlug":"/openapi/companies/lookupcompanies","metadata":{"seo":{"title":"Lookup companies","description":"Find companies by LinkedIn ID, website URL, or name. Pass an array of lookup criteria — each item should contain at least one identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"lookupCompanies","name":"Lookup companies","isWebhook":false,"pointer":"/paths/~1leads~1api~1companies~1lookup/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lookup companies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Find companies by LinkedIn ID, website URL, or name. Pass an array of lookup criteria — each item should contain at least one identifier."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_185","exampleIds":["paths/~1leads~1api~1companies~1lookup/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_185","exampleIds":["paths/~1leads~1api~1companies~1lookup/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1leads~1api~1companies~1lookup/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/leads/api/companies/lookup","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_185","exampleIds":["paths/~1leads~1api~1companies~1lookup/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/leads/api/companies/lookup","href":"companies/lookupcompanies","openApiOperationId":"lookupCompanies","summary":"Lookup companies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_185","exampleIds":["paths/~1leads~1api~1companies~1lookup/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_185","exampleIds":["paths/~1leads~1api~1companies~1lookup/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Matching companies.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_181"}},"schemaId":"schema_181"}],"pointer":"/paths/~1leads~1api~1companies~1lookup/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_181","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_181"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/companies/lookup"},{"label":"Get contacts by companies","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/companies/getcompanyleads","routeSlug":"/openapi/companies/getcompanyleads","metadata":{"seo":{"title":"Get contacts by companies","description":"Retrieve all contacts belonging to the specified companies. Returns an object mapping company UUIDs to arrays of contacts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCompanyLeads","name":"Get contacts by companies","isWebhook":false,"pointer":"/paths/~1leads~1api~1companies~1leads/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get contacts by companies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve all contacts belonging to the specified companies. Returns an object mapping company UUIDs to arrays of contacts.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_186","exampleIds":["paths/~1leads~1api~1companies~1leads/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_186","exampleIds":["paths/~1leads~1api~1companies~1leads/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1leads~1api~1companies~1leads/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/leads/api/companies/leads","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_186","exampleIds":["paths/~1leads~1api~1companies~1leads/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/leads/api/companies/leads","href":"companies/getcompanyleads","openApiOperationId":"getCompanyLeads","summary":"Get contacts by companies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_186","exampleIds":["paths/~1leads~1api~1companies~1leads/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_186","exampleIds":["paths/~1leads~1api~1companies~1leads/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Contacts grouped by company UUID.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_187"}},"schemaId":"schema_187"}],"pointer":"/paths/~1leads~1api~1companies~1leads/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_187","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_187"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/companies/leads"},{"label":"Enrich companies","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/companies/enrichcompanies","routeSlug":"/openapi/companies/enrichcompanies","metadata":{"seo":{"title":"Enrich companies","description":"Queue advanced enrichment for companies. Provide either a filter to select companies or an array of specific company UUIDs. Enrichment uses credits from your account balance."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"enrichCompanies","name":"Enrich companies","isWebhook":false,"pointer":"/paths/~1leads~1api~1companies~1advanced-enrichment/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enrich companies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Queue advanced enrichment for companies. Provide either a filter to select companies or an array of specific company UUIDs. Enrichment uses credits from your account balance.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_188","exampleIds":["paths/~1leads~1api~1companies~1advanced-enrichment/put/requestBody/content/application~1json/example"]}},"schemaId":"schema_188","exampleIds":["paths/~1leads~1api~1companies~1advanced-enrichment/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1leads~1api~1companies~1advanced-enrichment/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/leads/api/companies/advanced-enrichment","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_188","exampleIds":["paths/~1leads~1api~1companies~1advanced-enrichment/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","402"],"pointer":"/leads/api/companies/advanced-enrichment","href":"companies/enrichcompanies","openApiOperationId":"enrichCompanies","summary":"Enrich companies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_188","exampleIds":["paths/~1leads~1api~1companies~1advanced-enrichment/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_188","exampleIds":["paths/~1leads~1api~1companies~1advanced-enrichment/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Enrichment queued.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_189"}},"schemaId":"schema_189"},{"code":"402","description":"Insufficient enrichment credits."}],"pointer":"/paths/~1leads~1api~1companies~1advanced-enrichment/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_189","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_189"}}},{"code":"402"}],"examples":[]}]}]}]},"httpPath":"/leads/api/companies/advanced-enrichment"},{"label":"Mass action on companies","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/companies/companiesmassaction","routeSlug":"/openapi/companies/companiesmassaction","metadata":{"seo":{"title":"Mass action on companies","description":"Perform a bulk action on companies matching a filter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"companiesMassAction","name":"Mass action on companies","isWebhook":false,"pointer":"/paths/~1leads~1api~1companies~1mass-action/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Mass action on companies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Perform a bulk action on companies matching a filter.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_190","exampleIds":["paths/~1leads~1api~1companies~1mass-action/put/requestBody/content/application~1json/example"]}},"schemaId":"schema_190","exampleIds":["paths/~1leads~1api~1companies~1mass-action/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1leads~1api~1companies~1mass-action/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/leads/api/companies/mass-action","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_190","exampleIds":["paths/~1leads~1api~1companies~1mass-action/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","422"],"pointer":"/leads/api/companies/mass-action","href":"companies/companiesmassaction","openApiOperationId":"companiesMassAction","summary":"Mass action on companies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_190","exampleIds":["paths/~1leads~1api~1companies~1mass-action/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_190","exampleIds":["paths/~1leads~1api~1companies~1mass-action/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Action executed."},{"code":"422","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1leads~1api~1companies~1mass-action/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/companies/mass-action"}],"content":{"contentType":"group","meta":{"name":"Companies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Companies","showPageActions":true},{"nodeType":"markdoc","content":"Manage company records in your CRM. Companies can be linked to contacts and enriched with additional data from LinkedIn."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/leads/api/companies","summary":"List companies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/companies/listcompanies","deprecated":false},{"title":"/leads/api/companies","summary":"Create companies","prefix":{"name":"post","color":"post"},"badges":[],"link":"/companies/createcompanies","deprecated":false},{"title":"/leads/api/companies/{uuid}","summary":"Get a company","prefix":{"name":"get","color":"get"},"badges":[],"link":"/companies/getcompany","deprecated":false},{"title":"/leads/api/companies/{uuid}","summary":"Update a company","prefix":{"name":"put","color":"put"},"badges":[],"link":"/companies/updatecompany","deprecated":false},{"title":"/leads/api/companies/{uuid}","summary":"Delete a company","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/companies/deletecompany","deprecated":false},{"title":"/leads/api/companies/list","summary":"Search companies","prefix":{"name":"post","color":"post"},"badges":[],"link":"/companies/searchcompanies","deprecated":false},{"title":"/leads/api/companies/lookup","summary":"Lookup companies","prefix":{"name":"post","color":"post"},"badges":[],"link":"/companies/lookupcompanies","deprecated":false},{"title":"/leads/api/companies/leads","summary":"Get contacts by companies","prefix":{"name":"post","color":"post"},"badges":[],"link":"/companies/getcompanyleads","deprecated":false},{"title":"/leads/api/companies/advanced-enrichment","summary":"Enrich companies","prefix":{"name":"put","color":"put"},"badges":[],"link":"/companies/enrichcompanies","deprecated":false},{"title":"/leads/api/companies/mass-action","summary":"Mass action on companies","prefix":{"name":"put","color":"put"},"badges":[],"link":"/companies/companiesmassaction","deprecated":false}]}]}]}]}},{"type":"group","label":"Lists","link":"/openapi/lists","routeSlug":"/openapi/lists","items":[{"label":"List all lists","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/lists/listlists","routeSlug":"/openapi/lists/listlists","metadata":{"seo":{"title":"List all lists","description":"Retrieve all contact lists in your account. Lists are used to organize contacts into groups for outreach campaigns."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listLists","name":"List all lists","isWebhook":false,"pointer":"/paths/~1leads~1api~1lists/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all lists","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve all contact lists in your account. Lists are used to organize contacts into groups for outreach campaigns.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_153","description":"Items per page (default 20)."},{"name":"offset","in":"query","schemaId":"schema_154","description":"Items to skip (default 0)."},{"name":"order_field","in":"query","schemaId":"schema_173","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort field (default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"order_type","in":"query","schemaId":"schema_174","description":"Sort direction."},{"name":"filter","in":"query","schemaId":"schema_191"}],"pointer":"/paths/~1leads~1api~1lists/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/leads/api/lists","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_153"},{"name":"offset","in":"query","required":false,"example":0,"schemaId":"schema_154"},{"name":"order_field","in":"query","required":false,"example":"created_at","schemaId":"schema_173"},{"name":"order_type","in":"query","required":false,"example":"asc","schemaId":"schema_174"},{"name":"filter","in":"query","schemaId":"schema_191"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/leads/api/lists","href":"lists/listlists","openApiOperationId":"listLists","summary":"List all lists"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of contact lists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_192"}},"schemaId":"schema_192"}],"pointer":"/paths/~1leads~1api~1lists/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_192","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_192"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/lists"},{"label":"Create a list","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/lists/createlist","routeSlug":"/openapi/lists/createlist","metadata":{"seo":{"title":"Create a list","description":"Create a new contact list."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createList","name":"Create a list","isWebhook":false,"pointer":"/paths/~1leads~1api~1lists/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new contact list."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_193","exampleIds":["paths/~1leads~1api~1lists/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_193","exampleIds":["paths/~1leads~1api~1lists/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1leads~1api~1lists/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/leads/api/lists","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_193","exampleIds":["paths/~1leads~1api~1lists/post/requestBody/content/application~1json/example"]}},"responseCodes":["201"],"pointer":"/leads/api/lists","href":"lists/createlist","openApiOperationId":"createList","summary":"Create a list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_193","exampleIds":["paths/~1leads~1api~1lists/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_193","exampleIds":["paths/~1leads~1api~1lists/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"List created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list"}},"schemaId":"components/schemas/list"}],"pointer":"/paths/~1leads~1api~1lists/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/list","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/lists"},{"label":"Get a list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/lists/getlist","routeSlug":"/openapi/lists/getlist","metadata":{"seo":{"title":"Get a list","description":"Retrieve details of a specific contact list."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getList","name":"Get a list","isWebhook":false,"pointer":"/paths/~1leads~1api~1lists~1{uuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve details of a specific contact list."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1leads~1api~1lists~1{uuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/leads/api/lists/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/leads/api/lists/{uuid}","href":"lists/getlist","openApiOperationId":"getList","summary":"Get a list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list"}},"schemaId":"components/schemas/list"},{"code":"404","description":"List not found."}],"pointer":"/paths/~1leads~1api~1lists~1{uuid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/list","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/leads/api/lists/{uuid}"},{"label":"Update a list","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/lists/updatelist","routeSlug":"/openapi/lists/updatelist","metadata":{"seo":{"title":"Update a list","description":"Rename an existing contact list."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateList","name":"Update a list","isWebhook":false,"pointer":"/paths/~1leads~1api~1lists~1{uuid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Rename an existing contact list."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1leads~1api~1lists~1{uuid}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_194"}},"schemaId":"schema_194","pointer":"/paths/~1leads~1api~1lists~1{uuid}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/leads/api/lists/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_194"}},"responseCodes":["200"],"pointer":"/leads/api/lists/{uuid}","href":"lists/updatelist","openApiOperationId":"updateList","summary":"Update a list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_194","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_194"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated list.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list"}},"schemaId":"components/schemas/list"}],"pointer":"/paths/~1leads~1api~1lists~1{uuid}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/list","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/lists/{uuid}"},{"label":"Delete a list","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/lists/deletelist","routeSlug":"/openapi/lists/deletelist","metadata":{"seo":{"title":"Delete a list","description":"Permanently delete a contact list."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteList","name":"Delete a list","isWebhook":false,"pointer":"/paths/~1leads~1api~1lists~1{uuid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a list","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Permanently delete a contact list."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1leads~1api~1lists~1{uuid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/leads/api/lists/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/leads/api/lists/{uuid}","href":"lists/deletelist","openApiOperationId":"deleteList","summary":"Delete a list"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"List deleted."}],"pointer":"/paths/~1leads~1api~1lists~1{uuid}/delete/responses"}],"panels":[]}]},"httpPath":"/leads/api/lists/{uuid}"},{"label":"Get list metrics","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/lists/getlistmetrics","routeSlug":"/openapi/lists/getlistmetrics","metadata":{"seo":{"title":"Get list metrics","description":"Get lead counts for specified lists."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getListMetrics","name":"Get list metrics","isWebhook":false,"pointer":"/paths/~1leads~1api~1lists~1metrics/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get list metrics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get lead counts for specified lists."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_195","exampleIds":["paths/~1leads~1api~1lists~1metrics/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_195","exampleIds":["paths/~1leads~1api~1lists~1metrics/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1leads~1api~1lists~1metrics/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/leads/api/lists/metrics","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_195","exampleIds":["paths/~1leads~1api~1lists~1metrics/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/leads/api/lists/metrics","href":"lists/getlistmetrics","openApiOperationId":"getListMetrics","summary":"Get list metrics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_195","exampleIds":["paths/~1leads~1api~1lists~1metrics/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_195","exampleIds":["paths/~1leads~1api~1lists~1metrics/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Metrics per list."}],"pointer":"/paths/~1leads~1api~1lists~1metrics/post/responses"}],"panels":[]}]},"httpPath":"/leads/api/lists/metrics"}],"content":{"contentType":"group","meta":{"name":"Lists"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists","showPageActions":true},{"nodeType":"markdoc","content":"Organize contacts into lists. Every contact must belong to a list. Use lists to segment your audience for outreach campaigns."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/leads/api/lists","summary":"List all lists","prefix":{"name":"get","color":"get"},"badges":[],"link":"/lists/listlists","deprecated":false},{"title":"/leads/api/lists","summary":"Create a list","prefix":{"name":"post","color":"post"},"badges":[],"link":"/lists/createlist","deprecated":false},{"title":"/leads/api/lists/{uuid}","summary":"Get a list","prefix":{"name":"get","color":"get"},"badges":[],"link":"/lists/getlist","deprecated":false},{"title":"/leads/api/lists/{uuid}","summary":"Update a list","prefix":{"name":"put","color":"put"},"badges":[],"link":"/lists/updatelist","deprecated":false},{"title":"/leads/api/lists/{uuid}","summary":"Delete a list","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/lists/deletelist","deprecated":false},{"title":"/leads/api/lists/metrics","summary":"Get list metrics","prefix":{"name":"post","color":"post"},"badges":[],"link":"/lists/getlistmetrics","deprecated":false}]}]}]}]}},{"type":"group","label":"Tags","link":"/openapi/tags","routeSlug":"/openapi/tags","items":[{"label":"List tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tags/listtags","routeSlug":"/openapi/tags/listtags","metadata":{"seo":{"title":"List tags","description":"Retrieve all tags in your account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTags","name":"List tags","isWebhook":false,"pointer":"/paths/~1leads~1api~1tags/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List tags","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve all tags in your account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/leads/api/tags","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/leads/api/tags","href":"tags/listtags","openApiOperationId":"listTags","summary":"List tags"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of tags.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_196"}},"schemaId":"schema_196"}],"pointer":"/paths/~1leads~1api~1tags/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_196","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_196"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/tags"},{"label":"Create a tag","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tags/createtag","routeSlug":"/openapi/tags/createtag","metadata":{"seo":{"title":"Create a tag","description":"Create a new tag with optional color."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTag","name":"Create a tag","isWebhook":false,"pointer":"/paths/~1leads~1api~1tags/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new tag with optional color."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_197"}},"schemaId":"schema_197","pointer":"/paths/~1leads~1api~1tags/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/leads/api/tags","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_197"}},"responseCodes":["201"],"pointer":"/leads/api/tags","href":"tags/createtag","openApiOperationId":"createTag","summary":"Create a tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_197","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_197"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Tag created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag"}},"schemaId":"components/schemas/tag"}],"pointer":"/paths/~1leads~1api~1tags/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/tag","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/tags"},{"label":"Update a tag","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tags/updatetag","routeSlug":"/openapi/tags/updatetag","metadata":{"seo":{"title":"Update a tag","description":"Update a tag's name or color."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTag","name":"Update a tag","isWebhook":false,"pointer":"/paths/~1leads~1api~1tags~1{uuid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a tag's name or color."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1leads~1api~1tags~1{uuid}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_198"}},"schemaId":"schema_198","pointer":"/paths/~1leads~1api~1tags~1{uuid}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/leads/api/tags/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_198"}},"responseCodes":["200"],"pointer":"/leads/api/tags/{uuid}","href":"tags/updatetag","openApiOperationId":"updateTag","summary":"Update a tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_198","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_198"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated tag.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag"}},"schemaId":"components/schemas/tag"}],"pointer":"/paths/~1leads~1api~1tags~1{uuid}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/tag","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/tag"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/tags/{uuid}"},{"label":"Delete a tag","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tags/deletetag","routeSlug":"/openapi/tags/deletetag","metadata":{"seo":{"title":"Delete a tag","description":"Permanently delete a tag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteTag","name":"Delete a tag","isWebhook":false,"pointer":"/paths/~1leads~1api~1tags~1{uuid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Permanently delete a tag."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1leads~1api~1tags~1{uuid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/leads/api/tags/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/leads/api/tags/{uuid}","href":"tags/deletetag","openApiOperationId":"deleteTag","summary":"Delete a tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Tag deleted."}],"pointer":"/paths/~1leads~1api~1tags~1{uuid}/delete/responses"}],"panels":[]}]},"httpPath":"/leads/api/tags/{uuid}"},{"label":"Get tag metrics","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tags/gettagmetrics","routeSlug":"/openapi/tags/gettagmetrics","metadata":{"seo":{"title":"Get tag metrics","description":"Get lead and company counts for specified tags."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTagMetrics","name":"Get tag metrics","isWebhook":false,"pointer":"/paths/~1leads~1api~1tags~1metrics/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get tag metrics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get lead and company counts for specified tags."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_199","exampleIds":["paths/~1leads~1api~1tags~1metrics/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_199","exampleIds":["paths/~1leads~1api~1tags~1metrics/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1leads~1api~1tags~1metrics/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/leads/api/tags/metrics","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_199","exampleIds":["paths/~1leads~1api~1tags~1metrics/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/leads/api/tags/metrics","href":"tags/gettagmetrics","openApiOperationId":"getTagMetrics","summary":"Get tag metrics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_199","exampleIds":["paths/~1leads~1api~1tags~1metrics/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_199","exampleIds":["paths/~1leads~1api~1tags~1metrics/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Metrics per tag."}],"pointer":"/paths/~1leads~1api~1tags~1metrics/post/responses"}],"panels":[]}]},"httpPath":"/leads/api/tags/metrics"}],"content":{"contentType":"group","meta":{"name":"Tags"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tags","showPageActions":true},{"nodeType":"markdoc","content":"Label contacts and companies with custom tags for easy filtering and segmentation."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/leads/api/tags","summary":"List tags","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tags/listtags","deprecated":false},{"title":"/leads/api/tags","summary":"Create a tag","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/createtag","deprecated":false},{"title":"/leads/api/tags/{uuid}","summary":"Update a tag","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tags/updatetag","deprecated":false},{"title":"/leads/api/tags/{uuid}","summary":"Delete a tag","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/tags/deletetag","deprecated":false},{"title":"/leads/api/tags/metrics","summary":"Get tag metrics","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/gettagmetrics","deprecated":false}]}]}]}]}},{"type":"group","label":"Pipeline","link":"/openapi/pipeline","routeSlug":"/openapi/pipeline","items":[{"label":"List pipeline stages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipeline/listpipelinestages","routeSlug":"/openapi/pipeline/listpipelinestages","metadata":{"seo":{"title":"List pipeline stages","description":"Retrieve all pipeline stages. Use the filter parameter (JSON string) to narrow results by object type or stage type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPipelineStages","name":"List pipeline stages","isWebhook":false,"pointer":"/paths/~1leads~1api~1pipeline-stages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List pipeline stages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve all pipeline stages. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter (JSON string) to narrow results by object type or stage type."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_164","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON string with filter criteria. Supported keys:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"object"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"lead\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"company\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (required)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"custom\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"new\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"approaching\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"engaging\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"replied\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?filter={\"object\":\"lead\"}"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1leads~1api~1pipeline-stages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/leads/api/pipeline-stages","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","required":true,"schemaId":"schema_164"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/leads/api/pipeline-stages","href":"pipeline/listpipelinestages","openApiOperationId":"listPipelineStages","summary":"List pipeline stages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of pipeline stages.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_200"}},"schemaId":"schema_200"}],"pointer":"/paths/~1leads~1api~1pipeline-stages/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_200","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_200"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/pipeline-stages"},{"label":"Create a pipeline stage","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipeline/createpipelinestage","routeSlug":"/openapi/pipeline/createpipelinestage","metadata":{"seo":{"title":"Create a pipeline stage","description":"Create a new custom pipeline stage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPipelineStage","name":"Create a pipeline stage","isWebhook":false,"pointer":"/paths/~1leads~1api~1pipeline-stages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a pipeline stage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new custom pipeline stage."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_201"}},"schemaId":"schema_201","pointer":"/paths/~1leads~1api~1pipeline-stages/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/leads/api/pipeline-stages","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_201"}},"responseCodes":["201"],"pointer":"/leads/api/pipeline-stages","href":"pipeline/createpipelinestage","openApiOperationId":"createPipelineStage","summary":"Create a pipeline stage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_201","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_201"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Stage created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/pipeline-stage"}},"schemaId":"components/schemas/pipeline-stage"}],"pointer":"/paths/~1leads~1api~1pipeline-stages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/pipeline-stage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/pipeline-stage"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/pipeline-stages"},{"label":"Update a pipeline stage","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipeline/updatepipelinestage","routeSlug":"/openapi/pipeline/updatepipelinestage","metadata":{"seo":{"title":"Update a pipeline stage","description":"Update a pipeline stage's name, category, or order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePipelineStage","name":"Update a pipeline stage","isWebhook":false,"pointer":"/paths/~1leads~1api~1pipeline-stages~1{uuid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a pipeline stage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a pipeline stage's name, category, or order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1leads~1api~1pipeline-stages~1{uuid}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_202"}},"schemaId":"schema_202","pointer":"/paths/~1leads~1api~1pipeline-stages~1{uuid}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/leads/api/pipeline-stages/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_202"}},"responseCodes":["200"],"pointer":"/leads/api/pipeline-stages/{uuid}","href":"pipeline/updatepipelinestage","openApiOperationId":"updatePipelineStage","summary":"Update a pipeline stage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_202","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_202"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated stage.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/pipeline-stage"}},"schemaId":"components/schemas/pipeline-stage"}],"pointer":"/paths/~1leads~1api~1pipeline-stages~1{uuid}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/pipeline-stage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/pipeline-stage"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/pipeline-stages/{uuid}"},{"label":"Delete a pipeline stage","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/pipeline/deletepipelinestage","routeSlug":"/openapi/pipeline/deletepipelinestage","metadata":{"seo":{"title":"Delete a pipeline stage","description":"Delete a custom pipeline stage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePipelineStage","name":"Delete a pipeline stage","isWebhook":false,"pointer":"/paths/~1leads~1api~1pipeline-stages~1{uuid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a pipeline stage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a custom pipeline stage."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1leads~1api~1pipeline-stages~1{uuid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/leads/api/pipeline-stages/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/leads/api/pipeline-stages/{uuid}","href":"pipeline/deletepipelinestage","openApiOperationId":"deletePipelineStage","summary":"Delete a pipeline stage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Stage deleted."}],"pointer":"/paths/~1leads~1api~1pipeline-stages~1{uuid}/delete/responses"}],"panels":[]}]},"httpPath":"/leads/api/pipeline-stages/{uuid}"}],"content":{"contentType":"group","meta":{"name":"Pipeline"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Pipeline","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Define and manage pipeline stages to track where each contact stands in your sales or outreach process."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stage categories:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cold"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (not yet contacted), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"engaging"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (outreach in progress), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"positive"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (showing interest / converted), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"negative"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (rejected / lost)."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/leads/api/pipeline-stages","summary":"List pipeline stages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/pipeline/listpipelinestages","deprecated":false},{"title":"/leads/api/pipeline-stages","summary":"Create a pipeline stage","prefix":{"name":"post","color":"post"},"badges":[],"link":"/pipeline/createpipelinestage","deprecated":false},{"title":"/leads/api/pipeline-stages/{uuid}","summary":"Update a pipeline stage","prefix":{"name":"put","color":"put"},"badges":[],"link":"/pipeline/updatepipelinestage","deprecated":false},{"title":"/leads/api/pipeline-stages/{uuid}","summary":"Delete a pipeline stage","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/pipeline/deletepipelinestage","deprecated":false}]}]}]}]}},{"type":"group","label":"Custom Fields","link":"/openapi/custom-fields","routeSlug":"/openapi/custom-fields","items":[{"label":"List custom fields","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/custom-fields/listcustomfields","routeSlug":"/openapi/custom-fields/listcustomfields","metadata":{"seo":{"title":"List custom fields","description":"Retrieve all custom field definitions for contacts and companies."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCustomFields","name":"List custom fields","isWebhook":false,"pointer":"/paths/~1leads~1api~1custom-fields/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List custom fields","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve all custom field definitions for contacts and companies."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_153","description":"Items per page (default 20)."},{"name":"offset","in":"query","schemaId":"schema_154","description":"Items to skip (default 0)."},{"name":"order_field","in":"query","schemaId":"schema_173","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort field (default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"order_type","in":"query","schemaId":"schema_174","description":"Sort direction."}],"pointer":"/paths/~1leads~1api~1custom-fields/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/leads/api/custom-fields","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_153"},{"name":"offset","in":"query","required":false,"example":0,"schemaId":"schema_154"},{"name":"order_field","in":"query","required":false,"example":"created_at","schemaId":"schema_173"},{"name":"order_type","in":"query","required":false,"example":"asc","schemaId":"schema_174"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/leads/api/custom-fields","href":"custom-fields/listcustomfields","openApiOperationId":"listCustomFields","summary":"List custom fields"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of custom fields.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_203"}},"schemaId":"schema_203"}],"pointer":"/paths/~1leads~1api~1custom-fields/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_203","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_203"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/custom-fields"},{"label":"Create a custom field","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/custom-fields/createcustomfield","routeSlug":"/openapi/custom-fields/createcustomfield","metadata":{"seo":{"title":"Create a custom field","description":"Define a new custom field for contacts or companies."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCustomField","name":"Create a custom field","isWebhook":false,"pointer":"/paths/~1leads~1api~1custom-fields/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a custom field","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Define a new custom field for contacts or companies."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_204"}},"schemaId":"schema_204","pointer":"/paths/~1leads~1api~1custom-fields/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/leads/api/custom-fields","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_204"}},"responseCodes":["201"],"pointer":"/leads/api/custom-fields","href":"custom-fields/createcustomfield","openApiOperationId":"createCustomField","summary":"Create a custom field"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_204","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_204"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Custom field created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/custom-field"}},"schemaId":"components/schemas/custom-field"}],"pointer":"/paths/~1leads~1api~1custom-fields/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/custom-field","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/custom-field"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/custom-fields"},{"label":"Update a custom field","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/custom-fields/updatecustomfield","routeSlug":"/openapi/custom-fields/updatecustomfield","metadata":{"seo":{"title":"Update a custom field","description":"Update a custom field's name or order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCustomField","name":"Update a custom field","isWebhook":false,"pointer":"/paths/~1leads~1api~1custom-fields~1{uuid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a custom field","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a custom field's name or order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1leads~1api~1custom-fields~1{uuid}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_205"}},"schemaId":"schema_205","pointer":"/paths/~1leads~1api~1custom-fields~1{uuid}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/leads/api/custom-fields/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_205"}},"responseCodes":["200"],"pointer":"/leads/api/custom-fields/{uuid}","href":"custom-fields/updatecustomfield","openApiOperationId":"updateCustomField","summary":"Update a custom field"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_205","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_205"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated field.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/custom-field"}},"schemaId":"components/schemas/custom-field"}],"pointer":"/paths/~1leads~1api~1custom-fields~1{uuid}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/custom-field","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/custom-field"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/custom-fields/{uuid}"},{"label":"Delete a custom field","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/custom-fields/deletecustomfield","routeSlug":"/openapi/custom-fields/deletecustomfield","metadata":{"seo":{"title":"Delete a custom field","description":"Permanently remove a custom field definition and all its values."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCustomField","name":"Delete a custom field","isWebhook":false,"pointer":"/paths/~1leads~1api~1custom-fields~1{uuid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a custom field","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Permanently remove a custom field definition and all its values."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1leads~1api~1custom-fields~1{uuid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/leads/api/custom-fields/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/leads/api/custom-fields/{uuid}","href":"custom-fields/deletecustomfield","openApiOperationId":"deleteCustomField","summary":"Delete a custom field"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Field deleted."}],"pointer":"/paths/~1leads~1api~1custom-fields~1{uuid}/delete/responses"}],"panels":[]}]},"httpPath":"/leads/api/custom-fields/{uuid}"},{"label":"Set a custom field value","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/custom-fields/upsertcustomfieldvalue","routeSlug":"/openapi/custom-fields/upsertcustomfieldvalue","metadata":{"seo":{"title":"Set a custom field value","description":"Set (or update) a custom field value on a contact or company. Pass null as value to clear the field."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertCustomFieldValue","name":"Set a custom field value","isWebhook":false,"pointer":"/paths/~1leads~1api~1custom-field-values/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set a custom field value","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set (or update) a custom field value on a contact or company. Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as value to clear the field."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_206","exampleIds":["paths/~1leads~1api~1custom-field-values/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_206","exampleIds":["paths/~1leads~1api~1custom-field-values/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1leads~1api~1custom-field-values/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/leads/api/custom-field-values","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_206","exampleIds":["paths/~1leads~1api~1custom-field-values/post/requestBody/content/application~1json/example"]}},"responseCodes":["201"],"pointer":"/leads/api/custom-field-values","href":"custom-fields/upsertcustomfieldvalue","openApiOperationId":"upsertCustomFieldValue","summary":"Set a custom field value"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_206","exampleIds":["paths/~1leads~1api~1custom-field-values/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_206","exampleIds":["paths/~1leads~1api~1custom-field-values/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Value set.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/custom-field-value"}},"schemaId":"components/schemas/custom-field-value"}],"pointer":"/paths/~1leads~1api~1custom-field-values/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/custom-field-value","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/custom-field-value"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/custom-field-values"}],"content":{"contentType":"group","meta":{"name":"Custom Fields"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Fields","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Extend contact and company records with custom data fields. Store any additional information relevant to your workflow."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Limits:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Maximum 100 custom fields per object type ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lead"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Field names must start with a letter or underscore, and contain only alphanumeric characters and underscores."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/leads/api/custom-fields","summary":"List custom fields","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-fields/listcustomfields","deprecated":false},{"title":"/leads/api/custom-fields","summary":"Create a custom field","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-fields/createcustomfield","deprecated":false},{"title":"/leads/api/custom-fields/{uuid}","summary":"Update a custom field","prefix":{"name":"put","color":"put"},"badges":[],"link":"/custom-fields/updatecustomfield","deprecated":false},{"title":"/leads/api/custom-fields/{uuid}","summary":"Delete a custom field","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/custom-fields/deletecustomfield","deprecated":false},{"title":"/leads/api/custom-field-values","summary":"Set a custom field value","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-fields/upsertcustomfieldvalue","deprecated":false}]}]}]}]}},{"type":"group","label":"Notes","link":"/openapi/notes","routeSlug":"/openapi/notes","items":[{"label":"List notes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/notes/listnotes","routeSlug":"/openapi/notes/listnotes","metadata":{"seo":{"title":"List notes","description":"Retrieve notes with pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNotes","name":"List notes","isWebhook":false,"pointer":"/paths/~1leads~1api~1notes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List notes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve notes with pagination."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_153","description":"Items per page (default 20)."},{"name":"offset","in":"query","schemaId":"schema_154","description":"Items to skip (default 0)."},{"name":"order_field","in":"query","schemaId":"schema_173","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort field (default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"order_type","in":"query","schemaId":"schema_174","description":"Sort direction."}],"pointer":"/paths/~1leads~1api~1notes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/leads/api/notes","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_153"},{"name":"offset","in":"query","required":false,"example":0,"schemaId":"schema_154"},{"name":"order_field","in":"query","required":false,"example":"created_at","schemaId":"schema_173"},{"name":"order_type","in":"query","required":false,"example":"asc","schemaId":"schema_174"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/leads/api/notes","href":"notes/listnotes","openApiOperationId":"listNotes","summary":"List notes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of notes.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_207"}},"schemaId":"schema_207"}],"pointer":"/paths/~1leads~1api~1notes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_207","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_207"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/notes"},{"label":"Create a note","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/notes/createnote","routeSlug":"/openapi/notes/createnote","metadata":{"seo":{"title":"Create a note","description":"Add a note to a contact or company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createNote","name":"Create a note","isWebhook":false,"pointer":"/paths/~1leads~1api~1notes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add a note to a contact or company."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_208"}},"schemaId":"schema_208","pointer":"/paths/~1leads~1api~1notes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/leads/api/notes","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_208"}},"responseCodes":["201"],"pointer":"/leads/api/notes","href":"notes/createnote","openApiOperationId":"createNote","summary":"Create a note"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_208","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_208"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Note created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/note"}},"schemaId":"components/schemas/note"}],"pointer":"/paths/~1leads~1api~1notes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/note","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/note"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/notes"},{"label":"Update a note","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/notes/updatenote","routeSlug":"/openapi/notes/updatenote","metadata":{"seo":{"title":"Update a note","description":"Update the text of an existing note."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateNote","name":"Update a note","isWebhook":false,"pointer":"/paths/~1leads~1api~1notes~1{uuid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update the text of an existing note."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1leads~1api~1notes~1{uuid}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_209"}},"schemaId":"schema_209","pointer":"/paths/~1leads~1api~1notes~1{uuid}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/leads/api/notes/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_209"}},"responseCodes":["200"],"pointer":"/leads/api/notes/{uuid}","href":"notes/updatenote","openApiOperationId":"updateNote","summary":"Update a note"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_209","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_209"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated note.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/note"}},"schemaId":"components/schemas/note"}],"pointer":"/paths/~1leads~1api~1notes~1{uuid}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/note","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/note"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/notes/{uuid}"},{"label":"Delete a note","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/notes/deletenote","routeSlug":"/openapi/notes/deletenote","metadata":{"seo":{"title":"Delete a note","description":"Permanently delete a note."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteNote","name":"Delete a note","isWebhook":false,"pointer":"/paths/~1leads~1api~1notes~1{uuid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a note","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Permanently delete a note."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1leads~1api~1notes~1{uuid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/leads/api/notes/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/leads/api/notes/{uuid}","href":"notes/deletenote","openApiOperationId":"deleteNote","summary":"Delete a note"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Note deleted."}],"pointer":"/paths/~1leads~1api~1notes~1{uuid}/delete/responses"}],"panels":[]}]},"httpPath":"/leads/api/notes/{uuid}"}],"content":{"contentType":"group","meta":{"name":"Notes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Notes","showPageActions":true},{"nodeType":"markdoc","content":"Add internal notes to contacts or companies for your team's reference."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/leads/api/notes","summary":"List notes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notes/listnotes","deprecated":false},{"title":"/leads/api/notes","summary":"Create a note","prefix":{"name":"post","color":"post"},"badges":[],"link":"/notes/createnote","deprecated":false},{"title":"/leads/api/notes/{uuid}","summary":"Update a note","prefix":{"name":"put","color":"put"},"badges":[],"link":"/notes/updatenote","deprecated":false},{"title":"/leads/api/notes/{uuid}","summary":"Delete a note","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/notes/deletenote","deprecated":false}]}]}]}]}},{"type":"group","label":"Activities","link":"/openapi/activities","routeSlug":"/openapi/activities","items":[{"label":"List activities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/activities/listactivities","routeSlug":"/openapi/activities/listactivities","metadata":{"seo":{"title":"List activities","description":"List activity records for contacts or companies. Activities track events like messages sent, emails opened, pipeline stage changes, and more."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listActivities","name":"List activities","isWebhook":false,"pointer":"/paths/~1leads~1api~1activities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List activities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List activity records for contacts or companies. Activities track events like messages sent, emails opened, pipeline stage changes, and more."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Known activity types:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pipeline_stage_changed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_message_sent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_message_replied"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_connection_request_sent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_connection_request_accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email_sent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email_replied"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email_opened"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email_clicked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email_bounced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_enriched"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by type and date range to narrow results. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field contains event-specific data (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flow_origin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flow_uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", pipeline stage UUIDs)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_153","description":"Items per page (default 20)."},{"name":"offset","in":"query","schemaId":"schema_154","description":"Items to skip (default 0)."},{"name":"order_field","in":"query","schemaId":"schema_173","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort field (default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"order_type","in":"query","schemaId":"schema_174","description":"Sort direction."},{"name":"filter","in":"query","schemaId":"schema_164","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON string with filter criteria. Supported keys:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — activity type (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"pipeline_stage_changed\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lead_uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — filter by contact UUID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — filter by company UUID"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — date filter with operators ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\">=\": \"2026-01-01\"}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?filter={\"type\":\"pipeline_stage_changed\",\"created_at\":{\">=\":\"2026-04-01\"}}"},"children":[]}]}]}]}],"required":true}],"pointer":"/paths/~1leads~1api~1activities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/leads/api/activities","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_153"},{"name":"offset","in":"query","required":false,"example":0,"schemaId":"schema_154"},{"name":"order_field","in":"query","required":false,"example":"created_at","schemaId":"schema_173"},{"name":"order_type","in":"query","required":false,"example":"asc","schemaId":"schema_174"},{"name":"filter","in":"query","required":true,"schemaId":"schema_164"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/leads/api/activities","href":"activities/listactivities","openApiOperationId":"listActivities","summary":"List activities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of activities.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_210"}},"schemaId":"schema_210"}],"pointer":"/paths/~1leads~1api~1activities/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_210","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_210"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/activities"},{"label":"Create an activity","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/activities/createactivity","routeSlug":"/openapi/activities/createactivity","metadata":{"seo":{"title":"Create an activity","description":"Create a new activity record for a contact or company."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createActivity","name":"Create an activity","isWebhook":false,"pointer":"/paths/~1leads~1api~1activities/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an activity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new activity record for a contact or company."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_211"}},"schemaId":"schema_211","pointer":"/paths/~1leads~1api~1activities/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/leads/api/activities","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_211"}},"responseCodes":["201"],"pointer":"/leads/api/activities","href":"activities/createactivity","openApiOperationId":"createActivity","summary":"Create an activity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_211","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_211"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Activity created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/activity"}},"schemaId":"components/schemas/activity"}],"pointer":"/paths/~1leads~1api~1activities/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/activity","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/activity"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/activities"}],"content":{"contentType":"group","meta":{"name":"Activities"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activities","showPageActions":true},{"nodeType":"markdoc","content":"Track events and interactions on contacts and companies, such as messages sent, emails opened, and status changes."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/leads/api/activities","summary":"List activities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/activities/listactivities","deprecated":false},{"title":"/leads/api/activities","summary":"Create an activity","prefix":{"name":"post","color":"post"},"badges":[],"link":"/activities/createactivity","deprecated":false}]}]}]}]}},{"type":"group","label":"Blacklist","link":"/openapi/blacklist","routeSlug":"/openapi/blacklist","items":[{"label":"List blacklisted contacts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/blacklist/listleadsblacklist","routeSlug":"/openapi/blacklist/listleadsblacklist","metadata":{"seo":{"title":"List blacklisted contacts","description":"Returns blacklisted contact entries for the team. Blacklisted contacts are excluded from imports, enrichment, automations, and mass actions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listLeadsBlacklist","name":"List blacklisted contacts","isWebhook":false,"pointer":"/paths/~1leads~1api~1leads-blacklist/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List blacklisted contacts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns blacklisted contact entries for the team. Blacklisted contacts are excluded from imports, enrichment, automations, and mass actions.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_153","description":"Items per page (default 20)."},{"name":"offset","in":"query","schemaId":"schema_154","description":"Items to skip (default 0)."}],"pointer":"/paths/~1leads~1api~1leads-blacklist/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/leads/api/leads-blacklist","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_153"},{"name":"offset","in":"query","required":false,"example":0,"schemaId":"schema_154"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/leads/api/leads-blacklist","href":"blacklist/listleadsblacklist","openApiOperationId":"listLeadsBlacklist","summary":"List blacklisted contacts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of blacklisted contacts.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_212"}},"schemaId":"schema_212"}],"pointer":"/paths/~1leads~1api~1leads-blacklist/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_212","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_212"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/leads-blacklist"},{"label":"Add contact to blacklist","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/blacklist/addleadtoblacklist","routeSlug":"/openapi/blacklist/addleadtoblacklist","metadata":{"seo":{"title":"Add contact to blacklist","description":"Blacklist a contact by LinkedIn handle, email, name, or company name. Provide at least one identifier; the entry is matched on import and outreach."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addLeadToBlacklist","name":"Add contact to blacklist","isWebhook":false,"pointer":"/paths/~1leads~1api~1leads-blacklist/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add contact to blacklist","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Blacklist a contact by LinkedIn handle, email, name, or company name. Provide at least one identifier; the entry is matched on import and outreach.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_213","exampleIds":["paths/~1leads~1api~1leads-blacklist/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_213","exampleIds":["paths/~1leads~1api~1leads-blacklist/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1leads~1api~1leads-blacklist/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/leads/api/leads-blacklist","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_213","exampleIds":["paths/~1leads~1api~1leads-blacklist/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","422"],"pointer":"/leads/api/leads-blacklist","href":"blacklist/addleadtoblacklist","openApiOperationId":"addLeadToBlacklist","summary":"Add contact to blacklist"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_213","exampleIds":["paths/~1leads~1api~1leads-blacklist/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_213","exampleIds":["paths/~1leads~1api~1leads-blacklist/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Contact blacklisted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/lead-blacklist-entry"}},"schemaId":"components/schemas/lead-blacklist-entry"},{"code":"422","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1leads~1api~1leads-blacklist/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/lead-blacklist-entry","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/lead-blacklist-entry"}}},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/leads-blacklist"},{"label":"Remove contact from blacklist","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/blacklist/deleteleadblacklistentry","routeSlug":"/openapi/blacklist/deleteleadblacklistentry","metadata":{"seo":{"title":"Remove contact from blacklist","description":"Delete a blacklist entry by its UUID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteLeadBlacklistEntry","name":"Remove contact from blacklist","isWebhook":false,"pointer":"/paths/~1leads~1api~1leads-blacklist~1{uuid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove contact from blacklist","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a blacklist entry by its UUID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1leads~1api~1leads-blacklist~1{uuid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/leads/api/leads-blacklist/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","404"],"pointer":"/leads/api/leads-blacklist/{uuid}","href":"blacklist/deleteleadblacklistentry","openApiOperationId":"deleteLeadBlacklistEntry","summary":"Remove contact from blacklist"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Entry removed."},{"code":"404","description":"Entry not found."}],"pointer":"/paths/~1leads~1api~1leads-blacklist~1{uuid}/delete/responses"}],"panels":[]}]},"httpPath":"/leads/api/leads-blacklist/{uuid}"},{"label":"List blacklisted companies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/blacklist/listcompaniesblacklist","routeSlug":"/openapi/blacklist/listcompaniesblacklist","metadata":{"seo":{"title":"List blacklisted companies","description":"Returns blacklisted company entries for the team. Blacklisted companies are excluded from imports, enrichment, automations, and mass actions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCompaniesBlacklist","name":"List blacklisted companies","isWebhook":false,"pointer":"/paths/~1leads~1api~1companies-blacklist/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List blacklisted companies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns blacklisted company entries for the team. Blacklisted companies are excluded from imports, enrichment, automations, and mass actions.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_153","description":"Items per page (default 20)."},{"name":"offset","in":"query","schemaId":"schema_154","description":"Items to skip (default 0)."}],"pointer":"/paths/~1leads~1api~1companies-blacklist/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/leads/api/companies-blacklist","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_153"},{"name":"offset","in":"query","required":false,"example":0,"schemaId":"schema_154"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/leads/api/companies-blacklist","href":"blacklist/listcompaniesblacklist","openApiOperationId":"listCompaniesBlacklist","summary":"List blacklisted companies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of blacklisted companies.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_214"}},"schemaId":"schema_214"}],"pointer":"/paths/~1leads~1api~1companies-blacklist/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_214","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_214"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/companies-blacklist"},{"label":"Add company to blacklist","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/blacklist/addcompanytoblacklist","routeSlug":"/openapi/blacklist/addcompanytoblacklist","metadata":{"seo":{"title":"Add company to blacklist","description":"Blacklist a company by LinkedIn handle, domain, or name. Provide at least one identifier; the entry is matched on import and outreach."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addCompanyToBlacklist","name":"Add company to blacklist","isWebhook":false,"pointer":"/paths/~1leads~1api~1companies-blacklist/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add company to blacklist","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Blacklist a company by LinkedIn handle, domain, or name. Provide at least one identifier; the entry is matched on import and outreach.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_215","exampleIds":["paths/~1leads~1api~1companies-blacklist/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_215","exampleIds":["paths/~1leads~1api~1companies-blacklist/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1leads~1api~1companies-blacklist/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/leads/api/companies-blacklist","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_215","exampleIds":["paths/~1leads~1api~1companies-blacklist/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","422"],"pointer":"/leads/api/companies-blacklist","href":"blacklist/addcompanytoblacklist","openApiOperationId":"addCompanyToBlacklist","summary":"Add company to blacklist"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_215","exampleIds":["paths/~1leads~1api~1companies-blacklist/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_215","exampleIds":["paths/~1leads~1api~1companies-blacklist/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Company blacklisted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company-blacklist-entry"}},"schemaId":"components/schemas/company-blacklist-entry"},{"code":"422","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1leads~1api~1companies-blacklist/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/company-blacklist-entry","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/company-blacklist-entry"}}},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/companies-blacklist"},{"label":"Remove company from blacklist","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/blacklist/deletecompanyblacklistentry","routeSlug":"/openapi/blacklist/deletecompanyblacklistentry","metadata":{"seo":{"title":"Remove company from blacklist","description":"Delete a blacklist entry by its UUID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCompanyBlacklistEntry","name":"Remove company from blacklist","isWebhook":false,"pointer":"/paths/~1leads~1api~1companies-blacklist~1{uuid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove company from blacklist","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a blacklist entry by its UUID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1leads~1api~1companies-blacklist~1{uuid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/leads/api/companies-blacklist/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","404"],"pointer":"/leads/api/companies-blacklist/{uuid}","href":"blacklist/deletecompanyblacklistentry","openApiOperationId":"deleteCompanyBlacklistEntry","summary":"Remove company from blacklist"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Entry removed."},{"code":"404","description":"Entry not found."}],"pointer":"/paths/~1leads~1api~1companies-blacklist~1{uuid}/delete/responses"}],"panels":[]}]},"httpPath":"/leads/api/companies-blacklist/{uuid}"}],"content":{"contentType":"group","meta":{"name":"Blacklist"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Blacklist","showPageActions":true},{"nodeType":"markdoc","content":"Block contacts and companies from being imported, enriched, or contacted. Blacklisted records are filtered out of automations, mass actions, and CSV imports."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/leads/api/leads-blacklist","summary":"List blacklisted contacts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/blacklist/listleadsblacklist","deprecated":false},{"title":"/leads/api/leads-blacklist","summary":"Add contact to blacklist","prefix":{"name":"post","color":"post"},"badges":[],"link":"/blacklist/addleadtoblacklist","deprecated":false},{"title":"/leads/api/leads-blacklist/{uuid}","summary":"Remove contact from blacklist","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/blacklist/deleteleadblacklistentry","deprecated":false},{"title":"/leads/api/companies-blacklist","summary":"List blacklisted companies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/blacklist/listcompaniesblacklist","deprecated":false},{"title":"/leads/api/companies-blacklist","summary":"Add company to blacklist","prefix":{"name":"post","color":"post"},"badges":[],"link":"/blacklist/addcompanytoblacklist","deprecated":false},{"title":"/leads/api/companies-blacklist/{uuid}","summary":"Remove company from blacklist","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/blacklist/deletecompanyblacklistentry","deprecated":false}]}]}]}]}},{"type":"group","label":"Data Sources","link":"/openapi/data-sources","routeSlug":"/openapi/data-sources","items":[{"label":"List data sources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/data-sources/listdatasources","routeSlug":"/openapi/data-sources/listdatasources","metadata":{"seo":{"title":"List data sources","description":"List LinkedIn import jobs with pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDataSources","name":"List data sources","isWebhook":false,"pointer":"/paths/~1leads~1api~1data-sources/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List data sources","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List LinkedIn import jobs with pagination."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_153","description":"Items per page (default 20)."},{"name":"offset","in":"query","schemaId":"schema_154","description":"Items to skip (default 0)."},{"name":"order_field","in":"query","schemaId":"schema_173","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort field (default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"order_type","in":"query","schemaId":"schema_174","description":"Sort direction."}],"pointer":"/paths/~1leads~1api~1data-sources/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/leads/api/data-sources","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_153"},{"name":"offset","in":"query","required":false,"example":0,"schemaId":"schema_154"},{"name":"order_field","in":"query","required":false,"example":"created_at","schemaId":"schema_173"},{"name":"order_type","in":"query","required":false,"example":"asc","schemaId":"schema_174"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/leads/api/data-sources","href":"data-sources/listdatasources","openApiOperationId":"listDataSources","summary":"List data sources"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of data sources.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_216"}},"schemaId":"schema_216"}],"pointer":"/paths/~1leads~1api~1data-sources/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_216","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_216"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/data-sources"},{"label":"Create a data source","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/data-sources/createdatasource","routeSlug":"/openapi/data-sources/createdatasource","metadata":{"seo":{"title":"Create a data source","description":"Create a data source"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDataSource","name":"Create a data source","isWebhook":false,"pointer":"/paths/~1leads~1api~1data-sources/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a data source","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_217"}},"schemaId":"schema_217","pointer":"/paths/~1leads~1api~1data-sources/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/leads/api/data-sources","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_217"}},"responseCodes":["201"],"pointer":"/leads/api/data-sources","href":"data-sources/createdatasource","openApiOperationId":"createDataSource","summary":"Create a data source"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_217","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_217"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Data source created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data-source"}},"schemaId":"components/schemas/data-source"}],"pointer":"/paths/~1leads~1api~1data-sources/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/data-source","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data-source"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/data-sources"},{"label":"Get a data source","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/data-sources/getdatasource","routeSlug":"/openapi/data-sources/getdatasource","metadata":{"seo":{"title":"Get a data source","description":"Get a data source"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDataSource","name":"Get a data source","isWebhook":false,"pointer":"/paths/~1leads~1api~1data-sources~1{uuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a data source","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1leads~1api~1data-sources~1{uuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/leads/api/data-sources/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/leads/api/data-sources/{uuid}","href":"data-sources/getdatasource","openApiOperationId":"getDataSource","summary":"Get a data source"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Data source details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data-source"}},"schemaId":"components/schemas/data-source"}],"pointer":"/paths/~1leads~1api~1data-sources~1{uuid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/data-source","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data-source"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/data-sources/{uuid}"},{"label":"Update a data source","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/data-sources/updatedatasource","routeSlug":"/openapi/data-sources/updatedatasource","metadata":{"seo":{"title":"Update a data source","description":"Update a data source"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDataSource","name":"Update a data source","isWebhook":false,"pointer":"/paths/~1leads~1api~1data-sources~1{uuid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a data source","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1leads~1api~1data-sources~1{uuid}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_218"}},"schemaId":"schema_218","pointer":"/paths/~1leads~1api~1data-sources~1{uuid}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/leads/api/data-sources/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_218"}},"responseCodes":["200"],"pointer":"/leads/api/data-sources/{uuid}","href":"data-sources/updatedatasource","openApiOperationId":"updateDataSource","summary":"Update a data source"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_218","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_218"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Data source updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data-source"}},"schemaId":"components/schemas/data-source"}],"pointer":"/paths/~1leads~1api~1data-sources~1{uuid}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/data-source","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/data-source"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/data-sources/{uuid}"},{"label":"Delete a data source","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/data-sources/deletedatasource","routeSlug":"/openapi/data-sources/deletedatasource","metadata":{"seo":{"title":"Delete a data source","description":"Delete a data source"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteDataSource","name":"Delete a data source","isWebhook":false,"pointer":"/paths/~1leads~1api~1data-sources~1{uuid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a data source","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1leads~1api~1data-sources~1{uuid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/leads/api/data-sources/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/leads/api/data-sources/{uuid}","href":"data-sources/deletedatasource","openApiOperationId":"deleteDataSource","summary":"Delete a data source"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Data source deleted."}],"pointer":"/paths/~1leads~1api~1data-sources~1{uuid}/delete/responses"}],"panels":[]}]},"httpPath":"/leads/api/data-sources/{uuid}"},{"label":"Get data source metrics","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/data-sources/getdatasourcemetrics","routeSlug":"/openapi/data-sources/getdatasourcemetrics","metadata":{"seo":{"title":"Get data source metrics","description":"Return per-data-source counts of queued, saved, duplicate, blacklisted, and error records. Pass an array of data source UUIDs in uuids. The response is a map keyed by UUID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDataSourceMetrics","name":"Get data source metrics","isWebhook":false,"pointer":"/paths/~1leads~1api~1data-sources~1metrics/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get data source metrics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return per-data-source counts of queued, saved, duplicate, blacklisted, and error records. Pass an array of data source UUIDs in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uuids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The response is a map keyed by UUID."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_219","exampleIds":["paths/~1leads~1api~1data-sources~1metrics/put/requestBody/content/application~1json/example"]}},"schemaId":"schema_219","exampleIds":["paths/~1leads~1api~1data-sources~1metrics/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1leads~1api~1data-sources~1metrics/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/leads/api/data-sources/metrics","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_219","exampleIds":["paths/~1leads~1api~1data-sources~1metrics/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","422"],"pointer":"/leads/api/data-sources/metrics","href":"data-sources/getdatasourcemetrics","openApiOperationId":"getDataSourceMetrics","summary":"Get data source metrics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_219","exampleIds":["paths/~1leads~1api~1data-sources~1metrics/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_219","exampleIds":["paths/~1leads~1api~1data-sources~1metrics/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Per-data-source metrics, keyed by UUID.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_220","exampleIds":["paths/~1leads~1api~1data-sources~1metrics/put/responses/200/content/application~1json/example"]}},"schemaId":"schema_220","exampleIds":["paths/~1leads~1api~1data-sources~1metrics/put/responses/200/content/application~1json/example"]},{"code":"422","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1leads~1api~1data-sources~1metrics/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_220","exampleIds":["paths/~1leads~1api~1data-sources~1metrics/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_220","exampleIds":["paths/~1leads~1api~1data-sources~1metrics/put/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/data-sources/metrics"}],"content":{"contentType":"group","meta":{"name":"Data Sources"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Sources","showPageActions":true},{"nodeType":"markdoc","content":"Manage LinkedIn import jobs. Data sources represent automated imports from LinkedIn searches, Sales Navigator, and other LinkedIn data."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/leads/api/data-sources","summary":"List data sources","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-sources/listdatasources","deprecated":false},{"title":"/leads/api/data-sources","summary":"Create a data source","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-sources/createdatasource","deprecated":false},{"title":"/leads/api/data-sources/{uuid}","summary":"Get a data source","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-sources/getdatasource","deprecated":false},{"title":"/leads/api/data-sources/{uuid}","summary":"Update a data source","prefix":{"name":"put","color":"put"},"badges":[],"link":"/data-sources/updatedatasource","deprecated":false},{"title":"/leads/api/data-sources/{uuid}","summary":"Delete a data source","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/data-sources/deletedatasource","deprecated":false},{"title":"/leads/api/data-sources/metrics","summary":"Get data source metrics","prefix":{"name":"put","color":"put"},"badges":[],"link":"/data-sources/getdatasourcemetrics","deprecated":false}]}]}]}]}},{"type":"group","label":"File Operations","link":"/openapi/file-operations","routeSlug":"/openapi/file-operations","items":[{"label":"Upload a CSV file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/file-operations/uploadcsvfile","routeSlug":"/openapi/file-operations/uploadcsvfile","metadata":{"seo":{"title":"Upload a CSV file","description":"Upload a CSV file to be imported as contacts or companies. Returns a file-import record with a UUID. Pass that UUID to import-leads or import-companies to actually create the records."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadCsvFile","name":"Upload a CSV file","isWebhook":false,"pointer":"/paths/~1leads~1api~1file-imports~1upload-csv/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload a CSV file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload a CSV file to be imported as contacts or companies. Returns a file-import record with a UUID. Pass that UUID to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"import-leads"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"import-companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to actually create the records."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the only validated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value at the time of writing is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"csv_leads"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Companies CSV may require a different mechanism — check with support."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_221"}},"schemaId":"schema_221","pointer":"/paths/~1leads~1api~1file-imports~1upload-csv/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/leads/api/file-imports/upload-csv","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_221"}},"responseCodes":["200","422"],"pointer":"/leads/api/file-imports/upload-csv","href":"file-operations/uploadcsvfile","openApiOperationId":"uploadCsvFile","summary":"Upload a CSV file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_221","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_221"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"File import record created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_222"}},"schemaId":"schema_222"},{"code":"422","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1leads~1api~1file-imports~1upload-csv/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_222","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_222"}}},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/file-imports/upload-csv"},{"label":"Import contacts from uploaded file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/file-operations/importleadsfromfile","routeSlug":"/openapi/file-operations/importleadsfromfile","metadata":{"seo":{"title":"Import contacts from uploaded file","description":"Trigger contact import from a previously uploaded CSV file. Required field: columns — an ordered list of column-mapping objects describing how to map CSV columns to contact fields."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"importLeadsFromFile","name":"Import contacts from uploaded file","isWebhook":false,"pointer":"/paths/~1leads~1api~1file-imports~1{uuid}~1import-leads/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Import contacts from uploaded file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trigger contact import from a previously uploaded CSV file. Required field: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"columns"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — an ordered list of column-mapping objects describing how to map CSV columns to contact fields."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1leads~1api~1file-imports~1{uuid}~1import-leads/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_223","exampleIds":["paths/~1leads~1api~1file-imports~1{uuid}~1import-leads/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_223","exampleIds":["paths/~1leads~1api~1file-imports~1{uuid}~1import-leads/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1leads~1api~1file-imports~1{uuid}~1import-leads/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/leads/api/file-imports/{uuid}/import-leads","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_223","exampleIds":["paths/~1leads~1api~1file-imports~1{uuid}~1import-leads/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","422"],"pointer":"/leads/api/file-imports/{uuid}/import-leads","href":"file-operations/importleadsfromfile","openApiOperationId":"importLeadsFromFile","summary":"Import contacts from uploaded file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_223","exampleIds":["paths/~1leads~1api~1file-imports~1{uuid}~1import-leads/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_223","exampleIds":["paths/~1leads~1api~1file-imports~1{uuid}~1import-leads/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Import job started."},{"code":"422","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1leads~1api~1file-imports~1{uuid}~1import-leads/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/file-imports/{uuid}/import-leads"},{"label":"Import companies from uploaded file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/file-operations/importcompaniesfromfile","routeSlug":"/openapi/file-operations/importcompaniesfromfile","metadata":{"seo":{"title":"Import companies from uploaded file","description":"Trigger company import from a previously uploaded CSV file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"importCompaniesFromFile","name":"Import companies from uploaded file","isWebhook":false,"pointer":"/paths/~1leads~1api~1file-imports~1{uuid}~1import-companies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Import companies from uploaded file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Trigger company import from a previously uploaded CSV file."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1leads~1api~1file-imports~1{uuid}~1import-companies/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1leads~1api~1file-imports~1{uuid}~1import-companies/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_224","exampleIds":["paths/~1leads~1api~1file-imports~1{uuid}~1import-companies/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1leads~1api~1file-imports~1{uuid}~1import-companies/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/leads/api/file-imports/{uuid}/import-companies","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1leads~1api~1file-imports~1{uuid}~1import-companies/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","422"],"pointer":"/leads/api/file-imports/{uuid}/import-companies","href":"file-operations/importcompaniesfromfile","openApiOperationId":"importCompaniesFromFile","summary":"Import companies from uploaded file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_224","exampleIds":["paths/~1leads~1api~1file-imports~1{uuid}~1import-companies/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_224","exampleIds":["paths/~1leads~1api~1file-imports~1{uuid}~1import-companies/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Import job started."},{"code":"422","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1leads~1api~1file-imports~1{uuid}~1import-companies/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/file-imports/{uuid}/import-companies"},{"label":"Export contacts to CSV","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/file-operations/exportleadstocsv","routeSlug":"/openapi/file-operations/exportleadstocsv","metadata":{"seo":{"title":"Export contacts to CSV","description":"Queue a CSV export of contacts matching the filter. Returns a file-export record with status queued. Once the job completes, use download to retrieve the file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"exportLeadsToCsv","name":"Export contacts to CSV","isWebhook":false,"pointer":"/paths/~1leads~1api~1file-exports~1leads/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Export contacts to CSV","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Queue a CSV export of contacts matching the filter. Returns a file-export record with status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"queued"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Once the job completes, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"download"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to retrieve the file."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1leads~1api~1file-exports~1leads/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_225","exampleIds":["paths/~1leads~1api~1file-exports~1leads/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1leads~1api~1file-exports~1leads/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/leads/api/file-exports/leads","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1leads~1api~1file-exports~1leads/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","422"],"pointer":"/leads/api/file-exports/leads","href":"file-operations/exportleadstocsv","openApiOperationId":"exportLeadsToCsv","summary":"Export contacts to CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_225","exampleIds":["paths/~1leads~1api~1file-exports~1leads/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_225","exampleIds":["paths/~1leads~1api~1file-exports~1leads/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Export queued.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_226"}},"schemaId":"schema_226"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation error — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1leads~1api~1file-exports~1leads/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_226","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_226"}}},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/file-exports/leads"},{"label":"Export companies to CSV","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/file-operations/exportcompaniestocsv","routeSlug":"/openapi/file-operations/exportcompaniestocsv","metadata":{"seo":{"title":"Export companies to CSV","description":"Queue a CSV export of companies matching the filter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"exportCompaniesToCsv","name":"Export companies to CSV","isWebhook":false,"pointer":"/paths/~1leads~1api~1file-exports~1companies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Export companies to CSV","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Queue a CSV export of companies matching the filter."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_227","exampleIds":["paths/~1leads~1api~1file-exports~1companies/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_227","exampleIds":["paths/~1leads~1api~1file-exports~1companies/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1leads~1api~1file-exports~1companies/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/leads/api/file-exports/companies","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_227","exampleIds":["paths/~1leads~1api~1file-exports~1companies/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","422"],"pointer":"/leads/api/file-exports/companies","href":"file-operations/exportcompaniestocsv","openApiOperationId":"exportCompaniesToCsv","summary":"Export companies to CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_227","exampleIds":["paths/~1leads~1api~1file-exports~1companies/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_227","exampleIds":["paths/~1leads~1api~1file-exports~1companies/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Export queued.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_228"}},"schemaId":"schema_228"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation error — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1leads~1api~1file-exports~1companies/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_228","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_228"}}},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/file-exports/companies"},{"label":"Download an exported file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/file-operations/downloadexportfile","routeSlug":"/openapi/file-operations/downloadexportfile","metadata":{"seo":{"title":"Download an exported file","description":"Retrieve a previously generated export file by name. The file_name is returned as part of the export record once the job completes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadExportFile","name":"Download an exported file","isWebhook":false,"pointer":"/paths/~1leads~1api~1file-exports~1download/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download an exported file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a previously generated export file by name. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"file_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned as part of the export record once the job completes."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_229"}},"schemaId":"schema_229","pointer":"/paths/~1leads~1api~1file-exports~1download/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/leads/api/file-exports/download","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_229"}},"responseCodes":["200","404","422"],"pointer":"/leads/api/file-exports/download","href":"file-operations/downloadexportfile","openApiOperationId":"downloadExportFile","summary":"Download an exported file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_229","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_229"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"File contents (CSV).","mediaType":"text/csv","mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_230"}},"schemaId":"schema_230"},{"code":"404","description":"File not found."},{"code":"422","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1leads~1api~1file-exports~1download/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_230","mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_230"}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/leads/api/file-exports/download"}],"content":{"contentType":"group","meta":{"name":"File Operations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"File Operations","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload and import CSV files into your CRM, and export contacts or companies to CSV. File imports run asynchronously — upload first, then trigger import-leads or import-companies. Exports return a queued job; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/file-exports/download"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" once the job completes."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/leads/api/file-imports/upload-csv","summary":"Upload a CSV file","prefix":{"name":"post","color":"post"},"badges":[],"link":"/file-operations/uploadcsvfile","deprecated":false},{"title":"/leads/api/file-imports/{uuid}/import-leads","summary":"Import contacts from uploaded file","prefix":{"name":"post","color":"post"},"badges":[],"link":"/file-operations/importleadsfromfile","deprecated":false},{"title":"/leads/api/file-imports/{uuid}/import-companies","summary":"Import companies from uploaded file","prefix":{"name":"post","color":"post"},"badges":[],"link":"/file-operations/importcompaniesfromfile","deprecated":false},{"title":"/leads/api/file-exports/leads","summary":"Export contacts to CSV","prefix":{"name":"post","color":"post"},"badges":[],"link":"/file-operations/exportleadstocsv","deprecated":false},{"title":"/leads/api/file-exports/companies","summary":"Export companies to CSV","prefix":{"name":"post","color":"post"},"badges":[],"link":"/file-operations/exportcompaniestocsv","deprecated":false},{"title":"/leads/api/file-exports/download","summary":"Download an exported file","prefix":{"name":"post","color":"post"},"badges":[],"link":"/file-operations/downloadexportfile","deprecated":false}]}]}]}]}},{"type":"separator","label":"Outreach","content":null},{"type":"group","label":"Automations","link":"/openapi/automations","routeSlug":"/openapi/automations","items":[{"label":"List automations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/listflows","routeSlug":"/openapi/automations/listflows","metadata":{"seo":{"title":"List automations","description":"Retrieve all outreach automations in your account. Automations are multi-step sequences that send LinkedIn messages, emails, and other actions on a schedule."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFlows","name":"List automations","isWebhook":false,"pointer":"/paths/~1flows~1api~1flows/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List automations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve all outreach automations in your account. Automations are multi-step sequences that send LinkedIn messages, emails, and other actions on a schedule.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_153","description":"Items per page (default 20)."},{"name":"offset","in":"query","schemaId":"schema_154","description":"Items to skip (default 0)."},{"name":"order_field","in":"query","schemaId":"schema_173","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort field (default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"order_type","in":"query","schemaId":"schema_174","description":"Sort direction."},{"name":"filter","in":"query","schemaId":"schema_231","description":"Filters."}],"pointer":"/paths/~1flows~1api~1flows/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/flows/api/flows","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_153"},{"name":"offset","in":"query","required":false,"example":0,"schemaId":"schema_154"},{"name":"order_field","in":"query","required":false,"example":"created_at","schemaId":"schema_173"},{"name":"order_type","in":"query","required":false,"example":"asc","schemaId":"schema_174"},{"name":"filter","in":"query","schemaId":"schema_231"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/flows/api/flows","href":"automations/listflows","openApiOperationId":"listFlows","summary":"List automations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of automations.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_232"}},"schemaId":"schema_232"}],"pointer":"/paths/~1flows~1api~1flows/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_232","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_232"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/flows"},{"label":"Create an automation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/createflow","routeSlug":"/openapi/automations/createflow","metadata":{"seo":{"title":"Create an automation","description":"Create a new outreach automation (flow) programmatically. The automation is created in draft status with no node tree yet — add the workflow steps in a second call to POST /flows/api/flows/{flowUuid}/flow-versions, then activate it with PUT /flows/api/flows/{flowUuid}/start."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createFlow","name":"Create an automation","isWebhook":false,"pointer":"/paths/~1flows~1api~1flows/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an automation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new outreach automation (flow) programmatically. The automation is created in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status with no node tree yet — add the workflow steps in a second call to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/createFlowVersion"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /flows/api/flows/{flowUuid}/flow-versions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then activate it with "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/startFlow"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT /flows/api/flows/{flowUuid}/start"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the entry point for building automations without the web editor. Typical agent-driven sequence:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /flows/api/flows"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — create the shell (this endpoint). 2. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /flows/api/flows/{flowUuid}/flow-versions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — save the node tree. 3. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT /flows/api/flows/{flowUuid}/start"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — go live."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_233","exampleIds":["paths/~1flows~1api~1flows/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_233","exampleIds":["paths/~1flows~1api~1flows/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1flows~1api~1flows/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/flows/api/flows","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_233","exampleIds":["paths/~1flows~1api~1flows/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","422"],"pointer":"/flows/api/flows","href":"automations/createflow","openApiOperationId":"createFlow","summary":"Create an automation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_233","exampleIds":["paths/~1flows~1api~1flows/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_233","exampleIds":["paths/~1flows~1api~1flows/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automation created (in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status, no node tree yet)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/flow"}},"schemaId":"components/schemas/flow"},{"code":"422","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1flows~1api~1flows/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/flow","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/flow"}}},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/flows"},{"label":"Get an automation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/getflow","routeSlug":"/openapi/automations/getflow","metadata":{"seo":{"title":"Get an automation","description":"Retrieve full details of an automation by UUID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFlow","name":"Get an automation","isWebhook":false,"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an automation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve full details of an automation by UUID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"flowUuid","in":"path","schemaId":"schema_164","description":"Automation UUID.","required":true}],"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/flows/api/flows/{flowUuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"flowUuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/flows/api/flows/{flowUuid}","href":"automations/getflow","openApiOperationId":"getFlow","summary":"Get an automation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Automation details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/flow"}},"schemaId":"components/schemas/flow"},{"code":"404","description":"Automation not found."}],"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/flow","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/flow"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/flows/api/flows/{flowUuid}"},{"label":"Update an automation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/updateflow","routeSlug":"/openapi/automations/updateflow","metadata":{"seo":{"title":"Update an automation","description":"Update an automation's name, description, or schedule."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateFlow","name":"Update an automation","isWebhook":false,"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an automation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an automation's name, description, or schedule."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"flowUuid","in":"path","schemaId":"schema_164","description":"Automation UUID.","required":true}],"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_234"}},"schemaId":"schema_234","pointer":"/paths/~1flows~1api~1flows~1{flowUuid}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/flows/api/flows/{flowUuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"flowUuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_234"}},"responseCodes":["200"],"pointer":"/flows/api/flows/{flowUuid}","href":"automations/updateflow","openApiOperationId":"updateFlow","summary":"Update an automation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_234","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_234"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated automation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/flow"}},"schemaId":"components/schemas/flow"}],"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/flow","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/flow"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/flows/{flowUuid}"},{"label":"Delete an automation","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/deleteflow","routeSlug":"/openapi/automations/deleteflow","metadata":{"seo":{"title":"Delete an automation","description":"Permanently delete an automation. This cannot be undone."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteFlow","name":"Delete an automation","isWebhook":false,"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an automation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Permanently delete an automation. This cannot be undone."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"flowUuid","in":"path","schemaId":"schema_164","description":"Automation UUID.","required":true}],"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/flows/api/flows/{flowUuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"flowUuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/flows/api/flows/{flowUuid}","href":"automations/deleteflow","openApiOperationId":"deleteFlow","summary":"Delete an automation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Automation deleted."}],"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}/delete/responses"}],"panels":[]}]},"httpPath":"/flows/api/flows/{flowUuid}"},{"label":"Start an automation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/startflow","routeSlug":"/openapi/automations/startflow","metadata":{"seo":{"title":"Start an automation","description":"Activate an automation so it begins processing contacts and executing outreach steps on its schedule."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"startFlow","name":"Start an automation","isWebhook":false,"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1start/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start an automation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Activate an automation so it begins processing contacts and executing outreach steps on its schedule.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"flowUuid","in":"path","schemaId":"schema_164","description":"Automation UUID.","required":true}],"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1start/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/flows/api/flows/{flowUuid}/start","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"flowUuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/flows/api/flows/{flowUuid}/start","href":"automations/startflow","openApiOperationId":"startFlow","summary":"Start an automation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Automation started.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/flow"}},"schemaId":"components/schemas/flow"},{"code":"422","description":"Cannot start (e.g., archived automation).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1start/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/flow","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/flow"}}},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/flows/{flowUuid}/start"},{"label":"Stop an automation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/stopflow","routeSlug":"/openapi/automations/stopflow","metadata":{"seo":{"title":"Stop an automation","description":"Pause an automation. Contacts already in progress will finish their current step."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"stopFlow","name":"Stop an automation","isWebhook":false,"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1stop/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stop an automation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Pause an automation. Contacts already in progress will finish their current step."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"flowUuid","in":"path","schemaId":"schema_164","description":"Automation UUID.","required":true}],"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1stop/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/flows/api/flows/{flowUuid}/stop","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"flowUuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/flows/api/flows/{flowUuid}/stop","href":"automations/stopflow","openApiOperationId":"stopFlow","summary":"Stop an automation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Automation stopped.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/flow"}},"schemaId":"components/schemas/flow"}],"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1stop/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/flow","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/flow"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/flows/{flowUuid}/stop"},{"label":"Archive an automation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/archiveflow","routeSlug":"/openapi/automations/archiveflow","metadata":{"seo":{"title":"Archive an automation","description":"Archive an automation. Archived automations cannot be started."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"archiveFlow","name":"Archive an automation","isWebhook":false,"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1archive/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive an automation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Archive an automation. Archived automations cannot be started."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"flowUuid","in":"path","schemaId":"schema_164","description":"Automation UUID.","required":true}],"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1archive/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/flows/api/flows/{flowUuid}/archive","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"flowUuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/flows/api/flows/{flowUuid}/archive","href":"automations/archiveflow","openApiOperationId":"archiveFlow","summary":"Archive an automation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Automation archived.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/flow"}},"schemaId":"components/schemas/flow"}],"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1archive/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/flow","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/flow"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/flows/{flowUuid}/archive"},{"label":"Unarchive an automation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/unarchiveflow","routeSlug":"/openapi/automations/unarchiveflow","metadata":{"seo":{"title":"Unarchive an automation","description":"Restore an archived automation so it can be started again."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"unarchiveFlow","name":"Unarchive an automation","isWebhook":false,"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1unarchive/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unarchive an automation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Restore an archived automation so it can be started again."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"flowUuid","in":"path","schemaId":"schema_164","description":"Automation UUID.","required":true}],"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1unarchive/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/flows/api/flows/{flowUuid}/unarchive","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"flowUuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/flows/api/flows/{flowUuid}/unarchive","href":"automations/unarchiveflow","openApiOperationId":"unarchiveFlow","summary":"Unarchive an automation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Automation unarchived.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/flow"}},"schemaId":"components/schemas/flow"}],"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1unarchive/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/flow","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/flow"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/flows/{flowUuid}/unarchive"},{"label":"Clone an automation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/cloneflow","routeSlug":"/openapi/automations/cloneflow","metadata":{"seo":{"title":"Clone an automation","description":"Create a copy of an existing automation with a new name. The cloned automation will be in a stopped state."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cloneFlow","name":"Clone an automation","isWebhook":false,"pointer":"/paths/~1flows~1api~1flows~1clone/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Clone an automation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a copy of an existing automation with a new name. The cloned automation will be in a stopped state.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_235"}},"schemaId":"schema_235","pointer":"/paths/~1flows~1api~1flows~1clone/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/flows/api/flows/clone","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_235"}},"responseCodes":["201"],"pointer":"/flows/api/flows/clone","href":"automations/cloneflow","openApiOperationId":"cloneFlow","summary":"Clone an automation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_235","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_235"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Cloned automation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/flow"}},"schemaId":"components/schemas/flow"}],"pointer":"/paths/~1flows~1api~1flows~1clone/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/flow","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/flow"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/flows/clone"},{"label":"Automation node statistics (funnel)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/getflownodestatistics","routeSlug":"/openapi/automations/getflownodestatistics","metadata":{"seo":{"title":"Automation node statistics (funnel)","description":"Per-step funnel for an automation — the accurate per-campaign engagement source, matching the web app. For each node you get how many contacts reached each status and the real conversions at that step."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFlowNodeStatistics","name":"Automation node statistics (funnel)","isWebhook":false,"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1nodes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Automation node statistics (funnel)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per-step funnel for an automation — "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the accurate per-campaign engagement source, matching the web app"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For each node you get how many contacts reached each status and the real conversions at that step."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prefer this over counting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trigger_..._accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tasks for acceptance/reply numbers: the trigger-task count is inflated in follow-up campaigns (contacts that entered already connected), whereas "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node_conversions.accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here is the true count. Acceptance rate = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node_conversions.accepted / node_statuses.closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the connection-request node; replies per message node = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node_conversions.replied"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the integer ids of the nodes to report on (from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getFlow"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /flows/api/flows/{flowUuid}"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → the active version's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes[].id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Add a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g. an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"executed_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/date range) to scope the period."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"flowUuid","in":"path","schemaId":"schema_164","description":"Automation UUID.","required":true}],"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1nodes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_236","exampleIds":["paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1nodes/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_236","exampleIds":["paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1nodes/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1nodes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/flows/api/flows/{flowUuid}/statistics/nodes","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"flowUuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_236","exampleIds":["paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1nodes/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","422"],"pointer":"/flows/api/flows/{flowUuid}/statistics/nodes","href":"automations/getflownodestatistics","openApiOperationId":"getFlowNodeStatistics","summary":"Automation node statistics (funnel)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_236","exampleIds":["paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1nodes/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_236","exampleIds":["paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1nodes/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Map of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → statistics. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node_statuses"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" counts contacts by task status; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node_conversions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" holds the real outcomes ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"replied"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"opened"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blocked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") — an empty array for nodes that have none; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node_branches"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (on rule/trigger nodes) counts how many took each branch."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_237","exampleIds":["paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1nodes/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_237","exampleIds":["paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1nodes/post/responses/200/content/application~1json/example"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation error — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1nodes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_237","exampleIds":["paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1nodes/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_237","exampleIds":["paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1nodes/post/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/flows/{flowUuid}/statistics/nodes"},{"label":"Automation contact-source statistics","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/getflowcontactsourcestatistics","routeSlug":"/openapi/automations/getflowcontactsourcestatistics","metadata":{"seo":{"title":"Automation contact-source statistics","description":"Funnel broken down by contact source (audience) of an automation, with a per-channel conversion breakdown. Use it to compare how different audiences of the same flow perform."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFlowContactSourceStatistics","name":"Automation contact-source statistics","isWebhook":false,"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1contact-sources/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Automation contact-source statistics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funnel broken down by "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contact source"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (audience) of an automation, with a per-channel conversion breakdown. Use it to compare how different audiences of the same flow perform."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_source_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are the integer ids from the flow version's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_sources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getFlow"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /flows/api/flows/{flowUuid}"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"flowUuid","in":"path","schemaId":"schema_164","description":"Automation UUID.","required":true}],"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1contact-sources/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_238","exampleIds":["paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1contact-sources/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_238","exampleIds":["paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1contact-sources/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1contact-sources/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/flows/api/flows/{flowUuid}/statistics/contact-sources","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"flowUuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_238","exampleIds":["paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1contact-sources/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","422"],"pointer":"/flows/api/flows/{flowUuid}/statistics/contact-sources","href":"automations/getflowcontactsourcestatistics","openApiOperationId":"getFlowContactSourceStatistics","summary":"Automation contact-source statistics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_238","exampleIds":["paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1contact-sources/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_238","exampleIds":["paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1contact-sources/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Map of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_source_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → statistics: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_source_statuses"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_source_added_by"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_source_conversions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a per-channel breakdown ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_connection_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", …) carrying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"opened"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"replied"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blocked"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_239","exampleIds":["paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1contact-sources/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_239","exampleIds":["paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1contact-sources/post/responses/200/content/application~1json/example"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation error — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_source_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1contact-sources/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_239","exampleIds":["paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1contact-sources/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_239","exampleIds":["paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1contact-sources/post/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/flows/{flowUuid}/statistics/contact-sources"},{"label":"List flow contacts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/listflowleads","routeSlug":"/openapi/automations/listflowleads","metadata":{"seo":{"title":"List flow contacts","description":"Search contacts enrolled in automations. Returns flow-lead records that link a contact to a flow with status, current node, and timing fields."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFlowLeads","name":"List flow contacts","isWebhook":false,"pointer":"/paths/~1flows~1api~1flows-leads~1list/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List flow contacts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Search contacts enrolled in automations. Returns flow-lead records that link a contact to a flow with status, current node, and timing fields.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_240","exampleIds":["paths/~1flows~1api~1flows-leads~1list/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_240","exampleIds":["paths/~1flows~1api~1flows-leads~1list/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1flows~1api~1flows-leads~1list/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/flows/api/flows-leads/list","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_240","exampleIds":["paths/~1flows~1api~1flows-leads~1list/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/flows/api/flows-leads/list","href":"automations/listflowleads","openApiOperationId":"listFlowLeads","summary":"List flow contacts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_240","exampleIds":["paths/~1flows~1api~1flows-leads~1list/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_240","exampleIds":["paths/~1flows~1api~1flows-leads~1list/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated flow-lead records.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_241"}},"schemaId":"schema_241"}],"pointer":"/paths/~1flows~1api~1flows-leads~1list/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_241","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_241"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/flows-leads/list"},{"label":"Remove contact's flow history","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/deleteflowleadhistory","routeSlug":"/openapi/automations/deleteflowleadhistory","metadata":{"seo":{"title":"Remove contact's flow history","description":"Permanently delete all flow-lead records for a contact across all automations. This removes the enrollment history; the contact itself is not deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteFlowLeadHistory","name":"Remove contact's flow history","isWebhook":false,"pointer":"/paths/~1flows~1api~1flows~1leads~1{leadUuid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove contact's flow history","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Permanently delete all flow-lead records for a contact across all automations. This removes the enrollment history; the contact itself is not deleted.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"leadUuid","in":"path","schemaId":"schema_242","description":"Contact UUID.","required":true}],"pointer":"/paths/~1flows~1api~1flows~1leads~1{leadUuid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/flows/api/flows/leads/{leadUuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"leadUuid","in":"path","required":true,"schemaId":"schema_242"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","404"],"pointer":"/flows/api/flows/leads/{leadUuid}","href":"automations/deleteflowleadhistory","openApiOperationId":"deleteFlowLeadHistory","summary":"Remove contact's flow history"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Flow history removed."},{"code":"404","description":"Contact not found or no records."}],"pointer":"/paths/~1flows~1api~1flows~1leads~1{leadUuid}/delete/responses"}],"panels":[]}]},"httpPath":"/flows/api/flows/leads/{leadUuid}"},{"label":"List automation folders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/listflowworkspaces","routeSlug":"/openapi/automations/listflowworkspaces","metadata":{"seo":{"title":"List automation folders","description":"List all automation folders (workspaces) for organizing automations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFlowWorkspaces","name":"List automation folders","isWebhook":false,"pointer":"/paths/~1flows~1api~1flow-workspaces/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List automation folders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all automation folders (workspaces) for organizing automations."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/flows/api/flow-workspaces","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/flows/api/flow-workspaces","href":"automations/listflowworkspaces","openApiOperationId":"listFlowWorkspaces","summary":"List automation folders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of automation folders.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_243"}},"schemaId":"schema_243"}],"pointer":"/paths/~1flows~1api~1flow-workspaces/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_243","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_243"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/flow-workspaces"},{"label":"Create automation folder","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/createflowworkspace","routeSlug":"/openapi/automations/createflowworkspace","metadata":{"seo":{"title":"Create automation folder","description":"Create automation folder"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createFlowWorkspace","name":"Create automation folder","isWebhook":false,"pointer":"/paths/~1flows~1api~1flow-workspaces/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create automation folder","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_244"}},"schemaId":"schema_244","pointer":"/paths/~1flows~1api~1flow-workspaces/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/flows/api/flow-workspaces","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_244"}},"responseCodes":["201"],"pointer":"/flows/api/flow-workspaces","href":"automations/createflowworkspace","openApiOperationId":"createFlowWorkspace","summary":"Create automation folder"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_244","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_244"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Automation folder created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/flow-workspace"}},"schemaId":"components/schemas/flow-workspace"}],"pointer":"/paths/~1flows~1api~1flow-workspaces/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/flow-workspace","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/flow-workspace"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/flow-workspaces"},{"label":"Update automation folder","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/updateflowworkspace","routeSlug":"/openapi/automations/updateflowworkspace","metadata":{"seo":{"title":"Update automation folder","description":"Update automation folder"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateFlowWorkspace","name":"Update automation folder","isWebhook":false,"pointer":"/paths/~1flows~1api~1flow-workspaces~1{uuid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update automation folder","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1flows~1api~1flow-workspaces~1{uuid}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_205"}},"schemaId":"schema_205","pointer":"/paths/~1flows~1api~1flow-workspaces~1{uuid}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/flows/api/flow-workspaces/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_205"}},"responseCodes":["200"],"pointer":"/flows/api/flow-workspaces/{uuid}","href":"automations/updateflowworkspace","openApiOperationId":"updateFlowWorkspace","summary":"Update automation folder"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_205","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_205"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Automation folder updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/flow-workspace"}},"schemaId":"components/schemas/flow-workspace"}],"pointer":"/paths/~1flows~1api~1flow-workspaces~1{uuid}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/flow-workspace","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/flow-workspace"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/flow-workspaces/{uuid}"},{"label":"Delete automation folder","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/deleteflowworkspace","routeSlug":"/openapi/automations/deleteflowworkspace","metadata":{"seo":{"title":"Delete automation folder","description":"Delete automation folder"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteFlowWorkspace","name":"Delete automation folder","isWebhook":false,"pointer":"/paths/~1flows~1api~1flow-workspaces~1{uuid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete automation folder","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1flows~1api~1flow-workspaces~1{uuid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/flows/api/flow-workspaces/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/flows/api/flow-workspaces/{uuid}","href":"automations/deleteflowworkspace","openApiOperationId":"deleteFlowWorkspace","summary":"Delete automation folder"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Automation folder deleted."}],"pointer":"/paths/~1flows~1api~1flow-workspaces~1{uuid}/delete/responses"}],"panels":[]}]},"httpPath":"/flows/api/flow-workspaces/{uuid}"},{"label":"Get automation metrics","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/getflowmetrics","routeSlug":"/openapi/automations/getflowmetrics","metadata":{"seo":{"title":"Get automation metrics","description":"Retrieve current-state metrics for one or more automations: contact counts and the pending task queue per automation UUID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFlowMetrics","name":"Get automation metrics","isWebhook":false,"pointer":"/paths/~1flows~1api~1flows~1metrics/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get automation metrics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve current-state metrics for one or more automations: contact counts and the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pending task queue"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" per automation UUID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"task_counts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is queue depth, not sent volume."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" It counts tasks still waiting to run (status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in_progress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") per task type — it does "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" count what has been sent. Verified against "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"List tasks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": for four automations the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"task_counts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values matched "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter[status]=in_progress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" exactly, while actual sent volume ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter[status]=closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") was 5–250× higher."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For \"how many were actually sent\" — and for anything scoped to a date range — use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/listTasks"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /flows/api/tasks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter[status]=closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter[executed_at]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" range. This endpoint has no date filter; its numbers are always current-state."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_245","exampleIds":["paths/~1flows~1api~1flows~1metrics/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_245","exampleIds":["paths/~1flows~1api~1flows~1metrics/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1flows~1api~1flows~1metrics/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/flows/api/flows/metrics","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_245","exampleIds":["paths/~1flows~1api~1flows~1metrics/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/flows/api/flows/metrics","href":"automations/getflowmetrics","openApiOperationId":"getFlowMetrics","summary":"Get automation metrics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_245","exampleIds":["paths/~1flows~1api~1flows~1metrics/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_245","exampleIds":["paths/~1flows~1api~1flows~1metrics/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Metrics keyed by automation UUID. Each entry contains contact counts and task counts broken down by task type.\n","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_246","exampleIds":["paths/~1flows~1api~1flows~1metrics/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_246","exampleIds":["paths/~1flows~1api~1flows~1metrics/post/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1flows~1api~1flows~1metrics/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_246","exampleIds":["paths/~1flows~1api~1flows~1metrics/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_246","exampleIds":["paths/~1flows~1api~1flows~1metrics/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/flows/metrics"},{"label":"Add a contact to an automation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/addleadtoflow","routeSlug":"/openapi/automations/addleadtoflow","metadata":{"seo":{"title":"Add a contact to an automation","description":"Add an existing contact to an automation. The contact will enter the automation from the beginning of the sequence."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addLeadToFlow","name":"Add a contact to an automation","isWebhook":false,"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1leads~1{leadUuid}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a contact to an automation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add an existing contact to an automation. The contact will enter the automation from the beginning of the sequence.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"flowUuid","in":"path","schemaId":"schema_164","description":"Automation UUID.","required":true},{"name":"leadUuid","in":"path","schemaId":"schema_164","description":"Contact UUID.","required":true}],"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1leads~1{leadUuid}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/flows/api/flows/{flowUuid}/leads/{leadUuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"flowUuid","in":"path","required":true,"schemaId":"schema_164"},{"name":"leadUuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","404"],"pointer":"/flows/api/flows/{flowUuid}/leads/{leadUuid}","href":"automations/addleadtoflow","openApiOperationId":"addLeadToFlow","summary":"Add a contact to an automation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Contact added."},{"code":"404","description":"Automation or contact not found."}],"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1leads~1{leadUuid}/post/responses"}],"panels":[]}]},"httpPath":"/flows/api/flows/{flowUuid}/leads/{leadUuid}"},{"label":"Create a contact and add to automation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/addnewleadtoflow","routeSlug":"/openapi/automations/addnewleadtoflow","metadata":{"seo":{"title":"Create a contact and add to automation","description":"Create a new contact and immediately add them to an automation. The contact is created in the specified list and starts the automation sequence. If skip_if_lead_exists is true, existing contacts won't be added again."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addNewLeadToFlow","name":"Create a contact and add to automation","isWebhook":false,"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1add-new-lead/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a contact and add to automation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new contact and immediately add them to an automation. The contact is created in the specified list and starts the automation sequence. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skip_if_lead_exists"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is true, existing contacts won't be added again."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"flowUuid","in":"path","schemaId":"schema_164","description":"Automation UUID.","required":true}],"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1add-new-lead/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_247","exampleIds":["paths/~1flows~1api~1flows~1{flowUuid}~1add-new-lead/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_247","exampleIds":["paths/~1flows~1api~1flows~1{flowUuid}~1add-new-lead/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1add-new-lead/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/flows/api/flows/{flowUuid}/add-new-lead","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"flowUuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_247","exampleIds":["paths/~1flows~1api~1flows~1{flowUuid}~1add-new-lead/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","204","422"],"pointer":"/flows/api/flows/{flowUuid}/add-new-lead","href":"automations/addnewleadtoflow","openApiOperationId":"addNewLeadToFlow","summary":"Create a contact and add to automation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_247","exampleIds":["paths/~1flows~1api~1flows~1{flowUuid}~1add-new-lead/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_247","exampleIds":["paths/~1flows~1api~1flows~1{flowUuid}~1add-new-lead/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Contact skipped (already exists).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_248"}},"schemaId":"schema_248"},{"code":"204","description":"Contact created and added to automation."},{"code":"422","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1add-new-lead/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_248","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_248"}}},{"code":"204"},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/flows/{flowUuid}/add-new-lead"},{"label":"Cancel contact from specific automations","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/cancelleadfromflows","routeSlug":"/openapi/automations/cancelleadfromflows","metadata":{"seo":{"title":"Cancel contact from specific automations","description":"Remove a contact from specific automations. The contact's progress in those automations will be cancelled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelLeadFromFlows","name":"Cancel contact from specific automations","isWebhook":false,"pointer":"/paths/~1flows~1api~1flows~1leads~1{leadUuid}~1cancel/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel contact from specific automations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Remove a contact from specific automations. The contact's progress in those automations will be cancelled.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"leadUuid","in":"path","schemaId":"schema_164","description":"Contact UUID.","required":true}],"pointer":"/paths/~1flows~1api~1flows~1leads~1{leadUuid}~1cancel/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_249"}},"schemaId":"schema_249","pointer":"/paths/~1flows~1api~1flows~1leads~1{leadUuid}~1cancel/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/flows/api/flows/leads/{leadUuid}/cancel","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"leadUuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_249"}},"responseCodes":["204","422"],"pointer":"/flows/api/flows/leads/{leadUuid}/cancel","href":"automations/cancelleadfromflows","openApiOperationId":"cancelLeadFromFlows","summary":"Cancel contact from specific automations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_249","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_249"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Contact cancelled from specified automations."},{"code":"422","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1flows~1api~1flows~1leads~1{leadUuid}~1cancel/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/flows/leads/{leadUuid}/cancel"},{"label":"Cancel contact from all automations","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/automations/cancelleadfromallflows","routeSlug":"/openapi/automations/cancelleadfromallflows","metadata":{"seo":{"title":"Cancel contact from all automations","description":"Remove a contact from all active automations at once."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelLeadFromAllFlows","name":"Cancel contact from all automations","isWebhook":false,"pointer":"/paths/~1flows~1api~1flows~1leads~1{leadUuid}~1cancel-all/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel contact from all automations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Remove a contact from all active automations at once."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"leadUuid","in":"path","schemaId":"schema_164","description":"Contact UUID.","required":true}],"pointer":"/paths/~1flows~1api~1flows~1leads~1{leadUuid}~1cancel-all/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/flows/api/flows/leads/{leadUuid}/cancel-all","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"leadUuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/flows/api/flows/leads/{leadUuid}/cancel-all","href":"automations/cancelleadfromallflows","openApiOperationId":"cancelLeadFromAllFlows","summary":"Cancel contact from all automations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Contact cancelled from all automations."}],"pointer":"/paths/~1flows~1api~1flows~1leads~1{leadUuid}~1cancel-all/put/responses"}],"panels":[]}]},"httpPath":"/flows/api/flows/leads/{leadUuid}/cancel-all"}],"content":{"contentType":"group","meta":{"name":"Automations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Automations","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage outreach automation sequences. Automations define multi-step workflows that send LinkedIn messages, emails, and perform other actions on a schedule."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flow statuses:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"on"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (active), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"off"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (paused), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/flows/api/flows","summary":"List automations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/automations/listflows","deprecated":false},{"title":"/flows/api/flows","summary":"Create an automation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/automations/createflow","deprecated":false},{"title":"/flows/api/flows/{flowUuid}","summary":"Get an automation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/automations/getflow","deprecated":false},{"title":"/flows/api/flows/{flowUuid}","summary":"Update an automation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/automations/updateflow","deprecated":false},{"title":"/flows/api/flows/{flowUuid}","summary":"Delete an automation","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/automations/deleteflow","deprecated":false},{"title":"/flows/api/flows/{flowUuid}/start","summary":"Start an automation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/automations/startflow","deprecated":false},{"title":"/flows/api/flows/{flowUuid}/stop","summary":"Stop an automation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/automations/stopflow","deprecated":false},{"title":"/flows/api/flows/{flowUuid}/archive","summary":"Archive an automation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/automations/archiveflow","deprecated":false},{"title":"/flows/api/flows/{flowUuid}/unarchive","summary":"Unarchive an automation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/automations/unarchiveflow","deprecated":false},{"title":"/flows/api/flows/clone","summary":"Clone an automation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/automations/cloneflow","deprecated":false},{"title":"/flows/api/flows/{flowUuid}/statistics/nodes","summary":"Automation node statistics (funnel)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/automations/getflownodestatistics","deprecated":false},{"title":"/flows/api/flows/{flowUuid}/statistics/contact-sources","summary":"Automation contact-source statistics","prefix":{"name":"post","color":"post"},"badges":[],"link":"/automations/getflowcontactsourcestatistics","deprecated":false},{"title":"/flows/api/flows-leads/list","summary":"List flow contacts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/automations/listflowleads","deprecated":false},{"title":"/flows/api/flows/leads/{leadUuid}","summary":"Remove contact's flow history","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/automations/deleteflowleadhistory","deprecated":false},{"title":"/flows/api/flow-workspaces","summary":"List automation folders","prefix":{"name":"get","color":"get"},"badges":[],"link":"/automations/listflowworkspaces","deprecated":false},{"title":"/flows/api/flow-workspaces","summary":"Create automation folder","prefix":{"name":"post","color":"post"},"badges":[],"link":"/automations/createflowworkspace","deprecated":false},{"title":"/flows/api/flow-workspaces/{uuid}","summary":"Update automation folder","prefix":{"name":"put","color":"put"},"badges":[],"link":"/automations/updateflowworkspace","deprecated":false},{"title":"/flows/api/flow-workspaces/{uuid}","summary":"Delete automation folder","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/automations/deleteflowworkspace","deprecated":false},{"title":"/flows/api/flows/metrics","summary":"Get automation metrics","prefix":{"name":"post","color":"post"},"badges":[],"link":"/automations/getflowmetrics","deprecated":false},{"title":"/flows/api/flows/{flowUuid}/leads/{leadUuid}","summary":"Add a contact to an automation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/automations/addleadtoflow","deprecated":false},{"title":"/flows/api/flows/{flowUuid}/add-new-lead","summary":"Create a contact and add to automation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/automations/addnewleadtoflow","deprecated":false},{"title":"/flows/api/flows/leads/{leadUuid}/cancel","summary":"Cancel contact from specific automations","prefix":{"name":"put","color":"put"},"badges":[],"link":"/automations/cancelleadfromflows","deprecated":false},{"title":"/flows/api/flows/leads/{leadUuid}/cancel-all","summary":"Cancel contact from all automations","prefix":{"name":"put","color":"put"},"badges":[],"link":"/automations/cancelleadfromallflows","deprecated":false}]}]}]}]}},{"type":"group","label":"Flow Versions","link":"/openapi/flow-versions","routeSlug":"/openapi/flow-versions","items":[{"label":"List flow versions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/flow-versions/listflowversions","routeSlug":"/openapi/flow-versions/listflowversions","metadata":{"seo":{"title":"List flow versions","description":"List all versions saved for a flow. Each version is an immutable snapshot."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFlowVersions","name":"List flow versions","isWebhook":false,"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1flow-versions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List flow versions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all versions saved for a flow. Each version is an immutable snapshot."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"flowUuid","in":"path","schemaId":"schema_164","description":"Automation UUID.","required":true}],"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1flow-versions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/flows/api/flows/{flowUuid}/flow-versions","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"flowUuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/flows/api/flows/{flowUuid}/flow-versions","href":"flow-versions/listflowversions","openApiOperationId":"listFlowVersions","summary":"List flow versions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of flow versions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_250"}},"schemaId":"schema_250"}],"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1flow-versions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_250","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_250"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/flows/{flowUuid}/flow-versions"},{"label":"Create a flow version","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/flow-versions/createflowversion","routeSlug":"/openapi/flow-versions/createflowversion","metadata":{"seo":{"title":"Create a flow version","description":"Save a new version (snapshot) of the flow's node tree and contact sources. Versions are immutable; activating a different version replaces the running config."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createFlowVersion","name":"Create a flow version","isWebhook":false,"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1flow-versions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a flow version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Save a new version (snapshot) of the flow's node tree and contact sources. Versions are immutable; activating a different version replaces the running config.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"flowUuid","in":"path","schemaId":"schema_164","description":"Automation UUID.","required":true}],"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1flow-versions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_251","exampleIds":["paths/~1flows~1api~1flows~1{flowUuid}~1flow-versions/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_251","exampleIds":["paths/~1flows~1api~1flows~1{flowUuid}~1flow-versions/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1flow-versions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/flows/api/flows/{flowUuid}/flow-versions","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"flowUuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_251","exampleIds":["paths/~1flows~1api~1flows~1{flowUuid}~1flow-versions/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","422"],"pointer":"/flows/api/flows/{flowUuid}/flow-versions","href":"flow-versions/createflowversion","openApiOperationId":"createFlowVersion","summary":"Create a flow version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_251","exampleIds":["paths/~1flows~1api~1flows~1{flowUuid}~1flow-versions/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_251","exampleIds":["paths/~1flows~1api~1flows~1{flowUuid}~1flow-versions/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Flow version created."},{"code":"422","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1flows~1api~1flows~1{flowUuid}~1flow-versions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/flows/{flowUuid}/flow-versions"},{"label":"Get a flow version","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/flow-versions/getflowversion","routeSlug":"/openapi/flow-versions/getflowversion","metadata":{"seo":{"title":"Get a flow version","description":"Retrieve a specific flow version by UUID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFlowVersion","name":"Get a flow version","isWebhook":false,"pointer":"/paths/~1flows~1api~1flow-versions~1{uuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a flow version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a specific flow version by UUID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1flows~1api~1flow-versions~1{uuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/flows/api/flow-versions/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/flows/api/flow-versions/{uuid}","href":"flow-versions/getflowversion","openApiOperationId":"getFlowVersion","summary":"Get a flow version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Flow version details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_176"}},"schemaId":"schema_176"},{"code":"404","description":"Not found."}],"pointer":"/paths/~1flows~1api~1flow-versions~1{uuid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_176","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_176"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/flows/api/flow-versions/{uuid}"},{"label":"Delete a flow version","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/flow-versions/deleteflowversion","routeSlug":"/openapi/flow-versions/deleteflowversion","metadata":{"seo":{"title":"Delete a flow version","description":"Permanently delete a flow version. Active versions cannot be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteFlowVersion","name":"Delete a flow version","isWebhook":false,"pointer":"/paths/~1flows~1api~1flow-versions~1{uuid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a flow version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Permanently delete a flow version. Active versions cannot be deleted."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1flows~1api~1flow-versions~1{uuid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/flows/api/flow-versions/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","404"],"pointer":"/flows/api/flow-versions/{uuid}","href":"flow-versions/deleteflowversion","openApiOperationId":"deleteFlowVersion","summary":"Delete a flow version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted."},{"code":"404","description":"Not found."}],"pointer":"/paths/~1flows~1api~1flow-versions~1{uuid}/delete/responses"}],"panels":[]}]},"httpPath":"/flows/api/flow-versions/{uuid}"},{"label":"Validate a flow node","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/flow-versions/validateflownode","routeSlug":"/openapi/flow-versions/validateflownode","metadata":{"seo":{"title":"Validate a flow node","description":"Validate a single node configuration without saving it. Useful for pre-flight checks when building a flow programmatically. Send the same node object shape you would put inside a flow version (see the flow-node schema)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"validateFlowNode","name":"Validate a flow node","isWebhook":false,"pointer":"/paths/~1flows~1api~1flow-versions~1validate-node/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate a flow node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validate a single node configuration without saving it. Useful for pre-flight checks when building a flow programmatically. Send the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same node object shape"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you would put inside a flow version (see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#schema/flow-node"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flow-node"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schema)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required fields:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" edge arrays MUST be present even when empty ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") — omitting them currently causes a server error instead of a validation error."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be an integer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", not a string. Node config lives in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object, with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"automation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to the string "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"auto\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A valid node returns "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"204 No Content"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (empty body)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/flow-node","exampleIds":["paths/~1flows~1api~1flow-versions~1validate-node/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/flow-node","exampleIds":["paths/~1flows~1api~1flow-versions~1validate-node/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1flows~1api~1flow-versions~1validate-node/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/flows/api/flow-versions/validate-node","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/flow-node","exampleIds":["paths/~1flows~1api~1flow-versions~1validate-node/post/requestBody/content/application~1json/example"]}},"responseCodes":["204","422"],"pointer":"/flows/api/flow-versions/validate-node","href":"flow-versions/validateflownode","openApiOperationId":"validateFlowNode","summary":"Validate a flow node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"components/schemas/flow-node","exampleIds":["paths/~1flows~1api~1flow-versions~1validate-node/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/flow-node","exampleIds":["paths/~1flows~1api~1flow-versions~1validate-node/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Node configuration is valid (empty body)."},{"code":"422","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1flows~1api~1flow-versions~1validate-node/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/flow-versions/validate-node"},{"label":"Validate a contact source","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/flow-versions/validatecontactsource","routeSlug":"/openapi/flow-versions/validatecontactsource","metadata":{"seo":{"title":"Validate a contact source","description":"Validate a contact source configuration without saving it."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"validateContactSource","name":"Validate a contact source","isWebhook":false,"pointer":"/paths/~1flows~1api~1flow-versions~1validate-contact-source/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate a contact source","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Validate a contact source configuration without saving it."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_252","exampleIds":["paths/~1flows~1api~1flow-versions~1validate-contact-source/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_252","exampleIds":["paths/~1flows~1api~1flow-versions~1validate-contact-source/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1flows~1api~1flow-versions~1validate-contact-source/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/flows/api/flow-versions/validate-contact-source","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_252","exampleIds":["paths/~1flows~1api~1flow-versions~1validate-contact-source/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","422"],"pointer":"/flows/api/flow-versions/validate-contact-source","href":"flow-versions/validatecontactsource","openApiOperationId":"validateContactSource","summary":"Validate a contact source"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_252","exampleIds":["paths/~1flows~1api~1flow-versions~1validate-contact-source/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_252","exampleIds":["paths/~1flows~1api~1flow-versions~1validate-contact-source/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Contact source is valid."},{"code":"422","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1flows~1api~1flow-versions~1validate-contact-source/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/flow-versions/validate-contact-source"}],"content":{"contentType":"group","meta":{"name":"Flow Versions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Flow Versions","showPageActions":true},{"nodeType":"markdoc","content":"Manage versions of automation flows. Every flow has one or more versions; each version is an immutable snapshot of the node tree and contact sources. Activating a flow version replaces the running configuration."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/flows/api/flows/{flowUuid}/flow-versions","summary":"List flow versions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/flow-versions/listflowversions","deprecated":false},{"title":"/flows/api/flows/{flowUuid}/flow-versions","summary":"Create a flow version","prefix":{"name":"post","color":"post"},"badges":[],"link":"/flow-versions/createflowversion","deprecated":false},{"title":"/flows/api/flow-versions/{uuid}","summary":"Get a flow version","prefix":{"name":"get","color":"get"},"badges":[],"link":"/flow-versions/getflowversion","deprecated":false},{"title":"/flows/api/flow-versions/{uuid}","summary":"Delete a flow version","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/flow-versions/deleteflowversion","deprecated":false},{"title":"/flows/api/flow-versions/validate-node","summary":"Validate a flow node","prefix":{"name":"post","color":"post"},"badges":[],"link":"/flow-versions/validateflownode","deprecated":false},{"title":"/flows/api/flow-versions/validate-contact-source","summary":"Validate a contact source","prefix":{"name":"post","color":"post"},"badges":[],"link":"/flow-versions/validatecontactsource","deprecated":false}]}]}]}]}},{"type":"group","label":"Tasks","link":"/openapi/tasks","routeSlug":"/openapi/tasks","items":[{"label":"List tasks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/listtasks","routeSlug":"/openapi/tasks/listtasks","metadata":{"seo":{"title":"List tasks","description":"Retrieve outreach tasks. Tasks are the individual actions an automation executes (or that you create manually) — one task per contact per step."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTasks","name":"List tasks","isWebhook":false,"pointer":"/paths/~1flows~1api~1tasks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List tasks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve outreach tasks. Tasks are the individual actions an automation executes (or that you create manually) — one task per contact per step."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All filters use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter[...]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" form"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (URL-encode the brackets: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter%5Btype%5D=..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Flat query params such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?type="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?flow_uuid="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"silently ignored"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and return unfiltered results — always use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter[...]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Counting without paging:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the count of matching tasks, so send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit=1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and read "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead of paging through results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reporting on what was actually sent:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (executed) and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"executed_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date — not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schedule_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which is often "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Date ranges use comparison operators inside the field, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter[executed_at][>=]=2026-07-22&filter[executed_at][<=]=2026-07-23"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Performance:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always narrow by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter[flow_uuid]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or another selective field) for reporting queries. Unnarrowed queries over large task volumes can time out with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"504"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example — connection requests sent by one automation on a given day:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"  &filter[flow_uuid]=f97f182b-06bb-415c-b92e-0f38f85a2048\n  &filter[type]=linkedin_send_connection_request\n  &filter[status]=closed\n  &filter[executed_at][>=]=2026-07-22\n  &filter[executed_at][<=]=2026-07-23\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"  &filter[flow_uuid]=f97f182b-06bb-415c-b92e-0f38f85a2048\n  &filter[type]=linkedin_send_connection_request\n  &filter[status]=closed\n  &filter[executed_at][>=]=2026-07-22\n  &filter[executed_at][<=]=2026-07-23\n"},"children":[]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_153","description":"Items per page (default 20)."},{"name":"offset","in":"query","schemaId":"schema_154","description":"Items to skip (default 0)."},{"name":"order_field","in":"query","schemaId":"schema_173","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort field (default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"order_type","in":"query","schemaId":"schema_174","description":"Sort direction."},{"name":"filter","in":"query","schemaId":"schema_253","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters, passed as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter[field]=value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Values follow "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#schema/mixed-filter-type"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mixed-filter-type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a scalar (equals), an array (IN), or an object with a comparison operator such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for dates."},"children":[]}]}]}],"example":{"flow_uuid":"f97f182b-06bb-415c-b92e-0f38f85a2048","type":"linkedin_send_connection_request","status":"closed"}}],"pointer":"/paths/~1flows~1api~1tasks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/flows/api/tasks","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_153"},{"name":"offset","in":"query","required":false,"example":0,"schemaId":"schema_154"},{"name":"order_field","in":"query","required":false,"example":"created_at","schemaId":"schema_173"},{"name":"order_type","in":"query","required":false,"example":"asc","schemaId":"schema_174"},{"name":"filter","in":"query","example":{"flow_uuid":"f97f182b-06bb-415c-b92e-0f38f85a2048","type":"linkedin_send_connection_request","status":"closed"},"schemaId":"schema_253","style":"deepObject","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/flows/api/tasks","href":"tasks/listtasks","openApiOperationId":"listTasks","summary":"List tasks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of tasks.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_254"}},"schemaId":"schema_254"}],"pointer":"/paths/~1flows~1api~1tasks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_254","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_254"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/tasks"},{"label":"Create a task","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/createtask","routeSlug":"/openapi/tasks/createtask","metadata":{"seo":{"title":"Create a task","description":"Create a manual outreach task. Common types: linkedin_send_message, linkedin_send_connection_request, linkedin_send_inmail, linkedin_like_latest_post, linkedin_endorse_skills."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTask","name":"Create a task","isWebhook":false,"pointer":"/paths/~1flows~1api~1tasks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a task","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a manual outreach task. Common types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_send_message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_send_connection_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_send_inmail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_like_latest_post"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_endorse_skills"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_255","exampleIds":["paths/~1flows~1api~1tasks/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_255","exampleIds":["paths/~1flows~1api~1tasks/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1flows~1api~1tasks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/flows/api/tasks","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_255","exampleIds":["paths/~1flows~1api~1tasks/post/requestBody/content/application~1json/example"]}},"responseCodes":["201"],"pointer":"/flows/api/tasks","href":"tasks/createtask","openApiOperationId":"createTask","summary":"Create a task"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_255","exampleIds":["paths/~1flows~1api~1tasks/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_255","exampleIds":["paths/~1flows~1api~1tasks/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Task created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/task"}},"schemaId":"components/schemas/task"}],"pointer":"/paths/~1flows~1api~1tasks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/task","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/task"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/tasks"},{"label":"Get a task","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/gettask","routeSlug":"/openapi/tasks/gettask","metadata":{"seo":{"title":"Get a task","description":"Retrieve details of a specific task."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTask","name":"Get a task","isWebhook":false,"pointer":"/paths/~1flows~1api~1tasks~1{uuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a task","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve details of a specific task."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1flows~1api~1tasks~1{uuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/flows/api/tasks/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/flows/api/tasks/{uuid}","href":"tasks/gettask","openApiOperationId":"getTask","summary":"Get a task"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Task details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/task"}},"schemaId":"components/schemas/task"},{"code":"404","description":"Task not found."}],"pointer":"/paths/~1flows~1api~1tasks~1{uuid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/task","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/task"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/flows/api/tasks/{uuid}"},{"label":"Complete a task","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/completetask","routeSlug":"/openapi/tasks/completetask","metadata":{"seo":{"title":"Complete a task","description":"Mark a manual task as completed. Only works for manual tasks."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"completeTask","name":"Complete a task","isWebhook":false,"pointer":"/paths/~1flows~1api~1tasks~1{uuid}~1complete/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Complete a task","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Mark a manual task as completed. Only works for manual tasks."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1flows~1api~1tasks~1{uuid}~1complete/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/flows/api/tasks/{uuid}/complete","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/flows/api/tasks/{uuid}/complete","href":"tasks/completetask","openApiOperationId":"completeTask","summary":"Complete a task"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Task completed."}],"pointer":"/paths/~1flows~1api~1tasks~1{uuid}~1complete/put/responses"}],"panels":[]}]},"httpPath":"/flows/api/tasks/{uuid}/complete"},{"label":"Cancel a task","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/canceltask","routeSlug":"/openapi/tasks/canceltask","metadata":{"seo":{"title":"Cancel a task","description":"Cancel a manual task. Only works for manual tasks."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelTask","name":"Cancel a task","isWebhook":false,"pointer":"/paths/~1flows~1api~1tasks~1{uuid}~1cancel/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a task","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancel a manual task. Only works for manual tasks."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1flows~1api~1tasks~1{uuid}~1cancel/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/flows/api/tasks/{uuid}/cancel","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/flows/api/tasks/{uuid}/cancel","href":"tasks/canceltask","openApiOperationId":"cancelTask","summary":"Cancel a task"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Task cancelled."}],"pointer":"/paths/~1flows~1api~1tasks~1{uuid}~1cancel/put/responses"}],"panels":[]}]},"httpPath":"/flows/api/tasks/{uuid}/cancel"},{"label":"Mark a task as failed","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/failtask","routeSlug":"/openapi/tasks/failtask","metadata":{"seo":{"title":"Mark a task as failed","description":"Mark a manual task as failed. Only works for manual tasks."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"failTask","name":"Mark a task as failed","isWebhook":false,"pointer":"/paths/~1flows~1api~1tasks~1{uuid}~1fail/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Mark a task as failed","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Mark a manual task as failed. Only works for manual tasks."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1flows~1api~1tasks~1{uuid}~1fail/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/flows/api/tasks/{uuid}/fail","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/flows/api/tasks/{uuid}/fail","href":"tasks/failtask","openApiOperationId":"failTask","summary":"Mark a task as failed"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Task marked as failed."}],"pointer":"/paths/~1flows~1api~1tasks~1{uuid}~1fail/put/responses"}],"panels":[]}]},"httpPath":"/flows/api/tasks/{uuid}/fail"},{"label":"Continue automation for a contact","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/continueautomation","routeSlug":"/openapi/tasks/continueautomation","metadata":{"seo":{"title":"Continue automation for a contact","description":"Resume a paused automation for a specific contact. The contact will continue from where they were paused in the automation sequence."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"continueAutomation","name":"Continue automation for a contact","isWebhook":false,"pointer":"/paths/~1flows~1api~1tasks~1continue-automation/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Continue automation for a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Resume a paused automation for a specific contact. The contact will continue from where they were paused in the automation sequence.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_256"}},"schemaId":"schema_256","pointer":"/paths/~1flows~1api~1tasks~1continue-automation/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/flows/api/tasks/continue-automation","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_256"}},"responseCodes":["200","422"],"pointer":"/flows/api/tasks/continue-automation","href":"tasks/continueautomation","openApiOperationId":"continueAutomation","summary":"Continue automation for a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_256","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_256"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Automation resumed."},{"code":"422","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1flows~1api~1tasks~1continue-automation/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/tasks/continue-automation"},{"label":"Get tasks schedule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/gettasksschedule","routeSlug":"/openapi/tasks/gettasksschedule","metadata":{"seo":{"title":"Get tasks schedule","description":"Get the tasks schedule for a specific sender profile on a given date. Returns the timeline of scheduled tasks."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTasksSchedule","name":"Get tasks schedule","isWebhook":false,"pointer":"/paths/~1flows~1api~1tasks~1schedule/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get tasks schedule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the tasks schedule for a specific sender profile on a given date. Returns the timeline of scheduled tasks.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sender_profile_uuid","in":"query","schemaId":"schema_164","description":"UUID of the sender profile.","required":true},{"name":"date","in":"query","schemaId":"schema_257","description":"Date to view schedule for (YYYY-MM-DD).","required":true,"example":"2026-04-03"}],"pointer":"/paths/~1flows~1api~1tasks~1schedule/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/flows/api/tasks/schedule","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[{"name":"sender_profile_uuid","in":"query","required":true,"schemaId":"schema_164"},{"name":"date","in":"query","required":true,"example":"2026-04-03","schemaId":"schema_257"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/flows/api/tasks/schedule","href":"tasks/gettasksschedule","openApiOperationId":"getTasksSchedule","summary":"Get tasks schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Schedule overview for the sender on the given date."}],"pointer":"/paths/~1flows~1api~1tasks~1schedule/get/responses"}],"panels":[]}]},"httpPath":"/flows/api/tasks/schedule"},{"label":"Mass cancel tasks","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/masscanceltasks","routeSlug":"/openapi/tasks/masscanceltasks","metadata":{"seo":{"title":"Mass cancel tasks","description":"Cancel multiple manual tasks at once. Only works for manual tasks."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"massCancelTasks","name":"Mass cancel tasks","isWebhook":false,"pointer":"/paths/~1flows~1api~1tasks~1mass-cancel/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Mass cancel tasks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancel multiple manual tasks at once. Only works for manual tasks."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_258"}},"schemaId":"schema_258","pointer":"/paths/~1flows~1api~1tasks~1mass-cancel/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/flows/api/tasks/mass-cancel","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_258"}},"responseCodes":["200"],"pointer":"/flows/api/tasks/mass-cancel","href":"tasks/masscanceltasks","openApiOperationId":"massCancelTasks","summary":"Mass cancel tasks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_258","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_258"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tasks cancelled."}],"pointer":"/paths/~1flows~1api~1tasks~1mass-cancel/put/responses"}],"panels":[]}]},"httpPath":"/flows/api/tasks/mass-cancel"},{"label":"Mass complete tasks","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/masscompletetasks","routeSlug":"/openapi/tasks/masscompletetasks","metadata":{"seo":{"title":"Mass complete tasks","description":"Mark multiple manual tasks as completed at once."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"massCompleteTasks","name":"Mass complete tasks","isWebhook":false,"pointer":"/paths/~1flows~1api~1tasks~1mass-complete/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Mass complete tasks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Mark multiple manual tasks as completed at once."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_259"}},"schemaId":"schema_259","pointer":"/paths/~1flows~1api~1tasks~1mass-complete/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/flows/api/tasks/mass-complete","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_259"}},"responseCodes":["200"],"pointer":"/flows/api/tasks/mass-complete","href":"tasks/masscompletetasks","openApiOperationId":"massCompleteTasks","summary":"Mass complete tasks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_259","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_259"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tasks completed."}],"pointer":"/paths/~1flows~1api~1tasks~1mass-complete/put/responses"}],"panels":[]}]},"httpPath":"/flows/api/tasks/mass-complete"},{"label":"Mass retry tasks","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/massretrytasks","routeSlug":"/openapi/tasks/massretrytasks","metadata":{"seo":{"title":"Mass retry tasks","description":"Retry multiple failed manual tasks at once."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"massRetryTasks","name":"Mass retry tasks","isWebhook":false,"pointer":"/paths/~1flows~1api~1tasks~1mass-retry/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Mass retry tasks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retry multiple failed manual tasks at once."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_260"}},"schemaId":"schema_260","pointer":"/paths/~1flows~1api~1tasks~1mass-retry/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/flows/api/tasks/mass-retry","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_260"}},"responseCodes":["200"],"pointer":"/flows/api/tasks/mass-retry","href":"tasks/massretrytasks","openApiOperationId":"massRetryTasks","summary":"Mass retry tasks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_260","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_260"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tasks retried."}],"pointer":"/paths/~1flows~1api~1tasks~1mass-retry/put/responses"}],"panels":[]}]},"httpPath":"/flows/api/tasks/mass-retry"},{"label":"Mass skip tasks","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/massskiptasks","routeSlug":"/openapi/tasks/massskiptasks","metadata":{"seo":{"title":"Mass skip tasks","description":"Skip multiple manual tasks at once."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"massSkipTasks","name":"Mass skip tasks","isWebhook":false,"pointer":"/paths/~1flows~1api~1tasks~1mass-skip/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Mass skip tasks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Skip multiple manual tasks at once."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_261"}},"schemaId":"schema_261","pointer":"/paths/~1flows~1api~1tasks~1mass-skip/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/flows/api/tasks/mass-skip","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_261"}},"responseCodes":["200"],"pointer":"/flows/api/tasks/mass-skip","href":"tasks/massskiptasks","openApiOperationId":"massSkipTasks","summary":"Mass skip tasks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_261","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_261"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tasks skipped."}],"pointer":"/paths/~1flows~1api~1tasks~1mass-skip/put/responses"}],"panels":[]}]},"httpPath":"/flows/api/tasks/mass-skip"},{"label":"Group counts for tasks","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/tasks/groupcounttasks","routeSlug":"/openapi/tasks/groupcounttasks","metadata":{"seo":{"title":"Group counts for tasks","description":"Return task counts broken down by a field, in a single request — the efficient way to get per-campaign, per-sender or per-type activity without one call per slice."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"groupCountTasks","name":"Group counts for tasks","isWebhook":false,"pointer":"/paths/~1flows~1api~1tasks~1group-counts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Group counts for tasks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return task counts "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"broken down by a field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", in a single request — the efficient way to get per-campaign, per-sender or per-type activity without one call per slice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"group_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" chooses the breakdown; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (same fields as "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/listTasks"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"List tasks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", composable) narrows what's counted. Response is a map of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"group value → count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common queries:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Connections sent per campaign (one call):"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"group_field\": \"flow_uuid\", \"filter\": { \"type\": \"linkedin_send_connection_request\", \"status\": \"closed\" } }"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One campaign's full action breakdown:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"group_field\": \"type\", \"filter\": { \"flow_uuid\": \"…\", \"status\": \"closed\" } }"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scope any of the above to a date range by adding"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"executed_at\": { \">=\": \"2026-07-01\", \"<=\": \"2026-08-01\" }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the filter."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Grouping is by a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", not by day — for a per-day series, loop date windows on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"executed_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_262","exampleIds":["paths/~1flows~1api~1tasks~1group-counts/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_262","exampleIds":["paths/~1flows~1api~1tasks~1group-counts/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1flows~1api~1tasks~1group-counts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/flows/api/tasks/group-counts","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_262","exampleIds":["paths/~1flows~1api~1tasks~1group-counts/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","422"],"pointer":"/flows/api/tasks/group-counts","href":"tasks/groupcounttasks","openApiOperationId":"groupCountTasks","summary":"Group counts for tasks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_262","exampleIds":["paths/~1flows~1api~1tasks~1group-counts/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_262","exampleIds":["paths/~1flows~1api~1tasks~1group-counts/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Map of group value → count."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_263","exampleIds":["paths/~1flows~1api~1tasks~1group-counts/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_263","exampleIds":["paths/~1flows~1api~1tasks~1group-counts/post/responses/200/content/application~1json/example"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation error — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"group_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1flows~1api~1tasks~1group-counts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_263","exampleIds":["paths/~1flows~1api~1tasks~1group-counts/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_263","exampleIds":["paths/~1flows~1api~1tasks~1group-counts/post/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/tasks/group-counts"}],"content":{"contentType":"group","meta":{"name":"Tasks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tasks","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create and manage outreach tasks such as sending LinkedIn messages or emails. Tasks can be created manually or generated by automations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Task types:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_send_message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_send_connection_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_send_inmail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_like_latest_post"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_endorse_skills"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email_send_message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trigger_linkedin_connection_request_accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Task statuses:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in_progress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"canceled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skipped"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/flows/api/tasks","summary":"List tasks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tasks/listtasks","deprecated":false},{"title":"/flows/api/tasks","summary":"Create a task","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tasks/createtask","deprecated":false},{"title":"/flows/api/tasks/{uuid}","summary":"Get a task","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tasks/gettask","deprecated":false},{"title":"/flows/api/tasks/{uuid}/complete","summary":"Complete a task","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tasks/completetask","deprecated":false},{"title":"/flows/api/tasks/{uuid}/cancel","summary":"Cancel a task","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tasks/canceltask","deprecated":false},{"title":"/flows/api/tasks/{uuid}/fail","summary":"Mark a task as failed","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tasks/failtask","deprecated":false},{"title":"/flows/api/tasks/continue-automation","summary":"Continue automation for a contact","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tasks/continueautomation","deprecated":false},{"title":"/flows/api/tasks/schedule","summary":"Get tasks schedule","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tasks/gettasksschedule","deprecated":false},{"title":"/flows/api/tasks/mass-cancel","summary":"Mass cancel tasks","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tasks/masscanceltasks","deprecated":false},{"title":"/flows/api/tasks/mass-complete","summary":"Mass complete tasks","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tasks/masscompletetasks","deprecated":false},{"title":"/flows/api/tasks/mass-retry","summary":"Mass retry tasks","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tasks/massretrytasks","deprecated":false},{"title":"/flows/api/tasks/mass-skip","summary":"Mass skip tasks","prefix":{"name":"put","color":"put"},"badges":[],"link":"/tasks/massskiptasks","deprecated":false},{"title":"/flows/api/tasks/group-counts","summary":"Group counts for tasks","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tasks/groupcounttasks","deprecated":false}]}]}]}]}},{"type":"group","label":"Sender Profiles","link":"/openapi/sender-profiles","routeSlug":"/openapi/sender-profiles","items":[{"label":"List sender profiles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/sender-profiles/listsenderprofiles","routeSlug":"/openapi/sender-profiles/listsenderprofiles","metadata":{"seo":{"title":"List sender profiles","description":"Retrieve all sender profiles. A sender profile represents a person (with linked LinkedIn account and/or email mailbox) who sends outreach messages."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSenderProfiles","name":"List sender profiles","isWebhook":false,"pointer":"/paths/~1flows~1api~1sender-profiles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List sender profiles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve all sender profiles. A sender profile represents a person (with linked LinkedIn account and/or email mailbox) who sends outreach messages.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_153","description":"Items per page (default 20)."},{"name":"offset","in":"query","schemaId":"schema_154","description":"Items to skip (default 0)."},{"name":"order_field","in":"query","schemaId":"schema_173","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort field (default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"order_type","in":"query","schemaId":"schema_174","description":"Sort direction."},{"name":"filter","in":"query","schemaId":"schema_264","description":"Filters."}],"pointer":"/paths/~1flows~1api~1sender-profiles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/flows/api/sender-profiles","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_153"},{"name":"offset","in":"query","required":false,"example":0,"schemaId":"schema_154"},{"name":"order_field","in":"query","required":false,"example":"created_at","schemaId":"schema_173"},{"name":"order_type","in":"query","required":false,"example":"asc","schemaId":"schema_174"},{"name":"filter","in":"query","schemaId":"schema_264"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/flows/api/sender-profiles","href":"sender-profiles/listsenderprofiles","openApiOperationId":"listSenderProfiles","summary":"List sender profiles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of sender profiles.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_265"}},"schemaId":"schema_265"}],"pointer":"/paths/~1flows~1api~1sender-profiles/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_265","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_265"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/sender-profiles"},{"label":"Create a sender profile","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/sender-profiles/createsenderprofile","routeSlug":"/openapi/sender-profiles/createsenderprofile","metadata":{"seo":{"title":"Create a sender profile","description":"Create a sender profile — the channel identity that sends messages. This is step 1 of connecting a LinkedIn account for an end user; attach a LinkedIn seat next with POST /browsers/api/linkedin-browsers, then mint a Smart Login link."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSenderProfile","name":"Create a sender profile","isWebhook":false,"pointer":"/paths/~1flows~1api~1sender-profiles/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a sender profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a sender profile — the channel identity that sends messages. This is step 1 of connecting a LinkedIn account for an end user; attach a LinkedIn seat next with "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/createLinkedInBrowser"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /browsers/api/linkedin-browsers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then mint a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/generateBrowserAccessKey"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Smart Login link"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_266","exampleIds":["paths/~1flows~1api~1sender-profiles/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_266","exampleIds":["paths/~1flows~1api~1sender-profiles/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1flows~1api~1sender-profiles/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/flows/api/sender-profiles","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_266","exampleIds":["paths/~1flows~1api~1sender-profiles/post/requestBody/content/application~1json/example"]}},"responseCodes":["201"],"pointer":"/flows/api/sender-profiles","href":"sender-profiles/createsenderprofile","openApiOperationId":"createSenderProfile","summary":"Create a sender profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_266","exampleIds":["paths/~1flows~1api~1sender-profiles/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_266","exampleIds":["paths/~1flows~1api~1sender-profiles/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Sender profile created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/sender-profile"}},"schemaId":"components/schemas/sender-profile"}],"pointer":"/paths/~1flows~1api~1sender-profiles/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/sender-profile","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/sender-profile"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/sender-profiles"},{"label":"Get a sender profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/sender-profiles/getsenderprofile","routeSlug":"/openapi/sender-profiles/getsenderprofile","metadata":{"seo":{"title":"Get a sender profile","description":"Retrieve details of a sender profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSenderProfile","name":"Get a sender profile","isWebhook":false,"pointer":"/paths/~1flows~1api~1sender-profiles~1{uuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a sender profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve details of a sender profile."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1flows~1api~1sender-profiles~1{uuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/flows/api/sender-profiles/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/flows/api/sender-profiles/{uuid}","href":"sender-profiles/getsenderprofile","openApiOperationId":"getSenderProfile","summary":"Get a sender profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Sender profile details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/sender-profile"}},"schemaId":"components/schemas/sender-profile"},{"code":"404","description":"Not found."}],"pointer":"/paths/~1flows~1api~1sender-profiles~1{uuid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/sender-profile","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/sender-profile"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/flows/api/sender-profiles/{uuid}"},{"label":"Update a sender profile","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/sender-profiles/updatesenderprofile","routeSlug":"/openapi/sender-profiles/updatesenderprofile","metadata":{"seo":{"title":"Update a sender profile","description":"Update a sender profile's name, label, or schedule."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSenderProfile","name":"Update a sender profile","isWebhook":false,"pointer":"/paths/~1flows~1api~1sender-profiles~1{uuid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a sender profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a sender profile's name, label, or schedule."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1flows~1api~1sender-profiles~1{uuid}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_267"}},"schemaId":"schema_267","pointer":"/paths/~1flows~1api~1sender-profiles~1{uuid}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/flows/api/sender-profiles/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_267"}},"responseCodes":["200"],"pointer":"/flows/api/sender-profiles/{uuid}","href":"sender-profiles/updatesenderprofile","openApiOperationId":"updateSenderProfile","summary":"Update a sender profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_267","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_267"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated sender profile.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/sender-profile"}},"schemaId":"components/schemas/sender-profile"}],"pointer":"/paths/~1flows~1api~1sender-profiles~1{uuid}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/sender-profile","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/sender-profile"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/sender-profiles/{uuid}"},{"label":"Delete a sender profile","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/sender-profiles/deletesenderprofile","routeSlug":"/openapi/sender-profiles/deletesenderprofile","metadata":{"seo":{"title":"Delete a sender profile","description":"Permanently delete a sender profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSenderProfile","name":"Delete a sender profile","isWebhook":false,"pointer":"/paths/~1flows~1api~1sender-profiles~1{uuid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a sender profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Permanently delete a sender profile."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1flows~1api~1sender-profiles~1{uuid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/flows/api/sender-profiles/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/flows/api/sender-profiles/{uuid}","href":"sender-profiles/deletesenderprofile","openApiOperationId":"deleteSenderProfile","summary":"Delete a sender profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted."}],"pointer":"/paths/~1flows~1api~1sender-profiles~1{uuid}/delete/responses"}],"panels":[]}]},"httpPath":"/flows/api/sender-profiles/{uuid}"},{"label":"Enable a sender profile","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/sender-profiles/enablesenderprofile","routeSlug":"/openapi/sender-profiles/enablesenderprofile","metadata":{"seo":{"title":"Enable a sender profile","description":"Enable a sender profile so it can be used in automations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"enableSenderProfile","name":"Enable a sender profile","isWebhook":false,"pointer":"/paths/~1flows~1api~1sender-profiles~1{uuid}~1enable/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Enable a sender profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Enable a sender profile so it can be used in automations."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1flows~1api~1sender-profiles~1{uuid}~1enable/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/flows/api/sender-profiles/{uuid}/enable","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/flows/api/sender-profiles/{uuid}/enable","href":"sender-profiles/enablesenderprofile","openApiOperationId":"enableSenderProfile","summary":"Enable a sender profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Enabled."}],"pointer":"/paths/~1flows~1api~1sender-profiles~1{uuid}~1enable/put/responses"}],"panels":[]}]},"httpPath":"/flows/api/sender-profiles/{uuid}/enable"},{"label":"Disable a sender profile","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/sender-profiles/disablesenderprofile","routeSlug":"/openapi/sender-profiles/disablesenderprofile","metadata":{"seo":{"title":"Disable a sender profile","description":"Disable a sender profile. It will no longer be used in automations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"disableSenderProfile","name":"Disable a sender profile","isWebhook":false,"pointer":"/paths/~1flows~1api~1sender-profiles~1{uuid}~1disable/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Disable a sender profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Disable a sender profile. It will no longer be used in automations."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1flows~1api~1sender-profiles~1{uuid}~1disable/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/flows/api/sender-profiles/{uuid}/disable","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/flows/api/sender-profiles/{uuid}/disable","href":"sender-profiles/disablesenderprofile","openApiOperationId":"disableSenderProfile","summary":"Disable a sender profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Disabled."}],"pointer":"/paths/~1flows~1api~1sender-profiles~1{uuid}~1disable/put/responses"}],"panels":[]}]},"httpPath":"/flows/api/sender-profiles/{uuid}/disable"}],"content":{"contentType":"group","meta":{"name":"Sender Profiles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sender Profiles","showPageActions":true},{"nodeType":"markdoc","content":"Sender profiles represent the LinkedIn and email accounts used to send outreach messages. Each profile links a LinkedIn browser and/or email mailbox."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/flows/api/sender-profiles","summary":"List sender profiles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sender-profiles/listsenderprofiles","deprecated":false},{"title":"/flows/api/sender-profiles","summary":"Create a sender profile","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sender-profiles/createsenderprofile","deprecated":false},{"title":"/flows/api/sender-profiles/{uuid}","summary":"Get a sender profile","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sender-profiles/getsenderprofile","deprecated":false},{"title":"/flows/api/sender-profiles/{uuid}","summary":"Update a sender profile","prefix":{"name":"put","color":"put"},"badges":[],"link":"/sender-profiles/updatesenderprofile","deprecated":false},{"title":"/flows/api/sender-profiles/{uuid}","summary":"Delete a sender profile","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/sender-profiles/deletesenderprofile","deprecated":false},{"title":"/flows/api/sender-profiles/{uuid}/enable","summary":"Enable a sender profile","prefix":{"name":"put","color":"put"},"badges":[],"link":"/sender-profiles/enablesenderprofile","deprecated":false},{"title":"/flows/api/sender-profiles/{uuid}/disable","summary":"Disable a sender profile","prefix":{"name":"put","color":"put"},"badges":[],"link":"/sender-profiles/disablesenderprofile","deprecated":false}]}]}]}]}},{"type":"separator","label":"AI","content":null},{"type":"group","label":"AI Agents","link":"/openapi/ai-agents","routeSlug":"/openapi/ai-agents","items":[{"label":"List AI Agents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ai-agents/listaiagents","routeSlug":"/openapi/ai-agents/listaiagents","metadata":{"seo":{"title":"List AI Agents","description":"Returns all AI agents in the team with their LLM configuration and metadata."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAiAgents","name":"List AI Agents","isWebhook":false,"pointer":"/paths/~1flows~1api~1ai-agents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List AI Agents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all AI agents in the team with their LLM configuration and metadata."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_153","description":"Items per page (default 20)."},{"name":"offset","in":"query","schemaId":"schema_154","description":"Items to skip (default 0)."}],"pointer":"/paths/~1flows~1api~1ai-agents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/flows/api/ai-agents","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_153"},{"name":"offset","in":"query","required":false,"example":0,"schemaId":"schema_154"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/flows/api/ai-agents","href":"ai-agents/listaiagents","openApiOperationId":"listAiAgents","summary":"List AI Agents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of AI agents.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_268"}},"schemaId":"schema_268"}],"pointer":"/paths/~1flows~1api~1ai-agents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_268","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_268"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/ai-agents"},{"label":"Create an AI Agent","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ai-agents/createaiagent","routeSlug":"/openapi/ai-agents/createaiagent","metadata":{"seo":{"title":"Create an AI Agent","description":"Create a new AI agent that will use the configured LLM for classification and similar tasks. Requires a connected LLM (classification_llm_uuid)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAiAgent","name":"Create an AI Agent","isWebhook":false,"pointer":"/paths/~1flows~1api~1ai-agents/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an AI Agent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new AI agent that will use the configured LLM for classification and similar tasks. Requires a connected LLM ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"classification_llm_uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_269","exampleIds":["paths/~1flows~1api~1ai-agents/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_269","exampleIds":["paths/~1flows~1api~1ai-agents/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1flows~1api~1ai-agents/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/flows/api/ai-agents","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_269","exampleIds":["paths/~1flows~1api~1ai-agents/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","422"],"pointer":"/flows/api/ai-agents","href":"ai-agents/createaiagent","openApiOperationId":"createAiAgent","summary":"Create an AI Agent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_269","exampleIds":["paths/~1flows~1api~1ai-agents/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_269","exampleIds":["paths/~1flows~1api~1ai-agents/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"AI agent created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ai-agent"}},"schemaId":"components/schemas/ai-agent"},{"code":"422","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1flows~1api~1ai-agents/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ai-agent","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ai-agent"}}},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/ai-agents"},{"label":"Get an AI Agent","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ai-agents/getaiagent","routeSlug":"/openapi/ai-agents/getaiagent","metadata":{"seo":{"title":"Get an AI Agent","description":"Retrieve a single AI agent by UUID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAiAgent","name":"Get an AI Agent","isWebhook":false,"pointer":"/paths/~1flows~1api~1ai-agents~1{uuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an AI Agent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a single AI agent by UUID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1flows~1api~1ai-agents~1{uuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/flows/api/ai-agents/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/flows/api/ai-agents/{uuid}","href":"ai-agents/getaiagent","openApiOperationId":"getAiAgent","summary":"Get an AI Agent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"AI agent details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ai-agent"}},"schemaId":"components/schemas/ai-agent"},{"code":"404","description":"Not found."}],"pointer":"/paths/~1flows~1api~1ai-agents~1{uuid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ai-agent","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ai-agent"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/flows/api/ai-agents/{uuid}"},{"label":"Update an AI Agent","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ai-agents/updateaiagent","routeSlug":"/openapi/ai-agents/updateaiagent","metadata":{"seo":{"title":"Update an AI Agent","description":"Update fields on an existing AI agent. Only the supplied fields are changed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAiAgent","name":"Update an AI Agent","isWebhook":false,"pointer":"/paths/~1flows~1api~1ai-agents~1{uuid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an AI Agent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update fields on an existing AI agent. Only the supplied fields are changed."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1flows~1api~1ai-agents~1{uuid}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_270","exampleIds":["paths/~1flows~1api~1ai-agents~1{uuid}/put/requestBody/content/application~1json/example"]}},"schemaId":"schema_270","exampleIds":["paths/~1flows~1api~1ai-agents~1{uuid}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1flows~1api~1ai-agents~1{uuid}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/flows/api/ai-agents/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_270","exampleIds":["paths/~1flows~1api~1ai-agents~1{uuid}/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","404","422"],"pointer":"/flows/api/ai-agents/{uuid}","href":"ai-agents/updateaiagent","openApiOperationId":"updateAiAgent","summary":"Update an AI Agent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_270","exampleIds":["paths/~1flows~1api~1ai-agents~1{uuid}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_270","exampleIds":["paths/~1flows~1api~1ai-agents~1{uuid}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"AI agent updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ai-agent"}},"schemaId":"components/schemas/ai-agent"},{"code":"404","description":"Not found."},{"code":"422","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1flows~1api~1ai-agents~1{uuid}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ai-agent","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ai-agent"}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/ai-agents/{uuid}"},{"label":"Delete an AI Agent","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ai-agents/deleteaiagent","routeSlug":"/openapi/ai-agents/deleteaiagent","metadata":{"seo":{"title":"Delete an AI Agent","description":"Permanently delete an AI agent. Cannot be undone."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAiAgent","name":"Delete an AI Agent","isWebhook":false,"pointer":"/paths/~1flows~1api~1ai-agents~1{uuid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an AI Agent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Permanently delete an AI agent. Cannot be undone."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1flows~1api~1ai-agents~1{uuid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/flows/api/ai-agents/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","404"],"pointer":"/flows/api/ai-agents/{uuid}","href":"ai-agents/deleteaiagent","openApiOperationId":"deleteAiAgent","summary":"Delete an AI Agent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted."},{"code":"404","description":"Not found."}],"pointer":"/paths/~1flows~1api~1ai-agents~1{uuid}/delete/responses"}],"panels":[]}]},"httpPath":"/flows/api/ai-agents/{uuid}"}],"content":{"contentType":"group","meta":{"name":"AI Agents"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"AI Agents","showPageActions":true},{"nodeType":"markdoc","content":"AI Agents classify incoming messages and contacts using a connected LLM. Agents have a prompt, an LLM configuration, and metrics about their classification accuracy."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/flows/api/ai-agents","summary":"List AI Agents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ai-agents/listaiagents","deprecated":false},{"title":"/flows/api/ai-agents","summary":"Create an AI Agent","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ai-agents/createaiagent","deprecated":false},{"title":"/flows/api/ai-agents/{uuid}","summary":"Get an AI Agent","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ai-agents/getaiagent","deprecated":false},{"title":"/flows/api/ai-agents/{uuid}","summary":"Update an AI Agent","prefix":{"name":"put","color":"put"},"badges":[],"link":"/ai-agents/updateaiagent","deprecated":false},{"title":"/flows/api/ai-agents/{uuid}","summary":"Delete an AI Agent","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/ai-agents/deleteaiagent","deprecated":false}]}]}]}]}},{"type":"group","label":"AI Templates","link":"/openapi/ai-templates","routeSlug":"/openapi/ai-templates","items":[{"label":"List AI Templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ai-templates/listaitemplates","routeSlug":"/openapi/ai-templates/listaitemplates","metadata":{"seo":{"title":"List AI Templates","description":"List all AI templates (reusable AI-driven message snippets) for the team."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAiTemplates","name":"List AI Templates","isWebhook":false,"pointer":"/paths/~1flows~1api~1ai-templates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List AI Templates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all AI templates (reusable AI-driven message snippets) for the team."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_153","description":"Items per page (default 20)."},{"name":"offset","in":"query","schemaId":"schema_154","description":"Items to skip (default 0)."}],"pointer":"/paths/~1flows~1api~1ai-templates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/flows/api/ai-templates","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_153"},{"name":"offset","in":"query","required":false,"example":0,"schemaId":"schema_154"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/flows/api/ai-templates","href":"ai-templates/listaitemplates","openApiOperationId":"listAiTemplates","summary":"List AI Templates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of AI templates.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_271"}},"schemaId":"schema_271"}],"pointer":"/paths/~1flows~1api~1ai-templates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_271","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_271"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/ai-templates"},{"label":"Create an AI Template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ai-templates/createaitemplate","routeSlug":"/openapi/ai-templates/createaitemplate","metadata":{"seo":{"title":"Create an AI Template","description":"Create a reusable message template. Templates are referenced from flow nodes by their uuid (the template_uuid field on linkedin_send_message, email_send_message, etc.)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAiTemplate","name":"Create an AI Template","isWebhook":false,"pointer":"/paths/~1flows~1api~1ai-templates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an AI Template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a reusable message template. Templates are referenced from flow nodes by their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"template_uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_send_message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email_send_message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", etc.)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_public"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — sending the request without it currently returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead of a validation error, so always include it ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = shared with the team, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = private). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are also required; everything else is optional and defaults to empty."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_272","exampleIds":["paths/~1flows~1api~1ai-templates/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_272","exampleIds":["paths/~1flows~1api~1ai-templates/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1flows~1api~1ai-templates/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/flows/api/ai-templates","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_272","exampleIds":["paths/~1flows~1api~1ai-templates/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","422"],"pointer":"/flows/api/ai-templates","href":"ai-templates/createaitemplate","openApiOperationId":"createAiTemplate","summary":"Create an AI Template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_272","exampleIds":["paths/~1flows~1api~1ai-templates/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_272","exampleIds":["paths/~1flows~1api~1ai-templates/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Template created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ai-template"}},"schemaId":"components/schemas/ai-template"},{"code":"422","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1flows~1api~1ai-templates/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ai-template","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ai-template"}}},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/ai-templates"},{"label":"Get an AI Template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ai-templates/getaitemplate","routeSlug":"/openapi/ai-templates/getaitemplate","metadata":{"seo":{"title":"Get an AI Template","description":"Retrieve a single AI template by UUID, including its prompt and LLM config."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAiTemplate","name":"Get an AI Template","isWebhook":false,"pointer":"/paths/~1flows~1api~1ai-templates~1{uuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an AI Template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a single AI template by UUID, including its prompt and LLM config."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1flows~1api~1ai-templates~1{uuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/flows/api/ai-templates/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/flows/api/ai-templates/{uuid}","href":"ai-templates/getaitemplate","openApiOperationId":"getAiTemplate","summary":"Get an AI Template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"AI template details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ai-template"}},"schemaId":"components/schemas/ai-template"},{"code":"404","description":"Not found."}],"pointer":"/paths/~1flows~1api~1ai-templates~1{uuid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ai-template","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ai-template"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/flows/api/ai-templates/{uuid}"},{"label":"Update an AI Template","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ai-templates/updateaitemplate","routeSlug":"/openapi/ai-templates/updateaitemplate","metadata":{"seo":{"title":"Update an AI Template","description":"Update fields on an existing AI template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAiTemplate","name":"Update an AI Template","isWebhook":false,"pointer":"/paths/~1flows~1api~1ai-templates~1{uuid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an AI Template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update fields on an existing AI template."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1flows~1api~1ai-templates~1{uuid}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_273","exampleIds":["paths/~1flows~1api~1ai-templates~1{uuid}/put/requestBody/content/application~1json/example"]}},"schemaId":"schema_273","exampleIds":["paths/~1flows~1api~1ai-templates~1{uuid}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1flows~1api~1ai-templates~1{uuid}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/flows/api/ai-templates/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_273","exampleIds":["paths/~1flows~1api~1ai-templates~1{uuid}/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","404","422"],"pointer":"/flows/api/ai-templates/{uuid}","href":"ai-templates/updateaitemplate","openApiOperationId":"updateAiTemplate","summary":"Update an AI Template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_273","exampleIds":["paths/~1flows~1api~1ai-templates~1{uuid}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_273","exampleIds":["paths/~1flows~1api~1ai-templates~1{uuid}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Template updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ai-template"}},"schemaId":"components/schemas/ai-template"},{"code":"404","description":"Not found."},{"code":"422","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1flows~1api~1ai-templates~1{uuid}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ai-template","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ai-template"}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/ai-templates/{uuid}"},{"label":"Delete an AI Template","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ai-templates/deleteaitemplate","routeSlug":"/openapi/ai-templates/deleteaitemplate","metadata":{"seo":{"title":"Delete an AI Template","description":"Delete an AI template. Returns 204; the deletion takes effect (the template disappears from the web app)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAiTemplate","name":"Delete an AI Template","isWebhook":false,"pointer":"/paths/~1flows~1api~1ai-templates~1{uuid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an AI Template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete an AI template. Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"204"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; the deletion takes effect (the template disappears from the web app)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Known issue:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" deletion appears to be a soft-delete that the API read path does not filter — after deleting, the template still resolves on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /flows/api/ai-templates/{uuid}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and still appears in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"List AI Templates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", even though it is gone from the UI (verified 2026-07-05). Treat a template as deleted once you receive the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"204"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; don't rely on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"List"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to confirm removal. See "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KNOWN_ISSUES.md"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1flows~1api~1ai-templates~1{uuid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/flows/api/ai-templates/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","404"],"pointer":"/flows/api/ai-templates/{uuid}","href":"ai-templates/deleteaitemplate","openApiOperationId":"deleteAiTemplate","summary":"Delete an AI Template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted."},{"code":"404","description":"Not found."}],"pointer":"/paths/~1flows~1api~1ai-templates~1{uuid}/delete/responses"}],"panels":[]}]},"httpPath":"/flows/api/ai-templates/{uuid}"},{"label":"Render an AI Template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/ai-templates/renderaitemplate","routeSlug":"/openapi/ai-templates/renderaitemplate","metadata":{"seo":{"title":"Render an AI Template","description":"Render a template for a specific contact and sender profile. The simplest usage is to pass an existing template uuid along with lead_uuid and sender_profile_uuid — the saved template configuration is used."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"renderAiTemplate","name":"Render an AI Template","isWebhook":false,"pointer":"/paths/~1flows~1api~1ai-templates~1render/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Render an AI Template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Render a template for a specific contact and sender profile. The simplest usage is to pass an existing template "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" along with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lead_uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sender_profile_uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the saved template configuration is used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For ad-hoc rendering without a saved template, pass the full set of fields (subject, body, type, llm_uuid, llm_config, prompt, enable_validation, enable_fallback, settings)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_274","exampleIds":["paths/~1flows~1api~1ai-templates~1render/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_274","exampleIds":["paths/~1flows~1api~1ai-templates~1render/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1flows~1api~1ai-templates~1render/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/flows/api/ai-templates/render","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_274","exampleIds":["paths/~1flows~1api~1ai-templates~1render/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","422"],"pointer":"/flows/api/ai-templates/render","href":"ai-templates/renderaitemplate","openApiOperationId":"renderAiTemplate","summary":"Render an AI Template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_274","exampleIds":["paths/~1flows~1api~1ai-templates~1render/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_274","exampleIds":["paths/~1flows~1api~1ai-templates~1render/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Rendered template.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_275"}},"schemaId":"schema_275"},{"code":"422","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1flows~1api~1ai-templates~1render/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_275","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_275"}}},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/ai-templates/render"}],"content":{"contentType":"group","meta":{"name":"AI Templates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"AI Templates","showPageActions":true},{"nodeType":"markdoc","content":"Reusable AI-driven message templates. Templates render personalized content for a given contact and sender profile, optionally calling an LLM to generate the body."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/flows/api/ai-templates","summary":"List AI Templates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ai-templates/listaitemplates","deprecated":false},{"title":"/flows/api/ai-templates","summary":"Create an AI Template","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ai-templates/createaitemplate","deprecated":false},{"title":"/flows/api/ai-templates/{uuid}","summary":"Get an AI Template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ai-templates/getaitemplate","deprecated":false},{"title":"/flows/api/ai-templates/{uuid}","summary":"Update an AI Template","prefix":{"name":"put","color":"put"},"badges":[],"link":"/ai-templates/updateaitemplate","deprecated":false},{"title":"/flows/api/ai-templates/{uuid}","summary":"Delete an AI Template","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/ai-templates/deleteaitemplate","deprecated":false},{"title":"/flows/api/ai-templates/render","summary":"Render an AI Template","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ai-templates/renderaitemplate","deprecated":false}]}]}]}]}},{"type":"separator","label":"Messaging","content":null},{"type":"group","label":"LinkedIn Messages","link":"/openapi/linkedin-messages","routeSlug":"/openapi/linkedin-messages","items":[{"label":"List LinkedIn messages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/linkedin-messages/listlinkedinmessages","routeSlug":"/openapi/linkedin-messages/listlinkedinmessages","metadata":{"seo":{"title":"List LinkedIn messages","description":"Retrieve LinkedIn messages from your unified inbox. Filter by contact, sender profile, conversation, message type (inbox/outbox), and status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listLinkedinMessages","name":"List LinkedIn messages","isWebhook":false,"pointer":"/paths/~1flows~1api~1linkedin-messages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List LinkedIn messages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve LinkedIn messages from your unified inbox. Filter by contact, sender profile, conversation, message type (inbox/outbox), and status.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_153","description":"Items per page (default 20)."},{"name":"offset","in":"query","schemaId":"schema_154","description":"Items to skip (default 0)."},{"name":"order_field","in":"query","schemaId":"schema_173","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort field (default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"order_type","in":"query","schemaId":"schema_174","description":"Sort direction."},{"name":"filter","in":"query","schemaId":"schema_276"}],"pointer":"/paths/~1flows~1api~1linkedin-messages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/flows/api/linkedin-messages","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_153"},{"name":"offset","in":"query","required":false,"example":0,"schemaId":"schema_154"},{"name":"order_field","in":"query","required":false,"example":"created_at","schemaId":"schema_173"},{"name":"order_type","in":"query","required":false,"example":"asc","schemaId":"schema_174"},{"name":"filter","in":"query","schemaId":"schema_276","style":"deepObject","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/flows/api/linkedin-messages","href":"linkedin-messages/listlinkedinmessages","openApiOperationId":"listLinkedinMessages","summary":"List LinkedIn messages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of messages.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_277"}},"schemaId":"schema_277"}],"pointer":"/paths/~1flows~1api~1linkedin-messages/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_277","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_277"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/linkedin-messages"},{"label":"Send a LinkedIn message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/linkedin-messages/sendlinkedinmessage","routeSlug":"/openapi/linkedin-messages/sendlinkedinmessage","metadata":{"seo":{"title":"Send a LinkedIn message","description":"Send a LinkedIn message to a contact through a sender profile. The message will be queued and sent via the linked LinkedIn account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendLinkedInMessage","name":"Send a LinkedIn message","isWebhook":false,"pointer":"/paths/~1flows~1api~1linkedin-messages/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send a LinkedIn message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Send a LinkedIn message to a contact through a sender profile. The message will be queued and sent via the linked LinkedIn account.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_278","exampleIds":["paths/~1flows~1api~1linkedin-messages/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_278","exampleIds":["paths/~1flows~1api~1linkedin-messages/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1flows~1api~1linkedin-messages/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/flows/api/linkedin-messages","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_278","exampleIds":["paths/~1flows~1api~1linkedin-messages/post/requestBody/content/application~1json/example"]}},"responseCodes":["201"],"pointer":"/flows/api/linkedin-messages","href":"linkedin-messages/sendlinkedinmessage","openApiOperationId":"sendLinkedInMessage","summary":"Send a LinkedIn message"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_278","exampleIds":["paths/~1flows~1api~1linkedin-messages/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_278","exampleIds":["paths/~1flows~1api~1linkedin-messages/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Message queued.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/linkedin-message"}},"schemaId":"components/schemas/linkedin-message"}],"pointer":"/paths/~1flows~1api~1linkedin-messages/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/linkedin-message","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/linkedin-message"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/linkedin-messages"},{"label":"Delete a LinkedIn message","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/linkedin-messages/deletelinkedinmessage","routeSlug":"/openapi/linkedin-messages/deletelinkedinmessage","metadata":{"seo":{"title":"Delete a LinkedIn message","description":"Delete a LinkedIn message record."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteLinkedinMessage","name":"Delete a LinkedIn message","isWebhook":false,"pointer":"/paths/~1flows~1api~1linkedin-messages~1{uuid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a LinkedIn message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a LinkedIn message record."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1flows~1api~1linkedin-messages~1{uuid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/flows/api/linkedin-messages/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/flows/api/linkedin-messages/{uuid}","href":"linkedin-messages/deletelinkedinmessage","openApiOperationId":"deleteLinkedinMessage","summary":"Delete a LinkedIn message"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted."}],"pointer":"/paths/~1flows~1api~1linkedin-messages~1{uuid}/delete/responses"}],"panels":[]}]},"httpPath":"/flows/api/linkedin-messages/{uuid}"},{"label":"Retry a failed LinkedIn message","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/linkedin-messages/retrylinkedinmessage","routeSlug":"/openapi/linkedin-messages/retrylinkedinmessage","metadata":{"seo":{"title":"Retry a failed LinkedIn message","description":"Retry sending a LinkedIn message that previously failed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retryLinkedinMessage","name":"Retry a failed LinkedIn message","isWebhook":false,"pointer":"/paths/~1flows~1api~1linkedin-messages~1{uuid}~1retry/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retry a failed LinkedIn message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retry sending a LinkedIn message that previously failed."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1flows~1api~1linkedin-messages~1{uuid}~1retry/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/flows/api/linkedin-messages/{uuid}/retry","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/flows/api/linkedin-messages/{uuid}/retry","href":"linkedin-messages/retrylinkedinmessage","openApiOperationId":"retryLinkedinMessage","summary":"Retry a failed LinkedIn message"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Message retry initiated."},{"code":"404","description":"Message not found."}],"pointer":"/paths/~1flows~1api~1linkedin-messages~1{uuid}~1retry/put/responses"}],"panels":[]}]},"httpPath":"/flows/api/linkedin-messages/{uuid}/retry"},{"label":"Group counts for LinkedIn messages","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/linkedin-messages/groupcountlinkedinmessages","routeSlug":"/openapi/linkedin-messages/groupcountlinkedinmessages","metadata":{"seo":{"title":"Group counts for LinkedIn messages","description":"Return LinkedIn-message counts broken down by a field, in one request. This is the right way to get per-sender messaging activity — including replies per sender (group_field: sender_profile_uuid + filter.type: inbox)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"groupCountLinkedinMessages","name":"Group counts for LinkedIn messages","isWebhook":false,"pointer":"/paths/~1flows~1api~1linkedin-messages~1group-counts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Group counts for LinkedIn messages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return LinkedIn-message counts "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"broken down by a field"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", in one request. This is the right way to get per-sender messaging activity — including "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"replies per sender"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"group_field: sender_profile_uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter.type: inbox"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is composable (same fields as the message list). Date scoping uses "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sent_at"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with operators (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"sent_at\": { \">=\": \"2026-07-01\" }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"); note the field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sent_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_279","exampleIds":["paths/~1flows~1api~1linkedin-messages~1group-counts/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_279","exampleIds":["paths/~1flows~1api~1linkedin-messages~1group-counts/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1flows~1api~1linkedin-messages~1group-counts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/flows/api/linkedin-messages/group-counts","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_279","exampleIds":["paths/~1flows~1api~1linkedin-messages~1group-counts/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","422"],"pointer":"/flows/api/linkedin-messages/group-counts","href":"linkedin-messages/groupcountlinkedinmessages","openApiOperationId":"groupCountLinkedinMessages","summary":"Group counts for LinkedIn messages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_279","exampleIds":["paths/~1flows~1api~1linkedin-messages~1group-counts/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_279","exampleIds":["paths/~1flows~1api~1linkedin-messages~1group-counts/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Map of group value → count."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_263","exampleIds":["paths/~1flows~1api~1linkedin-messages~1group-counts/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_263","exampleIds":["paths/~1flows~1api~1linkedin-messages~1group-counts/post/responses/200/content/application~1json/example"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation error — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"group_field"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1flows~1api~1linkedin-messages~1group-counts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_263","exampleIds":["paths/~1flows~1api~1linkedin-messages~1group-counts/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_263","exampleIds":["paths/~1flows~1api~1linkedin-messages~1group-counts/post/responses/200/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/linkedin-messages/group-counts"}],"content":{"contentType":"group","meta":{"name":"LinkedIn Messages"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"LinkedIn Messages","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send and retrieve LinkedIn messages through your connected sender profiles."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LinkedIn message types:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"connection_note"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"InMail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Message statuses:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in_progress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"done"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automation field:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auto"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (sent by automation), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (sent by user), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"synced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (incoming message synced from LinkedIn)."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/flows/api/linkedin-messages","summary":"List LinkedIn messages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/linkedin-messages/listlinkedinmessages","deprecated":false},{"title":"/flows/api/linkedin-messages","summary":"Send a LinkedIn message","prefix":{"name":"post","color":"post"},"badges":[],"link":"/linkedin-messages/sendlinkedinmessage","deprecated":false},{"title":"/flows/api/linkedin-messages/{uuid}","summary":"Delete a LinkedIn message","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/linkedin-messages/deletelinkedinmessage","deprecated":false},{"title":"/flows/api/linkedin-messages/{uuid}/retry","summary":"Retry a failed LinkedIn message","prefix":{"name":"put","color":"put"},"badges":[],"link":"/linkedin-messages/retrylinkedinmessage","deprecated":false},{"title":"/flows/api/linkedin-messages/group-counts","summary":"Group counts for LinkedIn messages","prefix":{"name":"post","color":"post"},"badges":[],"link":"/linkedin-messages/groupcountlinkedinmessages","deprecated":false}]}]}]}]}},{"type":"group","label":"Emails","link":"/openapi/emails","routeSlug":"/openapi/emails","items":[{"label":"List emails","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/emails/listemails","routeSlug":"/openapi/emails/listemails","metadata":{"seo":{"title":"List emails","description":"Retrieve emails from your unified inbox. Filter by contact, mailbox, automation (flow_uuid), type (inbox/outbox), status, and date range."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEmails","name":"List emails","isWebhook":false,"pointer":"/paths/~1emails~1api~1emails/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List emails","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve emails from your unified inbox. Filter by contact, mailbox, automation ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flow_uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), type ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inbox"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outbox"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), status, and date range."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters use the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter[...]"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" form (URL-encode the brackets); flat params are ignored. Read "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit=1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to count without paging."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reporting on email sent per campaign:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unlike LinkedIn messages, emails carry "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flow_uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so email volume can be counted per automation. Note that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=outbox"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" includes emails "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"synced from the mailbox"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=sync"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") as well as those "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sent by an automation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=sent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") — filter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=sent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or a non-empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flow_uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") to count only what Grinfi sent. Date range uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sent_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operators, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter[sent_at][>=]=2026-07-01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There is no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"group-counts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint for emails — build breakdowns by issuing one filtered count per slice (by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flow_uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mailbox_uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", date, …)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_153","description":"Items per page (default 20)."},{"name":"offset","in":"query","schemaId":"schema_154","description":"Items to skip (default 0)."},{"name":"order_field","in":"query","schemaId":"schema_173","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort field (default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"order_type","in":"query","schemaId":"schema_174","description":"Sort direction."},{"name":"filter","in":"query","schemaId":"schema_280","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters, passed as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter[field]=value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1emails~1api~1emails/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/emails/api/emails","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_153"},{"name":"offset","in":"query","required":false,"example":0,"schemaId":"schema_154"},{"name":"order_field","in":"query","required":false,"example":"created_at","schemaId":"schema_173"},{"name":"order_type","in":"query","required":false,"example":"asc","schemaId":"schema_174"},{"name":"filter","in":"query","schemaId":"schema_280","style":"deepObject","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/emails/api/emails","href":"emails/listemails","openApiOperationId":"listEmails","summary":"List emails"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of emails.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_281"}},"schemaId":"schema_281"}],"pointer":"/paths/~1emails~1api~1emails/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_281","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_281"}}}],"examples":[]}]}]}]},"httpPath":"/emails/api/emails"},{"label":"Get an email","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/emails/getemail","routeSlug":"/openapi/emails/getemail","metadata":{"seo":{"title":"Get an email","description":"Retrieve full details of an email by UUID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEmail","name":"Get an email","isWebhook":false,"pointer":"/paths/~1emails~1api~1emails~1{uuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve full details of an email by UUID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1emails~1api~1emails~1{uuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/emails/api/emails/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/emails/api/emails/{uuid}","href":"emails/getemail","openApiOperationId":"getEmail","summary":"Get an email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Email details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/email"}},"schemaId":"components/schemas/email"},{"code":"404","description":"Email not found."}],"pointer":"/paths/~1emails~1api~1emails~1{uuid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/email","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/email"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/emails/api/emails/{uuid}"},{"label":"Delete an email","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/emails/deleteemail","routeSlug":"/openapi/emails/deleteemail","metadata":{"seo":{"title":"Delete an email","description":"Delete an email record."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEmail","name":"Delete an email","isWebhook":false,"pointer":"/paths/~1emails~1api~1emails~1{uuid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete an email record."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1emails~1api~1emails~1{uuid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/emails/api/emails/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/emails/api/emails/{uuid}","href":"emails/deleteemail","openApiOperationId":"deleteEmail","summary":"Delete an email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted."}],"pointer":"/paths/~1emails~1api~1emails~1{uuid}/delete/responses"}],"panels":[]}]},"httpPath":"/emails/api/emails/{uuid}"},{"label":"Send an email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/emails/sendemail","routeSlug":"/openapi/emails/sendemail","metadata":{"seo":{"title":"Send an email","description":"Send a new email to a contact through a connected mailbox."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendEmail","name":"Send an email","isWebhook":false,"pointer":"/paths/~1emails~1api~1emails~1send-email/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send an email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Send a new email to a contact through a connected mailbox.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_282","exampleIds":["paths/~1emails~1api~1emails~1send-email/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_282","exampleIds":["paths/~1emails~1api~1emails~1send-email/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1emails~1api~1emails~1send-email/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/emails/api/emails/send-email","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_282","exampleIds":["paths/~1emails~1api~1emails~1send-email/post/requestBody/content/application~1json/example"]}},"responseCodes":["201"],"pointer":"/emails/api/emails/send-email","href":"emails/sendemail","openApiOperationId":"sendEmail","summary":"Send an email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_282","exampleIds":["paths/~1emails~1api~1emails~1send-email/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_282","exampleIds":["paths/~1emails~1api~1emails~1send-email/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Email sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_283"}},"schemaId":"schema_283"}],"pointer":"/paths/~1emails~1api~1emails~1send-email/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_283","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_283"}}}],"examples":[]}]}]}]},"httpPath":"/emails/api/emails/send-email"},{"label":"List email bodies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/emails/listemailbodies","routeSlug":"/openapi/emails/listemailbodies","metadata":{"seo":{"title":"List email bodies","description":"List email body records (HTML content, subject, attachments)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEmailBodies","name":"List email bodies","isWebhook":false,"pointer":"/paths/~1emails~1api~1email-bodies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List email bodies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List email body records (HTML content, subject, attachments)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_153","description":"Items per page (default 20)."},{"name":"offset","in":"query","schemaId":"schema_154","description":"Items to skip (default 0)."},{"name":"order_field","in":"query","schemaId":"schema_173","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort field (default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"order_type","in":"query","schemaId":"schema_174","description":"Sort direction."},{"name":"search","in":"query","schemaId":"schema_164","description":"Search email bodies."}],"pointer":"/paths/~1emails~1api~1email-bodies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/emails/api/email-bodies","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_153"},{"name":"offset","in":"query","required":false,"example":0,"schemaId":"schema_154"},{"name":"order_field","in":"query","required":false,"example":"created_at","schemaId":"schema_173"},{"name":"order_type","in":"query","required":false,"example":"asc","schemaId":"schema_174"},{"name":"search","in":"query","schemaId":"schema_164"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/emails/api/email-bodies","href":"emails/listemailbodies","openApiOperationId":"listEmailBodies","summary":"List email bodies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of email bodies.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_284"}},"schemaId":"schema_284"}],"pointer":"/paths/~1emails~1api~1email-bodies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_284","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_284"}}}],"examples":[]}]}]}]},"httpPath":"/emails/api/email-bodies"},{"label":"Get an email body","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/emails/getemailbody","routeSlug":"/openapi/emails/getemailbody","metadata":{"seo":{"title":"Get an email body","description":"Get the HTML content, subject, and attachments of an email body."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEmailBody","name":"Get an email body","isWebhook":false,"pointer":"/paths/~1emails~1api~1email-bodies~1{uuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an email body","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the HTML content, subject, and attachments of an email body."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1emails~1api~1email-bodies~1{uuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/emails/api/email-bodies/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/emails/api/email-bodies/{uuid}","href":"emails/getemailbody","openApiOperationId":"getEmailBody","summary":"Get an email body"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Email body details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/email-body"}},"schemaId":"components/schemas/email-body"},{"code":"404","description":"Not found."}],"pointer":"/paths/~1emails~1api~1email-bodies~1{uuid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/email-body","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/email-body"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/emails/api/email-bodies/{uuid}"},{"label":"Get email thread","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/emails/getemailthread","routeSlug":"/openapi/emails/getemailthread","metadata":{"seo":{"title":"Get email thread","description":"Get the conversation thread for a reply email."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEmailThread","name":"Get email thread","isWebhook":false,"pointer":"/paths/~1emails~1api~1emails~1{uuid}~1thread/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get email thread","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the conversation thread for a reply email."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1emails~1api~1emails~1{uuid}~1thread/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/emails/api/emails/{uuid}/thread","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/emails/api/emails/{uuid}/thread","href":"emails/getemailthread","openApiOperationId":"getEmailThread","summary":"Get email thread"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Email thread content."}],"pointer":"/paths/~1emails~1api~1emails~1{uuid}~1thread/get/responses"}],"panels":[]}]},"httpPath":"/emails/api/emails/{uuid}/thread"},{"label":"Get latest emails by leads","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/emails/getlatestemailsbyleads","routeSlug":"/openapi/emails/getlatestemailsbyleads","metadata":{"seo":{"title":"Get latest emails by leads","description":"Get the most recent email for each of the specified contact UUIDs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLatestEmailsByLeads","name":"Get latest emails by leads","isWebhook":false,"pointer":"/paths/~1emails~1api~1emails~1latest-by-leads/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get latest emails by leads","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the most recent email for each of the specified contact UUIDs."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_285"}},"schemaId":"schema_285","pointer":"/paths/~1emails~1api~1emails~1latest-by-leads/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/emails/api/emails/latest-by-leads","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_285"}},"responseCodes":["200"],"pointer":"/emails/api/emails/latest-by-leads","href":"emails/getlatestemailsbyleads","openApiOperationId":"getLatestEmailsByLeads","summary":"Get latest emails by leads"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_285","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_285"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Latest email per contact."}],"pointer":"/paths/~1emails~1api~1emails~1latest-by-leads/post/responses"}],"panels":[]}]},"httpPath":"/emails/api/emails/latest-by-leads"},{"label":"Get email thread for LLM","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/emails/getemailllmthread","routeSlug":"/openapi/emails/getemailllmthread","metadata":{"seo":{"title":"Get email thread for LLM","description":"Get an email conversation thread formatted for LLM processing. Optimized for AI analysis and response generation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEmailLLMThread","name":"Get email thread for LLM","isWebhook":false,"pointer":"/paths/~1emails~1api~1emails~1llm-thread/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get email thread for LLM","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get an email conversation thread formatted for LLM processing. Optimized for AI analysis and response generation.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_286"}},"schemaId":"schema_286","pointer":"/paths/~1emails~1api~1emails~1llm-thread/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/emails/api/emails/llm-thread","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_286"}},"responseCodes":["200"],"pointer":"/emails/api/emails/llm-thread","href":"emails/getemailllmthread","openApiOperationId":"getEmailLLMThread","summary":"Get email thread for LLM"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_286","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_286"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"LLM-formatted email thread."}],"pointer":"/paths/~1emails~1api~1emails~1llm-thread/post/responses"}],"panels":[]}]},"httpPath":"/emails/api/emails/llm-thread"}],"content":{"contentType":"group","meta":{"name":"Emails"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Emails","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send and retrieve emails through your connected mailboxes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email types:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inbox"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (received), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outbox"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (sent)."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/emails/api/emails","summary":"List emails","prefix":{"name":"get","color":"get"},"badges":[],"link":"/emails/listemails","deprecated":false},{"title":"/emails/api/emails/{uuid}","summary":"Get an email","prefix":{"name":"get","color":"get"},"badges":[],"link":"/emails/getemail","deprecated":false},{"title":"/emails/api/emails/{uuid}","summary":"Delete an email","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/emails/deleteemail","deprecated":false},{"title":"/emails/api/emails/send-email","summary":"Send an email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/emails/sendemail","deprecated":false},{"title":"/emails/api/email-bodies","summary":"List email bodies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/emails/listemailbodies","deprecated":false},{"title":"/emails/api/email-bodies/{uuid}","summary":"Get an email body","prefix":{"name":"get","color":"get"},"badges":[],"link":"/emails/getemailbody","deprecated":false},{"title":"/emails/api/emails/{uuid}/thread","summary":"Get email thread","prefix":{"name":"get","color":"get"},"badges":[],"link":"/emails/getemailthread","deprecated":false},{"title":"/emails/api/emails/latest-by-leads","summary":"Get latest emails by leads","prefix":{"name":"post","color":"post"},"badges":[],"link":"/emails/getlatestemailsbyleads","deprecated":false},{"title":"/emails/api/emails/llm-thread","summary":"Get email thread for LLM","prefix":{"name":"post","color":"post"},"badges":[],"link":"/emails/getemailllmthread","deprecated":false}]}]}]}]}},{"type":"group","label":"Mailboxes","link":"/openapi/mailboxes","routeSlug":"/openapi/mailboxes","items":[{"label":"List mailboxes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/mailboxes/listmailboxes","routeSlug":"/openapi/mailboxes/listmailboxes","metadata":{"seo":{"title":"List mailboxes","description":"Retrieve all email mailboxes (SMTP/IMAP, Gmail, Outlook) configured in your account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listMailboxes","name":"List mailboxes","isWebhook":false,"pointer":"/paths/~1emails~1api~1mailboxes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List mailboxes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve all email mailboxes (SMTP/IMAP, Gmail, Outlook) configured in your account.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_153","description":"Items per page (default 20)."},{"name":"offset","in":"query","schemaId":"schema_154","description":"Items to skip (default 0)."},{"name":"order_field","in":"query","schemaId":"schema_173","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort field (default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"order_type","in":"query","schemaId":"schema_174","description":"Sort direction."},{"name":"filter","in":"query","schemaId":"schema_287"}],"pointer":"/paths/~1emails~1api~1mailboxes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/emails/api/mailboxes","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_153"},{"name":"offset","in":"query","required":false,"example":0,"schemaId":"schema_154"},{"name":"order_field","in":"query","required":false,"example":"created_at","schemaId":"schema_173"},{"name":"order_type","in":"query","required":false,"example":"asc","schemaId":"schema_174"},{"name":"filter","in":"query","schemaId":"schema_287"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/emails/api/mailboxes","href":"mailboxes/listmailboxes","openApiOperationId":"listMailboxes","summary":"List mailboxes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of mailboxes.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_288"}},"schemaId":"schema_288"}],"pointer":"/paths/~1emails~1api~1mailboxes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_288","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_288"}}}],"examples":[]}]}]}]},"httpPath":"/emails/api/mailboxes"},{"label":"Create a mailbox","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/mailboxes/createmailbox","routeSlug":"/openapi/mailboxes/createmailbox","metadata":{"seo":{"title":"Create a mailbox","description":"Add a new SMTP/IMAP mailbox with connection settings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createMailbox","name":"Create a mailbox","isWebhook":false,"pointer":"/paths/~1emails~1api~1mailboxes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a mailbox","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add a new SMTP/IMAP mailbox with connection settings.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_289"}},"schemaId":"schema_289","pointer":"/paths/~1emails~1api~1mailboxes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/emails/api/mailboxes","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_289"}},"responseCodes":["201"],"pointer":"/emails/api/mailboxes","href":"mailboxes/createmailbox","openApiOperationId":"createMailbox","summary":"Create a mailbox"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_289","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_289"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Mailbox created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/mailbox"}},"schemaId":"components/schemas/mailbox"}],"pointer":"/paths/~1emails~1api~1mailboxes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/mailbox","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/mailbox"}}}],"examples":[]}]}]}]},"httpPath":"/emails/api/mailboxes"},{"label":"Get a mailbox","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/mailboxes/getmailbox","routeSlug":"/openapi/mailboxes/getmailbox","metadata":{"seo":{"title":"Get a mailbox","description":"Retrieve details of a specific mailbox."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMailbox","name":"Get a mailbox","isWebhook":false,"pointer":"/paths/~1emails~1api~1mailboxes~1{uuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a mailbox","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve details of a specific mailbox."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1emails~1api~1mailboxes~1{uuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/emails/api/mailboxes/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/emails/api/mailboxes/{uuid}","href":"mailboxes/getmailbox","openApiOperationId":"getMailbox","summary":"Get a mailbox"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Mailbox details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/mailbox"}},"schemaId":"components/schemas/mailbox"},{"code":"404","description":"Not found."}],"pointer":"/paths/~1emails~1api~1mailboxes~1{uuid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/mailbox","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/mailbox"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/emails/api/mailboxes/{uuid}"},{"label":"Update a mailbox","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/mailboxes/updatemailbox","routeSlug":"/openapi/mailboxes/updatemailbox","metadata":{"seo":{"title":"Update a mailbox","description":"Update mailbox settings such as sender name, daily limits, or connection details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateMailbox","name":"Update a mailbox","isWebhook":false,"pointer":"/paths/~1emails~1api~1mailboxes~1{uuid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a mailbox","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update mailbox settings such as sender name, daily limits, or connection details."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1emails~1api~1mailboxes~1{uuid}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290","pointer":"/paths/~1emails~1api~1mailboxes~1{uuid}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/emails/api/mailboxes/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_290"}},"responseCodes":["200"],"pointer":"/emails/api/mailboxes/{uuid}","href":"mailboxes/updatemailbox","openApiOperationId":"updateMailbox","summary":"Update a mailbox"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_290"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Updated mailbox.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/mailbox"}},"schemaId":"components/schemas/mailbox"}],"pointer":"/paths/~1emails~1api~1mailboxes~1{uuid}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/mailbox","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/mailbox"}}}],"examples":[]}]}]}]},"httpPath":"/emails/api/mailboxes/{uuid}"},{"label":"Delete a mailbox","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/mailboxes/deletemailbox","routeSlug":"/openapi/mailboxes/deletemailbox","metadata":{"seo":{"title":"Delete a mailbox","description":"Delete a mailbox. Optionally reassign automations to another mailbox."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteMailbox","name":"Delete a mailbox","isWebhook":false,"pointer":"/paths/~1emails~1api~1mailboxes~1{uuid}/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a mailbox","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a mailbox. Optionally reassign automations to another mailbox.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1emails~1api~1mailboxes~1{uuid}/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_291"}},"schemaId":"schema_291","pointer":"/paths/~1emails~1api~1mailboxes~1{uuid}/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/emails/api/mailboxes/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_291"}},"responseCodes":["204"],"pointer":"/emails/api/mailboxes/{uuid}","href":"mailboxes/deletemailbox","openApiOperationId":"deleteMailbox","summary":"Delete a mailbox"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_291","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_291"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted."}],"pointer":"/paths/~1emails~1api~1mailboxes~1{uuid}/delete/responses"}],"panels":[]}]},"httpPath":"/emails/api/mailboxes/{uuid}"},{"label":"Activate a mailbox","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/mailboxes/activatemailbox","routeSlug":"/openapi/mailboxes/activatemailbox","metadata":{"seo":{"title":"Activate a mailbox","description":"Enable a mailbox so it can send and sync emails."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"activateMailbox","name":"Activate a mailbox","isWebhook":false,"pointer":"/paths/~1emails~1api~1mailboxes~1{uuid}~1activate/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activate a mailbox","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Enable a mailbox so it can send and sync emails."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1emails~1api~1mailboxes~1{uuid}~1activate/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/emails/api/mailboxes/{uuid}/activate","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/emails/api/mailboxes/{uuid}/activate","href":"mailboxes/activatemailbox","openApiOperationId":"activateMailbox","summary":"Activate a mailbox"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Activated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/mailbox"}},"schemaId":"components/schemas/mailbox"}],"pointer":"/paths/~1emails~1api~1mailboxes~1{uuid}~1activate/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/mailbox","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/mailbox"}}}],"examples":[]}]}]}]},"httpPath":"/emails/api/mailboxes/{uuid}/activate"},{"label":"Deactivate a mailbox","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/mailboxes/deactivatemailbox","routeSlug":"/openapi/mailboxes/deactivatemailbox","metadata":{"seo":{"title":"Deactivate a mailbox","description":"Disable a mailbox. It will stop sending and syncing emails."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deactivateMailbox","name":"Deactivate a mailbox","isWebhook":false,"pointer":"/paths/~1emails~1api~1mailboxes~1{uuid}~1deactivate/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deactivate a mailbox","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Disable a mailbox. It will stop sending and syncing emails."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1emails~1api~1mailboxes~1{uuid}~1deactivate/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/emails/api/mailboxes/{uuid}/deactivate","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/emails/api/mailboxes/{uuid}/deactivate","href":"mailboxes/deactivatemailbox","openApiOperationId":"deactivateMailbox","summary":"Deactivate a mailbox"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Deactivated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/mailbox"}},"schemaId":"components/schemas/mailbox"}],"pointer":"/paths/~1emails~1api~1mailboxes~1{uuid}~1deactivate/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/mailbox","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/mailbox"}}}],"examples":[]}]}]}]},"httpPath":"/emails/api/mailboxes/{uuid}/deactivate"},{"label":"List mailbox errors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/mailboxes/listmailboxerrors","routeSlug":"/openapi/mailboxes/listmailboxerrors","metadata":{"seo":{"title":"List mailbox errors","description":"List mailbox send/sync errors for debugging. Shows errors with timestamps and details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listMailboxErrors","name":"List mailbox errors","isWebhook":false,"pointer":"/paths/~1emails~1api~1mailbox-errors/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List mailbox errors","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List mailbox send/sync errors for debugging. Shows errors with timestamps and details.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_153","description":"Items per page (default 20)."},{"name":"offset","in":"query","schemaId":"schema_154","description":"Items to skip (default 0)."},{"name":"order_field","in":"query","schemaId":"schema_173","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort field (default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"order_type","in":"query","schemaId":"schema_174","description":"Sort direction."},{"name":"search","in":"query","schemaId":"schema_164","description":"Search errors."}],"pointer":"/paths/~1emails~1api~1mailbox-errors/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/emails/api/mailbox-errors","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_153"},{"name":"offset","in":"query","required":false,"example":0,"schemaId":"schema_154"},{"name":"order_field","in":"query","required":false,"example":"created_at","schemaId":"schema_173"},{"name":"order_type","in":"query","required":false,"example":"asc","schemaId":"schema_174"},{"name":"search","in":"query","schemaId":"schema_164"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/emails/api/mailbox-errors","href":"mailboxes/listmailboxerrors","openApiOperationId":"listMailboxErrors","summary":"List mailbox errors"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of mailbox errors.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_292"}},"schemaId":"schema_292"}],"pointer":"/paths/~1emails~1api~1mailbox-errors/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_292","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_292"}}}],"examples":[]}]}]}]},"httpPath":"/emails/api/mailbox-errors"}],"content":{"contentType":"group","meta":{"name":"Mailboxes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Mailboxes","showPageActions":true},{"nodeType":"markdoc","content":"Manage email mailboxes (SMTP/IMAP, Gmail, Outlook) used for sending and receiving emails in outreach campaigns."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/emails/api/mailboxes","summary":"List mailboxes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/mailboxes/listmailboxes","deprecated":false},{"title":"/emails/api/mailboxes","summary":"Create a mailbox","prefix":{"name":"post","color":"post"},"badges":[],"link":"/mailboxes/createmailbox","deprecated":false},{"title":"/emails/api/mailboxes/{uuid}","summary":"Get a mailbox","prefix":{"name":"get","color":"get"},"badges":[],"link":"/mailboxes/getmailbox","deprecated":false},{"title":"/emails/api/mailboxes/{uuid}","summary":"Update a mailbox","prefix":{"name":"put","color":"put"},"badges":[],"link":"/mailboxes/updatemailbox","deprecated":false},{"title":"/emails/api/mailboxes/{uuid}","summary":"Delete a mailbox","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/mailboxes/deletemailbox","deprecated":false},{"title":"/emails/api/mailboxes/{uuid}/activate","summary":"Activate a mailbox","prefix":{"name":"put","color":"put"},"badges":[],"link":"/mailboxes/activatemailbox","deprecated":false},{"title":"/emails/api/mailboxes/{uuid}/deactivate","summary":"Deactivate a mailbox","prefix":{"name":"put","color":"put"},"badges":[],"link":"/mailboxes/deactivatemailbox","deprecated":false},{"title":"/emails/api/mailbox-errors","summary":"List mailbox errors","prefix":{"name":"get","color":"get"},"badges":[],"link":"/mailboxes/listmailboxerrors","deprecated":false}]}]}]}]}},{"type":"group","label":"Attachments","link":"/openapi/attachments","routeSlug":"/openapi/attachments","items":[{"label":"List attachments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/attachments/listattachments","routeSlug":"/openapi/attachments/listattachments","metadata":{"seo":{"title":"List attachments","description":"List files uploaded to your team's attachment storage. Attachments can be referenced by UUID when sending LinkedIn messages, emails, or from automation message nodes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAttachments","name":"List attachments","isWebhook":false,"pointer":"/paths/~1flows~1api~1attachments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List attachments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List files uploaded to your team's attachment storage. Attachments can be referenced by UUID when sending LinkedIn messages, emails, or from automation message nodes.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_153","description":"Items per page (default 20)."},{"name":"offset","in":"query","schemaId":"schema_154","description":"Items to skip (default 0)."},{"name":"order_field","in":"query","schemaId":"schema_173","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort field (default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"order_type","in":"query","schemaId":"schema_174","description":"Sort direction."}],"pointer":"/paths/~1flows~1api~1attachments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/flows/api/attachments","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"example":20,"schemaId":"schema_153"},{"name":"offset","in":"query","required":false,"example":0,"schemaId":"schema_154"},{"name":"order_field","in":"query","required":false,"example":"created_at","schemaId":"schema_173"},{"name":"order_type","in":"query","required":false,"example":"asc","schemaId":"schema_174"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/flows/api/attachments","href":"attachments/listattachments","openApiOperationId":"listAttachments","summary":"List attachments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of attachments.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_293"}},"schemaId":"schema_293"}],"pointer":"/paths/~1flows~1api~1attachments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_293","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_293"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/attachments"},{"label":"Upload an attachment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/attachments/uploadattachment","routeSlug":"/openapi/attachments/uploadattachment","metadata":{"seo":{"title":"Upload an attachment","description":"Upload a file (image, PDF, document) to attachment storage. Use multipart/form-data. Returns an attachment UUID that can be used in attachments: [{ \"uuid\": \"...\" }] when sending LinkedIn messages or emails. Supported types include images (JPG, PNG, GIF), documents (PDF, DOCX), and other common formats."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadAttachment","name":"Upload an attachment","isWebhook":false,"pointer":"/paths/~1flows~1api~1attachments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload an attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload a file (image, PDF, document) to attachment storage. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipart/form-data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Returns an attachment UUID that can be used in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachments: [{ \"uuid\": \"...\" }]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when sending LinkedIn messages or emails. Supported types include images (JPG, PNG, GIF), documents (PDF, DOCX), and other common formats."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_294"}},"schemaId":"schema_294","pointer":"/paths/~1flows~1api~1attachments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/flows/api/attachments","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_294"}},"responseCodes":["201"],"pointer":"/flows/api/attachments","href":"attachments/uploadattachment","openApiOperationId":"uploadAttachment","summary":"Upload an attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_294","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_294"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Attachment uploaded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/attachment"}},"schemaId":"components/schemas/attachment"}],"pointer":"/paths/~1flows~1api~1attachments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/attachment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/attachment"}}}],"examples":[]}]}]}]},"httpPath":"/flows/api/attachments"},{"label":"Get an attachment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/attachments/getattachment","routeSlug":"/openapi/attachments/getattachment","metadata":{"seo":{"title":"Get an attachment","description":"Get an attachment"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAttachment","name":"Get an attachment","isWebhook":false,"pointer":"/paths/~1flows~1api~1attachments~1{uuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1flows~1api~1attachments~1{uuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/flows/api/attachments/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/flows/api/attachments/{uuid}","href":"attachments/getattachment","openApiOperationId":"getAttachment","summary":"Get an attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Attachment details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/attachment"}},"schemaId":"components/schemas/attachment"},{"code":"404","description":"Attachment not found."}],"pointer":"/paths/~1flows~1api~1attachments~1{uuid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/attachment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/attachment"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/flows/api/attachments/{uuid}"},{"label":"Delete an attachment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/attachments/deleteattachment","routeSlug":"/openapi/attachments/deleteattachment","metadata":{"seo":{"title":"Delete an attachment","description":"Delete an attachment"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAttachment","name":"Delete an attachment","isWebhook":false,"pointer":"/paths/~1flows~1api~1attachments~1{uuid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1flows~1api~1attachments~1{uuid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/flows/api/attachments/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","404"],"pointer":"/flows/api/attachments/{uuid}","href":"attachments/deleteattachment","openApiOperationId":"deleteAttachment","summary":"Delete an attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Attachment deleted."},{"code":"404","description":"Attachment not found."}],"pointer":"/paths/~1flows~1api~1attachments~1{uuid}/delete/responses"}],"panels":[]}]},"httpPath":"/flows/api/attachments/{uuid}"}],"content":{"contentType":"group","meta":{"name":"Attachments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Attachments","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload files (images, PDFs, documents) to your team's attachment storage. Uploaded attachments can be referenced by UUID when sending LinkedIn messages or emails via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field in the request body."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/flows/api/attachments","summary":"List attachments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/attachments/listattachments","deprecated":false},{"title":"/flows/api/attachments","summary":"Upload an attachment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/attachments/uploadattachment","deprecated":false},{"title":"/flows/api/attachments/{uuid}","summary":"Get an attachment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/attachments/getattachment","deprecated":false},{"title":"/flows/api/attachments/{uuid}","summary":"Delete an attachment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/attachments/deleteattachment","deprecated":false}]}]}]}]}},{"type":"separator","label":"Browsers","content":null},{"type":"group","label":"LinkedIn Browsers","link":"/openapi/linkedin-browsers","routeSlug":"/openapi/linkedin-browsers","items":[{"label":"List LinkedIn browsers","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/linkedin-browsers/listlinkedinbrowsers","routeSlug":"/openapi/linkedin-browsers/listlinkedinbrowsers","metadata":{"seo":{"title":"List LinkedIn browsers","description":"List all LinkedIn browser profiles with pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listLinkedInBrowsers","name":"List LinkedIn browsers","isWebhook":false,"pointer":"/paths/~1browsers~1api~1linkedin-browsers~1list/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List LinkedIn browsers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all LinkedIn browser profiles with pagination."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_295"}},"schemaId":"schema_295","pointer":"/paths/~1browsers~1api~1linkedin-browsers~1list/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/browsers/api/linkedin-browsers/list","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_295"}},"responseCodes":["200"],"pointer":"/browsers/api/linkedin-browsers/list","href":"linkedin-browsers/listlinkedinbrowsers","openApiOperationId":"listLinkedInBrowsers","summary":"List LinkedIn browsers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_295","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_295"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of LinkedIn browsers.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_296"}},"schemaId":"schema_296"}],"pointer":"/paths/~1browsers~1api~1linkedin-browsers~1list/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_296","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_296"}}}],"examples":[]}]}]}]},"httpPath":"/browsers/api/linkedin-browsers/list"},{"label":"Get a LinkedIn browser","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/linkedin-browsers/getlinkedinbrowser","routeSlug":"/openapi/linkedin-browsers/getlinkedinbrowser","metadata":{"seo":{"title":"Get a LinkedIn browser","description":"Get a LinkedIn browser"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLinkedInBrowser","name":"Get a LinkedIn browser","isWebhook":false,"pointer":"/paths/~1browsers~1api~1linkedin-browsers~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a LinkedIn browser","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_156","description":"LinkedIn browser ID.","required":true}],"pointer":"/paths/~1browsers~1api~1linkedin-browsers~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/browsers/api/linkedin-browsers/{id}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_156"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/browsers/api/linkedin-browsers/{id}","href":"linkedin-browsers/getlinkedinbrowser","openApiOperationId":"getLinkedInBrowser","summary":"Get a LinkedIn browser"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"LinkedIn browser details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/linkedin-browser"}},"schemaId":"components/schemas/linkedin-browser"},{"code":"404","description":"LinkedIn browser not found."}],"pointer":"/paths/~1browsers~1api~1linkedin-browsers~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/linkedin-browser","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/linkedin-browser"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/browsers/api/linkedin-browsers/{id}"},{"label":"Update a LinkedIn browser","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/linkedin-browsers/updatelinkedinbrowser","routeSlug":"/openapi/linkedin-browsers/updatelinkedinbrowser","metadata":{"seo":{"title":"Update a LinkedIn browser","description":"Update a LinkedIn browser"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateLinkedInBrowser","name":"Update a LinkedIn browser","isWebhook":false,"pointer":"/paths/~1browsers~1api~1linkedin-browsers~1{id}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a LinkedIn browser","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_156","description":"LinkedIn browser ID.","required":true}],"pointer":"/paths/~1browsers~1api~1linkedin-browsers~1{id}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/browsers/api/linkedin-browsers/{id}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_156"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/browsers/api/linkedin-browsers/{id}","href":"linkedin-browsers/updatelinkedinbrowser","openApiOperationId":"updateLinkedInBrowser","summary":"Update a LinkedIn browser"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"LinkedIn browser updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/linkedin-browser"}},"schemaId":"components/schemas/linkedin-browser"}],"pointer":"/paths/~1browsers~1api~1linkedin-browsers~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/linkedin-browser","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/linkedin-browser"}}}],"examples":[]}]}]}]},"httpPath":"/browsers/api/linkedin-browsers/{id}"},{"label":"Delete a LinkedIn browser","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/linkedin-browsers/deletelinkedinbrowser","routeSlug":"/openapi/linkedin-browsers/deletelinkedinbrowser","metadata":{"seo":{"title":"Delete a LinkedIn browser","description":"Delete a LinkedIn browser"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteLinkedInBrowser","name":"Delete a LinkedIn browser","isWebhook":false,"pointer":"/paths/~1browsers~1api~1linkedin-browsers~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a LinkedIn browser","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_156","description":"LinkedIn browser ID.","required":true}],"pointer":"/paths/~1browsers~1api~1linkedin-browsers~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/browsers/api/linkedin-browsers/{id}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_156"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/browsers/api/linkedin-browsers/{id}","href":"linkedin-browsers/deletelinkedinbrowser","openApiOperationId":"deleteLinkedInBrowser","summary":"Delete a LinkedIn browser"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"LinkedIn browser deleted."}],"pointer":"/paths/~1browsers~1api~1linkedin-browsers~1{id}/delete/responses"}],"panels":[]}]},"httpPath":"/browsers/api/linkedin-browsers/{id}"},{"label":"Create a LinkedIn browser (seat)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/linkedin-browsers/createlinkedinbrowser","routeSlug":"/openapi/linkedin-browsers/createlinkedinbrowser","metadata":{"seo":{"title":"Create a LinkedIn browser (seat)","description":"Create a LinkedIn browser \"seat\" bound to a sender profile. This is step 2 of connecting a LinkedIn account without the user ever logging into Grinfi:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createLinkedInBrowser","name":"Create a LinkedIn browser (seat)","isWebhook":false,"pointer":"/paths/~1browsers~1api~1linkedin-browsers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a LinkedIn browser (seat)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a LinkedIn browser \"seat\" bound to a sender profile. This is step 2 of connecting a LinkedIn account without the user ever logging into Grinfi:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a sender profile — "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/createSenderProfile"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /flows/api/sender-profiles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a seat here ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sender_profile_uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). It starts in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status: stopped"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_account_uuid: null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate a Smart Login link —"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/generateBrowserAccessKey"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"generate-external-access-key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Give that link to the account owner; they log into LinkedIn in the hosted cloud"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"browser. The seat transitions to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"running"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" automatically."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Poll "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/listLinkedInBrowsers"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".../list"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_account_uuid"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is populated (= connected)."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do NOT call "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"run"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (start) on a freshly created, never-logged-in seat"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — it pushes the seat into "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"login_issue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The backend starts it automatically once login completes."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_297"}},"schemaId":"schema_297","pointer":"/paths/~1browsers~1api~1linkedin-browsers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/browsers/api/linkedin-browsers","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_297"}},"responseCodes":["201"],"pointer":"/browsers/api/linkedin-browsers","href":"linkedin-browsers/createlinkedinbrowser","openApiOperationId":"createLinkedInBrowser","summary":"Create a LinkedIn browser (seat)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_297","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_297"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"LinkedIn browser created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/linkedin-browser"}},"schemaId":"components/schemas/linkedin-browser"}],"pointer":"/paths/~1browsers~1api~1linkedin-browsers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/linkedin-browser","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/linkedin-browser"}}}],"examples":[]}]}]}]},"httpPath":"/browsers/api/linkedin-browsers"},{"label":"Generate a Smart Login link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/linkedin-browsers/generatebrowseraccesskey","routeSlug":"/openapi/linkedin-browsers/generatebrowseraccesskey","metadata":{"seo":{"title":"Generate a Smart Login link","description":"Mint a public, no-auth Smart Login link for a seat — the way an end user connects their LinkedIn account without a Grinfi login. Returns external_access_key and a cloud_browser_url; opening the URL provisions a hosted cloud browser where the user logs into LinkedIn. The link is valid 7 days and can be embedded in an iframe or forwarded to the account owner."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateBrowserAccessKey","name":"Generate a Smart Login link","isWebhook":false,"pointer":"/paths/~1browsers~1api~1linkedin-browsers~1{id}~1generate-external-access-key/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate a Smart Login link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mint a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"public, no-auth Smart Login link"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a seat — the way an end user connects their LinkedIn account without a Grinfi login. Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_access_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cloud_browser_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; opening the URL provisions a hosted cloud browser where the user logs into LinkedIn. The link is valid "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"7 days"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and can be embedded in an iframe or forwarded to the account owner."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cloud_browser_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" uses the platform host; to serve it under this API's domain, swap the host — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://leadgen.grinfi.io/cloud-browser/public/{external_access_key}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resolves to the same page. Each call "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"overwrites"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the previous key for that seat; the same link survives proxy changes and re-login attempts, so don't regenerate on every failure. Do not call "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/runLinkedInBrowser"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"run"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before or after — the seat starts automatically when login completes."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_156","description":"LinkedIn browser ID.","required":true}],"pointer":"/paths/~1browsers~1api~1linkedin-browsers~1{id}~1generate-external-access-key/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/browsers/api/linkedin-browsers/{id}/generate-external-access-key","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_156"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/browsers/api/linkedin-browsers/{id}/generate-external-access-key","href":"linkedin-browsers/generatebrowseraccesskey","openApiOperationId":"generateBrowserAccessKey","summary":"Generate a Smart Login link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Smart Login link.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_298"}},"schemaId":"schema_298"},{"code":"404","description":"Seat not found."}],"pointer":"/paths/~1browsers~1api~1linkedin-browsers~1{id}~1generate-external-access-key/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_298","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_298"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/browsers/api/linkedin-browsers/{id}/generate-external-access-key"},{"label":"Start a browser session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/linkedin-browsers/runlinkedinbrowser","routeSlug":"/openapi/linkedin-browsers/runlinkedinbrowser","metadata":{"seo":{"title":"Start a browser session","description":"Resume a previously logged-in LinkedIn browser session that was intentionally stopped. Do not call this during onboarding — starting a never-logged-in seat forces login_issue. The backend starts a seat automatically when Smart Login completes. Use this only to recover a seat the user manually stopped."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"runLinkedInBrowser","name":"Start a browser session","isWebhook":false,"pointer":"/paths/~1browsers~1api~1linkedin-browsers~1{id}~1run/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start a browser session","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resume a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"previously logged-in"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" LinkedIn browser session that was intentionally stopped. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not call this during onboarding"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — starting a never-logged-in seat forces "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"login_issue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The backend starts a seat automatically when Smart Login completes. Use this only to recover a seat the user manually stopped."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_156","description":"LinkedIn browser ID.","required":true}],"pointer":"/paths/~1browsers~1api~1linkedin-browsers~1{id}~1run/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/browsers/api/linkedin-browsers/{id}/run","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_156"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/browsers/api/linkedin-browsers/{id}/run","href":"linkedin-browsers/runlinkedinbrowser","openApiOperationId":"runLinkedInBrowser","summary":"Start a browser session"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Browser session started."}],"pointer":"/paths/~1browsers~1api~1linkedin-browsers~1{id}~1run/post/responses"}],"panels":[]}]},"httpPath":"/browsers/api/linkedin-browsers/{id}/run"},{"label":"Stop a browser session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/linkedin-browsers/stoplinkedinbrowser","routeSlug":"/openapi/linkedin-browsers/stoplinkedinbrowser","metadata":{"seo":{"title":"Stop a browser session","description":"Stop a browser session"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"stopLinkedInBrowser","name":"Stop a browser session","isWebhook":false,"pointer":"/paths/~1browsers~1api~1linkedin-browsers~1{id}~1stop/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stop a browser session","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_156","description":"LinkedIn browser ID.","required":true}],"pointer":"/paths/~1browsers~1api~1linkedin-browsers~1{id}~1stop/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/browsers/api/linkedin-browsers/{id}/stop","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_156"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/browsers/api/linkedin-browsers/{id}/stop","href":"linkedin-browsers/stoplinkedinbrowser","openApiOperationId":"stopLinkedInBrowser","summary":"Stop a browser session"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Browser session stopped."}],"pointer":"/paths/~1browsers~1api~1linkedin-browsers~1{id}~1stop/post/responses"}],"panels":[]}]},"httpPath":"/browsers/api/linkedin-browsers/{id}/stop"},{"label":"Set browser proxy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/linkedin-browsers/setlinkedinbrowserproxy","routeSlug":"/openapi/linkedin-browsers/setlinkedinbrowserproxy","metadata":{"seo":{"title":"Set browser proxy","description":"Change the proxy configuration for a LinkedIn browser."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"setLinkedInBrowserProxy","name":"Set browser proxy","isWebhook":false,"pointer":"/paths/~1browsers~1api~1linkedin-browsers~1{id}~1set-proxy/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set browser proxy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Change the proxy configuration for a LinkedIn browser."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_156","description":"LinkedIn browser ID.","required":true}],"pointer":"/paths/~1browsers~1api~1linkedin-browsers~1{id}~1set-proxy/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_299"}},"schemaId":"schema_299","pointer":"/paths/~1browsers~1api~1linkedin-browsers~1{id}~1set-proxy/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/browsers/api/linkedin-browsers/{id}/set-proxy","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_156"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_299"}},"responseCodes":["200"],"pointer":"/browsers/api/linkedin-browsers/{id}/set-proxy","href":"linkedin-browsers/setlinkedinbrowserproxy","openApiOperationId":"setLinkedInBrowserProxy","summary":"Set browser proxy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_299","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_299"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Proxy configuration updated."}],"pointer":"/paths/~1browsers~1api~1linkedin-browsers~1{id}~1set-proxy/post/responses"}],"panels":[]}]},"httpPath":"/browsers/api/linkedin-browsers/{id}/set-proxy"},{"label":"Share browser profile","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/linkedin-browsers/sharelinkedinbrowser","routeSlug":"/openapi/linkedin-browsers/sharelinkedinbrowser","metadata":{"seo":{"title":"Share browser profile","description":"Share a LinkedIn browser profile with another team member."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"shareLinkedInBrowser","name":"Share browser profile","isWebhook":false,"pointer":"/paths/~1browsers~1api~1linkedin-browsers~1{id}~1share/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Share browser profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Share a LinkedIn browser profile with another team member."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_156","description":"LinkedIn browser ID.","required":true}],"pointer":"/paths/~1browsers~1api~1linkedin-browsers~1{id}~1share/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_300"}},"schemaId":"schema_300","pointer":"/paths/~1browsers~1api~1linkedin-browsers~1{id}~1share/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/browsers/api/linkedin-browsers/{id}/share","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_156"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_300"}},"responseCodes":["200"],"pointer":"/browsers/api/linkedin-browsers/{id}/share","href":"linkedin-browsers/sharelinkedinbrowser","openApiOperationId":"shareLinkedInBrowser","summary":"Share browser profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_300","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_300"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Browser profile shared."}],"pointer":"/paths/~1browsers~1api~1linkedin-browsers~1{id}~1share/post/responses"}],"panels":[]}]},"httpPath":"/browsers/api/linkedin-browsers/{id}/share"}],"content":{"contentType":"group","meta":{"name":"LinkedIn Browsers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"LinkedIn Browsers","showPageActions":true},{"nodeType":"markdoc","content":"Manage LinkedIn browser profiles used for automation. Browsers run in the cloud and execute LinkedIn actions on behalf of sender profiles."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/browsers/api/linkedin-browsers/list","summary":"List LinkedIn browsers","prefix":{"name":"post","color":"post"},"badges":[],"link":"/linkedin-browsers/listlinkedinbrowsers","deprecated":false},{"title":"/browsers/api/linkedin-browsers/{id}","summary":"Get a LinkedIn browser","prefix":{"name":"get","color":"get"},"badges":[],"link":"/linkedin-browsers/getlinkedinbrowser","deprecated":false},{"title":"/browsers/api/linkedin-browsers/{id}","summary":"Update a LinkedIn browser","prefix":{"name":"put","color":"put"},"badges":[],"link":"/linkedin-browsers/updatelinkedinbrowser","deprecated":false},{"title":"/browsers/api/linkedin-browsers/{id}","summary":"Delete a LinkedIn browser","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/linkedin-browsers/deletelinkedinbrowser","deprecated":false},{"title":"/browsers/api/linkedin-browsers","summary":"Create a LinkedIn browser (seat)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/linkedin-browsers/createlinkedinbrowser","deprecated":false},{"title":"/browsers/api/linkedin-browsers/{id}/generate-external-access-key","summary":"Generate a Smart Login link","prefix":{"name":"post","color":"post"},"badges":[],"link":"/linkedin-browsers/generatebrowseraccesskey","deprecated":false},{"title":"/browsers/api/linkedin-browsers/{id}/run","summary":"Start a browser session","prefix":{"name":"post","color":"post"},"badges":[],"link":"/linkedin-browsers/runlinkedinbrowser","deprecated":false},{"title":"/browsers/api/linkedin-browsers/{id}/stop","summary":"Stop a browser session","prefix":{"name":"post","color":"post"},"badges":[],"link":"/linkedin-browsers/stoplinkedinbrowser","deprecated":false},{"title":"/browsers/api/linkedin-browsers/{id}/set-proxy","summary":"Set browser proxy","prefix":{"name":"post","color":"post"},"badges":[],"link":"/linkedin-browsers/setlinkedinbrowserproxy","deprecated":false},{"title":"/browsers/api/linkedin-browsers/{id}/share","summary":"Share browser profile","prefix":{"name":"post","color":"post"},"badges":[],"link":"/linkedin-browsers/sharelinkedinbrowser","deprecated":false}]}]}]}]}},{"type":"separator","label":"Integrations","content":null},{"type":"group","label":"Webhooks","link":"/openapi/webhooks","routeSlug":"/openapi/webhooks","items":[{"label":"List webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooks/listwebhooks","routeSlug":"/openapi/webhooks/listwebhooks","metadata":{"seo":{"title":"List webhooks","description":"List all webhooks configured in your account. Webhooks send HTTP requests to your target URL when specified events occur."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listWebhooks","name":"List webhooks","isWebhook":false,"pointer":"/paths/~1integrations~1api~1webhooks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List webhooks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all webhooks configured in your account. Webhooks send HTTP requests to your target URL when specified events occur.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integrations/api/webhooks","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/integrations/api/webhooks","href":"webhooks/listwebhooks","openApiOperationId":"listWebhooks","summary":"List webhooks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of webhooks.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_301"}},"schemaId":"schema_301"}],"pointer":"/paths/~1integrations~1api~1webhooks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_301","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_301"}}}],"examples":[]}]}]}]},"httpPath":"/integrations/api/webhooks"},{"label":"Create a webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooks/createwebhook","routeSlug":"/openapi/webhooks/createwebhook","metadata":{"seo":{"title":"Create a webhook","description":"Create a new webhook that fires on the specified event. Optionally add filters to narrow which contacts trigger the webhook."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createWebhook","name":"Create a webhook","isWebhook":false,"pointer":"/paths/~1integrations~1api~1webhooks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new webhook that fires on the specified event. Optionally add filters to narrow which contacts trigger the webhook.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_302","exampleIds":["paths/~1integrations~1api~1webhooks/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_302","exampleIds":["paths/~1integrations~1api~1webhooks/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1integrations~1api~1webhooks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/integrations/api/webhooks","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_302","exampleIds":["paths/~1integrations~1api~1webhooks/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","422"],"pointer":"/integrations/api/webhooks","href":"webhooks/createwebhook","openApiOperationId":"createWebhook","summary":"Create a webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_302","exampleIds":["paths/~1integrations~1api~1webhooks/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_302","exampleIds":["paths/~1integrations~1api~1webhooks/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Webhook created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhook"}},"schemaId":"components/schemas/webhook"},{"code":"422","description":"Validation error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"}],"pointer":"/paths/~1integrations~1api~1webhooks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/webhook","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhook"}}},{"code":"422","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Callbacks","labelTranslationKey":"callbacks","deepLinkSuffix":"callbacks"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"{$request.body#/target_url}","summary":"Event delivery to your target_url","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the subscribed event fires, Grinfi sends this payload to your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"callbackName":"event","callbackId":"event/post","contentChildren":[{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/webhook-payload"}},"schemaId":"components/schemas/webhook-payload","pointer":"/paths/~1integrations~1api~1webhooks/post/callbacks/event/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2XX","description":"Return any 2xx to acknowledge receipt."}],"pointer":"/paths/~1integrations~1api~1webhooks/post/callbacks/event/post/responses"}]},"pointer":"/paths/~1integrations~1api~1webhooks/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"event/post","path":"{$request.body#/target_url}","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_303"}},"examples":[]}]}]}]},"httpPath":"/integrations/api/webhooks"},{"label":"Get a webhook","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooks/getwebhook","routeSlug":"/openapi/webhooks/getwebhook","metadata":{"seo":{"title":"Get a webhook","description":"Retrieve full details of a webhook by UUID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebhook","name":"Get a webhook","isWebhook":false,"pointer":"/paths/~1integrations~1api~1webhooks~1{uuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve full details of a webhook by UUID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1integrations~1api~1webhooks~1{uuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integrations/api/webhooks/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/integrations/api/webhooks/{uuid}","href":"webhooks/getwebhook","openApiOperationId":"getWebhook","summary":"Get a webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook details.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhook"}},"schemaId":"components/schemas/webhook"},{"code":"404","description":"Webhook not found."}],"pointer":"/paths/~1integrations~1api~1webhooks~1{uuid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/webhook","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhook"}}},{"code":"404"}],"examples":[]}]}]}]},"httpPath":"/integrations/api/webhooks/{uuid}"},{"label":"Update a webhook","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooks/updatewebhook","routeSlug":"/openapi/webhooks/updatewebhook","metadata":{"seo":{"title":"Update a webhook","description":"Update one or more fields on an existing webhook. Only include the fields you want to change."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWebhook","name":"Update a webhook","isWebhook":false,"pointer":"/paths/~1integrations~1api~1webhooks~1{uuid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update one or more fields on an existing webhook. Only include the fields you want to change.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1integrations~1api~1webhooks~1{uuid}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_304"}},"schemaId":"schema_304","pointer":"/paths/~1integrations~1api~1webhooks~1{uuid}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/integrations/api/webhooks/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_304"}},"responseCodes":["200","404","422"],"pointer":"/integrations/api/webhooks/{uuid}","href":"webhooks/updatewebhook","openApiOperationId":"updateWebhook","summary":"Update a webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_304","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_304"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Webhook updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhook"}},"schemaId":"components/schemas/webhook"},{"code":"404","description":"Webhook not found."},{"code":"422","description":"Validation error."}],"pointer":"/paths/~1integrations~1api~1webhooks~1{uuid}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/webhook","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhook"}}},{"code":"404"},{"code":"422"}],"examples":[]}]}]}]},"httpPath":"/integrations/api/webhooks/{uuid}"},{"label":"Delete a webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooks/deletewebhook","routeSlug":"/openapi/webhooks/deletewebhook","metadata":{"seo":{"title":"Delete a webhook","description":"Permanently remove a webhook."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteWebhook","name":"Delete a webhook","isWebhook":false,"pointer":"/paths/~1integrations~1api~1webhooks~1{uuid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Permanently remove a webhook."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uuid","in":"path","schemaId":"schema_164","description":"Resource UUID.","required":true}],"pointer":"/paths/~1integrations~1api~1webhooks~1{uuid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/integrations/api/webhooks/{uuid}","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[{"name":"uuid","in":"path","required":true,"schemaId":"schema_164"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["204","404"],"pointer":"/integrations/api/webhooks/{uuid}","href":"webhooks/deletewebhook","openApiOperationId":"deleteWebhook","summary":"Delete a webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Webhook deleted."},{"code":"404","description":"Webhook not found."}],"pointer":"/paths/~1integrations~1api~1webhooks~1{uuid}/delete/responses"}],"panels":[]}]},"httpPath":"/integrations/api/webhooks/{uuid}"},{"label":"Test a webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/webhooks/testwebhook","routeSlug":"/openapi/webhooks/testwebhook","metadata":{"seo":{"title":"Test a webhook","description":"Send a sample payload for the given event to a target URL and return the target's response — use it to verify connectivity and see the payload shape for an event."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"testWebhook","name":"Test a webhook","isWebhook":false,"pointer":"/paths/~1integrations~1api~1webhooks~1test/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Test a webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send a sample payload for the given event to a target URL and return the target's response — use it to verify connectivity and see the payload shape for an event."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send the full webhook config"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", not just the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"request_method"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are all required (sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" alone returns a 422). The sample payload uses placeholder data and matches the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#schema/webhook-payload"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webhook-payload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schema."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_305","exampleIds":["paths/~1integrations~1api~1webhooks~1test/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_305","exampleIds":["paths/~1integrations~1api~1webhooks~1test/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1integrations~1api~1webhooks~1test/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/integrations/api/webhooks/test","servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_305","exampleIds":["paths/~1integrations~1api~1webhooks~1test/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","404"],"pointer":"/integrations/api/webhooks/test","href":"webhooks/testwebhook","openApiOperationId":"testWebhook","summary":"Test a webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}],"schemaId":"schema_305","exampleIds":["paths/~1integrations~1api~1webhooks~1test/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_305","exampleIds":["paths/~1integrations~1api~1webhooks~1test/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Test payload sent. Returns the target response."},{"code":"404","description":"Webhook not found."}],"pointer":"/paths/~1integrations~1api~1webhooks~1test/post/responses"}],"panels":[]}]},"httpPath":"/integrations/api/webhooks/test"}],"content":{"contentType":"group","meta":{"name":"Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhooks","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configure real-time HTTP callbacks for events in your account. Webhooks send a POST (or custom method) request to your target URL whenever a specified event occurs — such as a contact replying, being enriched, or exported."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/integrations/api/webhooks","summary":"List webhooks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/listwebhooks","deprecated":false},{"title":"/integrations/api/webhooks","summary":"Create a webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/createwebhook","deprecated":false},{"title":"/integrations/api/webhooks/{uuid}","summary":"Get a webhook","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/getwebhook","deprecated":false},{"title":"/integrations/api/webhooks/{uuid}","summary":"Update a webhook","prefix":{"name":"put","color":"put"},"badges":[],"link":"/webhooks/updatewebhook","deprecated":false},{"title":"/integrations/api/webhooks/{uuid}","summary":"Delete a webhook","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/webhooks/deletewebhook","deprecated":false},{"title":"/integrations/api/webhooks/test","summary":"Test a webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/testwebhook","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/error":{"id":"components/schemas/error","kind":"json-schema","title":"error","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response envelope. Validation errors include field-level details in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error.data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"error":{"type":"object","properties":{"reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine-readable error code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"validation_error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bad_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth_exception"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_denied"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"validation_error"},"message":{"type":"string","example":"The name field is required."},"data":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field-level validation errors (field name → messages)."},"children":[]}]}]}]}}},"message":{"type":"string","example":"The given data was invalid."},"code":{"type":"integer","example":422}}}},"components/schemas/lead":{"id":"components/schemas/lead","kind":"json-schema","title":"lead","data":{"type":"object","description":"A contact (lead) in your CRM.","properties":{"uuid":{"type":"string","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"team_id":{"type":"integer"},"user_id":{"type":"integer","nullable":true},"sender_profile_uuid":{"type":"string","nullable":true},"list_uuid":{"type":"string"},"data_source_uuid":{"type":"string","nullable":true},"pipeline_stage_uuid":{"type":"string"},"company_uuid":{"type":"string","nullable":true},"name":{"type":"string","nullable":true,"example":"John Doe"},"first_name":{"type":"string","nullable":true,"example":"John"},"last_name":{"type":"string","nullable":true,"example":"Doe"},"company_name":{"type":"string","nullable":true,"example":"Acme Inc"},"company_ln_id":{"type":"string","nullable":true},"position":{"type":"string","nullable":true,"example":"VP of Sales"},"headline":{"type":"string","nullable":true,"example":"VP of Sales at Acme Inc"},"about":{"type":"string","nullable":true},"avatar_url":{"type":"string","nullable":true},"ln_id":{"type":"string","nullable":true,"description":"LinkedIn member ID."},"sn_id":{"type":"string","nullable":true,"description":"Sales Navigator ID."},"linkedin":{"type":"string","nullable":true,"example":"john-doe-123456"},"facebook":{"type":"string","nullable":true},"twitter":{"type":"string","nullable":true},"work_email":{"type":"string","nullable":true,"example":"john@acme.com"},"personal_email":{"type":"string","nullable":true},"work_phone_number":{"type":"string","nullable":true},"personal_phone_number":{"type":"string","nullable":true},"connections_number":{"type":"integer","nullable":true},"followers_number":{"type":"integer","nullable":true},"primary_language":{"type":"string","nullable":true},"supported_languages":{"type":"array","nullable":true,"items":{"type":"string"}},"has_open_profile":{"type":"integer","nullable":true},"has_verified_profile":{"type":"integer","nullable":true},"has_premium":{"type":"integer","nullable":true},"experience":{"type":"array","nullable":true,"items":{"type":"object","properties":{"title":{"type":"string"},"company":{"type":"string"},"start_date":{"type":"string"},"end_date":{"type":"string"}}}},"posts":{"type":"array","nullable":true,"items":{"type":"object","properties":{"content":{"type":"string"},"date":{"type":"string","format":"date-time"}}}},"educations":{"type":"array","nullable":true,"items":{"type":"object","properties":{"school":{"type":"string"},"degree":{"type":"string"},"field_of_study":{"type":"string"},"start_year":{"type":"string"},"end_year":{"type":"string"}}}},"skills":{"type":"array","nullable":true,"items":{"type":"string"}},"raw_address":{"type":"string","nullable":true,"example":"San Francisco, CA, USA"},"location":{"type":"array","nullable":true,"items":{"type":"object","properties":{"address_string":{"type":"string"}}}},"tags":{"type":"array","nullable":true,"items":{"type":"string"},"description":"Tag UUIDs."},"status":{"type":"string","example":"ok"},"linkedin_status":{"type":"string","example":"active"},"email_status":{"type":"string","nullable":true},"unread_counts":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"count":{"type":"integer"}}}},"last_automation_approve_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true},"updated_at":{"type":"string","format":"date-time","nullable":true}}}},"components/schemas/create-lead-fields":{"id":"components/schemas/create-lead-fields","kind":"json-schema","title":"create-lead-fields","data":{"type":"object","properties":{"linkedin_id":{"type":"string","description":"LinkedIn profile URL or member ID.","example":"john-doe-123456"},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Doe"},"company_name":{"type":"string","example":"Acme Inc"},"ln_id":{"type":"string","nullable":true},"sn_id":{"type":"string","nullable":true},"linkedin":{"type":"string","nullable":true},"email":{"type":"string","format":"email","example":"john@acme.com"},"about":{"type":"string"},"domain":{"type":"string","description":"Company domain for email discovery.","example":"acme.com"},"headline":{"type":"string","nullable":true},"position":{"type":"string","nullable":true},"raw_address":{"type":"string","nullable":true}}}},"components/schemas/company":{"id":"components/schemas/company","kind":"json-schema","title":"company","data":{"type":"object","description":"A company record in your CRM.","properties":{"uuid":{"type":"string","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"team_id":{"type":"integer"},"user_id":{"type":"integer","nullable":true},"data_source_uuid":{"type":"string","nullable":true},"lead_status_uuid":{"type":"string","nullable":true,"description":"Pipeline stage UUID."},"name":{"type":"string","example":"Acme Inc"},"domain":{"type":"string","nullable":true,"example":"acme.com"},"website":{"type":"string","nullable":true,"example":"https://acme.com"},"ln_id":{"type":"integer","nullable":true,"description":"LinkedIn company numeric ID."},"linkedin":{"type":"string","nullable":true,"example":"acme-inc"},"facebook":{"type":"string","nullable":true},"twitter":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"hq_raw_address":{"type":"string","nullable":true,"example":"San Francisco, CA, USA"},"hq_location":{"type":"array","nullable":true,"items":{"type":"object"}},"logo_url":{"type":"string","nullable":true},"industry":{"type":"string","nullable":true,"example":"Technology"},"employees_range":{"type":"string","nullable":true,"example":"51-200"},"year_established":{"type":"integer","nullable":true,"example":2015},"about":{"type":"string","nullable":true},"lists":{"type":"array","nullable":true,"items":{"type":"string"},"description":"List UUIDs."},"tags":{"type":"array","nullable":true,"items":{"type":"string"},"description":"Tag UUIDs."},"status":{"type":"string"},"last_enrich_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time","nullable":true},"updated_at":{"type":"string","format":"date-time","nullable":true}}}},"components/schemas/tag":{"id":"components/schemas/tag","kind":"json-schema","title":"tag","data":{"type":"object","properties":{"uuid":{"type":"string","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"team_id":{"type":"integer"},"name":{"type":"string","example":"Hot Lead"},"color":{"type":"string","nullable":true,"example":"#ff5733"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/pipeline-stage":{"id":"components/schemas/pipeline-stage","kind":"json-schema","title":"pipeline-stage","data":{"type":"object","properties":{"uuid":{"type":"string","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"team_id":{"type":"integer"},"name":{"type":"string","example":"Demo Booked"},"object":{"type":"string","enum":["lead","company"]},"type":{"type":"string","enum":["custom","new","approaching","engaging","replied"]},"category":{"type":"string","enum":["cold","engaging","positive","negative"]},"order":{"type":"integer"}}}},"components/schemas/custom-field":{"id":"components/schemas/custom-field","kind":"json-schema","title":"custom-field","data":{"type":"object","properties":{"uuid":{"type":"string"},"team_id":{"type":"integer"},"user_id":{"type":"integer"},"name":{"type":"string","example":"Industry Vertical"},"object":{"type":"string","enum":["lead","company"]},"order":{"type":"integer"}}}},"components/schemas/custom-field-value":{"id":"components/schemas/custom-field-value","kind":"json-schema","title":"custom-field-value","data":{"type":"object","properties":{"uuid":{"type":"string"},"team_id":{"type":"integer"},"custom_field_uuid":{"type":"string"},"object_type":{"type":"string","enum":["lead","company"]},"object_uuid":{"type":"string"},"value":{"type":"string","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/note":{"id":"components/schemas/note","kind":"json-schema","title":"note","data":{"type":"object","properties":{"uuid":{"type":"string"},"team_id":{"type":"integer"},"user_id":{"type":"integer"},"object":{"type":"string","enum":["lead","company"]},"object_uuid":{"type":"string"},"note":{"type":"string","example":"Follow up after demo next week."},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/list":{"id":"components/schemas/list","kind":"json-schema","title":"list","data":{"type":"object","properties":{"uuid":{"type":"string","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"team_id":{"type":"integer"},"name":{"type":"string","example":"CMO Germany"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/flow":{"id":"components/schemas/flow","kind":"json-schema","title":"flow","data":{"type":"object","properties":{"uuid":{"type":"string","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"public_uuid":{"type":"string","nullable":true},"team_id":{"type":"integer"},"name":{"type":"string","example":"DACH CTO Outreach"},"flow_workspace_uuid":{"type":"string","nullable":true},"flow_version_uuid":{"type":"string"},"use_sender_schedule":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", tasks use each sender profile's own schedule instead of the flow schedule."},"children":[]}]}]}]},"schedule":{"$ref":"#/components/schemas/schedule"},"description":{"type":"string","nullable":true},"priority":{"type":"integer"},"status":{"type":"string","description":"Flow status.","enum":["on","off","draft","archived"],"example":"on"},"is_public":{"type":"boolean"},"user_id":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/node-edge":{"id":"components/schemas/node-edge","kind":"json-schema","title":"node-edge","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A directed edge between two nodes in the flow tree. Appears in a node's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (incoming) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (outgoing) arrays."},"children":[]}]}]}],"required":["node_id","branch_id"],"properties":{"node_id":{"type":"integer","description":"ID of the node on the other end of this edge.","example":5},"branch_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Which branch this edge belongs to. For linear steps use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For branching nodes: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rule_ab_test"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (A/B); "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rule_filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the \"match\" branch and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the \"else\" branch; triggers use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":1}}}},"components/schemas/flow-node":{"id":"components/schemas/flow-node","kind":"json-schema","title":"flow-node","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single step in an automation's node tree. Nodes are linked into a graph by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" edge arrays rather than by array order. Every branch must terminate in an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" node (a flow can have more than one)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"automation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always the string "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"auto\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; the step's real configuration lives in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", whose shape depends on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Nodes with no configuration ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_visit_profile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_like_latest_post"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") use an empty array "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as their payload."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Node types and their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"| "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | Category | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" shape | | --- | --- | --- | | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trigger_message_replied"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | trigger (entry) | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ subtasks: [util_timer node], check_period_type: \"last_response\" }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trigger_linkedin_connection_request_accepted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | trigger (entry) | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ subtasks: [util_timer node] }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_send_connection_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | action | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ template, fallback_send: bool, template_uuid }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_send_message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | action | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ template, attachments: [], template_uuid, stop_on_reply_level: \"always\" }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_send_inmail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | action | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ subject, template, attachments: [], template_uuid, stop_on_reply_level }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_visit_profile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | action | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_like_latest_post"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | action | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_endorse_skills"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | action | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ number: int }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_withdraw_connection_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | action | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ note, withdraw_key }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email_send_message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | action | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ subject, template, add_history: 0\\|1, attachments: [], email_field: \"work_email\", template_uuid, stop_on_reply_level }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gs_add_tag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | action | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ tag_uuid }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gs_rotate_sender_profile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | action | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ rotations: [{ contact_source_id }] }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rule_ab_test"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | branch | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ branches: [{ value: 50, branch_id: 1, is_enabled: true }, { value: 50, branch_id: 2, is_enabled: true }] }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rule_filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | branch | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ branches: [{ filters: { json_logic, filter_tree_format, mass_actions_filter }, branch_id: 1 }, { branch_id: 0 }] }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"util_timer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | delay | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ wait_time: seconds }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" | terminal | "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" |"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/validateFlowNode"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /flows/api/flow-versions/validate-node"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to check a single node before saving the whole tree."},"children":[]}]}]}],"required":["id","type","before","after"],"properties":{"id":{"type":"integer","description":"Node ID, unique within the flow version. Must be an integer.","example":3},"type":{"type":"string","description":"Node type. See the table above for allowed values.","example":"linkedin_send_connection_request"},"before":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Incoming edges (empty for entry nodes). Required, may be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/node-edge"}},"after":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outgoing edges (empty for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" node). Required, may be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/node-edge"}},"automation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always the literal string "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"auto\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"auto"},"payload":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Node configuration. Object whose shape depends on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (see table), or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for nodes with no configuration."},"children":[]}]}]}],"oneOf":[{"type":"object"},{"type":"array"}],"example":{"template":"Hi {{first_name}}, happy to connect!","fallback_send":true,"template_uuid":null}},"delay_in_seconds":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delay before this node runs, relative to the previous step (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"7200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = 2h, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"86400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = 1 day). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = run immediately."},"children":[]}]}]}],"example":0},"created_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when saving a node via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createFlowVersion"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (an ISO-8601 timestamp; use the current time for new nodes). Not required by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"validate-node"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2026-07-05T10:00:00.000000Z"},"updated_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required alongside "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when saving via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createFlowVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2026-07-05T10:00:00.000000Z"}}}},"components/schemas/contact-source":{"id":"components/schemas/contact-source","kind":"json-schema","title":"contact-source","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines who enters the flow and which sender profiles run the outreach. Attached to a flow version's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_sources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]}],"properties":{"id":{"type":"integer","description":"Contact source ID, unique within the flow version.","example":1},"name":{"type":"string","nullable":true},"rotation_strategy":{"type":"string","description":"How senders are rotated across contacts.","enum":["fair"],"example":"fair"},"sender_profiles":{"type":"array","description":"UUIDs of the sender profiles that execute this source's steps.","items":{"type":"string","format":"uuid"}},"after_id":{"type":"integer","nullable":true,"description":"ID of the first node contacts from this source enter.","example":3},"active_limit":{"type":"integer","nullable":true},"coworkers_limit":{"type":"integer","nullable":true},"mass_actions_filter":{"type":"object","nullable":true,"description":"Saved-filter definition selecting the contacts (same shape as CRM mass actions)."},"filter_tree_format":{"type":"object","nullable":true}}}},"components/schemas/schedule":{"id":"components/schemas/schedule","kind":"json-schema","title":"schedule","data":{"type":"object","description":"Working hours schedule.","properties":{"timezone":{"type":"string","example":"Europe/Berlin"},"use_lead_timezone":{"type":"boolean","default":false},"timeblocks":{"type":"array","items":{"type":"object","properties":{"dow":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Day of week (0=Sunday)."},"children":[]}]}]}]},"min":{"type":"integer","description":"Start time in minutes from midnight.","example":540},"max":{"type":"integer","description":"End time in minutes from midnight.","example":1080}}}}},"required":["timezone","timeblocks"]}},"components/schemas/task":{"id":"components/schemas/task","kind":"json-schema","title":"task","data":{"type":"object","properties":{"uuid":{"type":"string"},"parent_task_pipeline_uuid":{"type":"string","nullable":true,"description":"UUID of the parent task (for chained tasks)."},"team_id":{"type":"integer"},"assigned_to":{"type":"integer","description":"User ID the task is assigned to."},"user_id":{"type":"integer"},"lead_uuid":{"type":"string"},"company_uuid":{"type":"string","nullable":true},"sender_profile_uuid":{"type":"string"},"mailbox_uuid":{"type":"string","nullable":true},"flow_uuid":{"type":"string","nullable":true},"flow_lead_uuid":{"type":"string","nullable":true,"description":"UUID of the flow-lead record linking this contact to the automation."},"flow_origin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"automation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when created by a flow."},"children":[]}]}]}],"example":"automation"},"flow_node_id":{"type":"integer","nullable":true,"description":"Node index within the automation that generated this task."},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Task type. Known values: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_send_message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_send_connection_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email_send_message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"linkedin_send_message"},"automation":{"type":"string","enum":["manual","auto"]},"automation_error_code":{"type":"string","nullable":true},"status":{"type":"string","enum":["in_progress","closed","canceled","failed","skipped"]},"fork_result":{"type":"integer","nullable":true},"payload":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Task-specific data. For message tasks includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"template"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rendered_text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"stop_on_reply_level"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_message_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"template":{"type":"string","nullable":true,"description":"Message template with variables."},"rendered_text":{"type":"string","nullable":true,"description":"Final message text after variable substitution."},"attachments":{"type":"array","nullable":true,"items":{"type":"object"}},"stop_on_reply_level":{"type":"string","nullable":true,"description":"When to stop the sequence on reply.","example":"always"},"last_message_at":{"type":"string","format":"date-time","nullable":true}}},"attempts":{"type":"integer","description":"Number of execution attempts."},"error_msg":{"type":"string","nullable":true,"description":"Error or skip reason."},"priority":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Task priority (lower = higher priority)."},"children":[]}]}]}]},"number_in_line":{"type":"integer","nullable":true},"note":{"type":"string","nullable":true},"timezone":{"type":"string","nullable":true},"schedule_at":{"type":"string","format":"date-time"},"executed_at":{"type":"string","format":"date-time","nullable":true},"taken_to_execute_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/sender-profile":{"id":"components/schemas/sender-profile","kind":"json-schema","title":"sender-profile","data":{"type":"object","properties":{"uuid":{"type":"string","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"team_id":{"type":"integer"},"linkedin_browser_id":{"type":"integer","nullable":true,"description":"ID of the linked LinkedIn browser."},"linkedin_account_uuid":{"type":"string","nullable":true},"mailbox_uuid":{"type":"string","nullable":true},"assignee_user_id":{"type":"integer","nullable":true},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Doe"},"label":{"type":"string","nullable":true,"example":"Sales Team - US"},"avatar_url":{"type":"string","nullable":true,"description":"Profile photo URL."},"schedule":{"$ref":"#/components/schemas/schedule"},"smart_limits_enabled":{"type":"boolean","description":"Whether smart sending limits are active."},"status":{"type":"string","description":"Sender profile status.","enum":["enabled","disabled"],"example":"enabled"},"hold_tasks_till":{"type":"string","format":"date-time","nullable":true,"description":"Tasks are held until this time (set automatically during execution)."},"last_automation_server_id":{"type":"integer","nullable":true},"notification_emails":{"type":"string","nullable":true},"user_id":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/attachment":{"id":"components/schemas/attachment","kind":"json-schema","title":"attachment","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A file uploaded to your team's attachment storage. Reference by UUID in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array when sending LinkedIn messages or emails."},"children":[]}]}]}],"properties":{"uuid":{"type":"string","description":"Attachment UUID."},"team_id":{"type":"integer"},"user_id":{"type":"integer"},"payload":{"type":"object","properties":{"name":{"type":"string","description":"Original filename.","example":"photo.png"},"path":{"type":"string","description":"Internal storage path.","example":"attachments/134/1ab98d82-cc1a-451b-918e-5b9c026a9d85.png"},"size":{"type":"string","description":"File size in bytes (as string).","example":"324274"},"type":{"type":"string","description":"MIME type.","example":"image/png"}}},"body":{"type":"string","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/attachment-ref":{"id":"components/schemas/attachment-ref","kind":"json-schema","title":"attachment-ref","data":{"type":"object","description":"Reference to an uploaded attachment by UUID.","required":["uuid"],"properties":{"uuid":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUID returned from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /flows/api/attachments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"e94a3b39-1242-4d70-8703-8b600d8960d6"}}}},"components/schemas/linkedin-message":{"id":"components/schemas/linkedin-message","kind":"json-schema","title":"linkedin-message","data":{"type":"object","properties":{"uuid":{"type":"string"},"team_id":{"type":"integer"},"sender_profile_uuid":{"type":"string"},"linkedin_account_uuid":{"type":"string"},"linkedin_conversation_uuid":{"type":"string"},"lead_uuid":{"type":"string"},"task_pipeline_uuid":{"type":"string","nullable":true},"template_uuid":{"type":"string","nullable":true},"message_hash":{"type":"string","nullable":true},"subject":{"type":"string","nullable":true},"text":{"type":"string","example":"Hi John, thanks for connecting!"},"custom_content":{"type":"array","nullable":true},"attachments":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/attachment-ref"}},"type":{"type":"string","description":"Message direction.","enum":["inbox","outbox"],"example":"outbox"},"automation":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Message origin: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auto"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (sent by automation), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manual"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (sent by user), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"synced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (incoming message synced from LinkedIn)."},"children":[]}]}]}],"enum":["auto","manual","synced"]},"linkedin_type":{"type":"string","description":"LinkedIn message type.","enum":["connection_note","message","InMail"],"example":"message"},"status":{"type":"string","enum":["new","in_progress","done","failed"],"example":"done"},"fail_reason":{"type":"string","nullable":true},"read_at":{"type":"string","format":"date-time","nullable":true},"sent_at":{"type":"string","format":"date-time","nullable":true},"user_id":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/email":{"id":"components/schemas/email","kind":"json-schema","title":"email","data":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"team_id":{"type":"integer"},"user_id":{"type":"integer"},"sender_profile_uuid":{"type":"string","format":"uuid"},"mailbox_uuid":{"type":"string","format":"uuid"},"email_body_uuid":{"type":"string","format":"uuid"},"flow_uuid":{"type":"string","format":"uuid","nullable":true},"lead_uuid":{"type":"string","format":"uuid"},"status":{"type":"string"},"type":{"type":"string","description":"Message direction.","enum":["inbox","outbox"]},"from_name":{"type":"string"},"from_email":{"type":"string"},"to_name":{"type":"string"},"to_email":{"type":"string"},"cc":{"type":"array","items":{"type":"string"}},"bcc":{"type":"array","items":{"type":"string"}},"subject":{"type":"string"},"replied_to_uuid":{"type":"string","format":"uuid","nullable":true},"bounced_by_uuid":{"type":"string","format":"uuid","nullable":true},"sent_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/email-body":{"id":"components/schemas/email-body","kind":"json-schema","title":"email-body","data":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"team_id":{"type":"integer"},"body":{"type":"string"},"attachments":{"type":"array","items":{"type":"object"}},"subject":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/mailbox":{"id":"components/schemas/mailbox","kind":"json-schema","title":"mailbox","data":{"type":"object","properties":{"uuid":{"type":"string"},"team_id":{"type":"integer"},"user_id":{"type":"integer"},"sender_profile_uuid":{"type":"string"},"email":{"type":"string","example":"outreach@company.com"},"sender_name":{"type":"string","example":"John from Company"},"provider":{"type":"string"},"status":{"type":"string"},"automation_daily_limit":{"type":"integer","example":50},"automation_task_interval":{"type":"integer","example":120},"custom_tracking_domain_uuid":{"type":"string","nullable":true},"connection_settings":{"type":"object"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/activity":{"id":"components/schemas/activity","kind":"json-schema","title":"activity","data":{"type":"object","description":"An activity record tracking an event on a contact or company.","properties":{"uuid":{"type":"string"},"team_id":{"type":"integer"},"object_type":{"type":"string","enum":["lead","company"]},"object_uuid":{"type":"string"},"type":{"type":"string","example":"linkedin_message_sent"},"payload":{"type":"object","additionalProperties":true},"created_at":{"type":"string","format":"date-time"}}}},"components/schemas/mailbox-error":{"id":"components/schemas/mailbox-error","kind":"json-schema","title":"mailbox-error","data":{"type":"object","description":"A mailbox send/sync error record.","properties":{"uuid":{"type":"string"},"team_id":{"type":"integer"},"mailbox_uuid":{"type":"string"},"error_type":{"type":"string"},"message":{"type":"string"},"created_at":{"type":"string","format":"date-time"}}}},"components/schemas/webhook-payload":{"id":"components/schemas/webhook-payload","kind":"json-schema","title":"webhook-payload","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Body delivered to your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when a webhook fires (POST by default). All events share the same envelope; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tells you which fired, and one event-specific object ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_connection"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", …) is included for the relevant event. Objects are populated as far as the contact's data allows; unknown fields are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact.uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to fetch full contact details via "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getLead"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /leads/api/leads/{uuid}"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"event_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The event that fired (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createWebhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the full list)."},"children":[]}]}]}],"example":"sender_profile_sent_email"},"contact":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact. Includes identifiers and enrichment: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"position"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"headline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"company_uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sales_navigator_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ln_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sn_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"work_email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"personal_email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pipeline_stage_uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pipeline_stage_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"getsales_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and more."},"children":[]}]}]}]},"account":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact's company (name, domain, website, industry, linkedin_url, size, etc.)."},"children":[]}]}]}]},"sender_profile":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sender profile that performed the action. Present on all events (including the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_accepted_..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" events). Fields: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"label"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"assignee_user_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"team_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"automation":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The automation (flow) involved — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"priority"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"contact_markers":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Aggregate activity timestamps/counters for the contact, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_last_connection_sent_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_last_connection_accepted_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_messages_sent_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email_sent_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_messaging_activity_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"linkedin_connection":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_accepted_linkedin_connection_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"full_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nickname"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"connected_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"linkedin_connection_request":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sender_profile_sent_linkedin_connection_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ln_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nickname"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sent_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"linkedin_message":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On LinkedIn message/inmail events — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sent_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"email":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On email events — subject, body, status and timestamps for the email."},"children":[]}]}]}]},"latest_linkedin_conversation_thread":{"type":"object","nullable":true},"latest_email_conversation_thread":{"type":"object","nullable":true}},"example":{"event_name":"sender_profile_sent_email","contact":{"uuid":"00000000-0000-0000-0000-000000000001","name":"Example Name","linkedin_url":"https://www.linkedin.com/in/example","work_email":"work@example.com","pipeline_stage_name":"Opportunity"},"sender_profile":{"uuid":"00000000-0000-0000-0000-000000000001","label":"Example-Label"},"automation":{"uuid":"00000000-0000-0000-0000-000000000001","name":"Example Flow","status":"on"}}}},"components/schemas/webhook":{"id":"components/schemas/webhook","kind":"json-schema","title":"webhook","data":{"type":"object","description":"A webhook configuration.","properties":{"uuid":{"type":"string","example":"b27f3cfc-84a0-4fb8-956b-91d032f9c523"},"team_id":{"type":"integer"},"user_id":{"type":"integer"},"name":{"type":"string","example":"New Reply Handler"},"event":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event that triggers the webhook. Supported events: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_replied_email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_replied_linkedin_message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_exported"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_enriched"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["contact_replied_email","contact_replied_linkedin_message","contact_exported","contact_enriched"],"example":"contact_replied_linkedin_message"},"request_method":{"type":"string","description":"HTTP method for the outgoing request.","example":"POST"},"target_url":{"type":"string","format":"uri","example":"https://hook.eu2.make.com/abc123"},"filters":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional filter criteria to narrow which contacts trigger the webhook. Uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jsonLogic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"elasticQuery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter_tree_format"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" keys."},"children":[]}]}]}]},"status":{"type":"string","description":"Webhook status.","enum":["on","off"],"example":"on"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/user":{"id":"components/schemas/user","kind":"json-schema","title":"user","data":{"type":"object","description":"Authenticated user profile.","properties":{"uuid":{"type":"string"},"id":{"type":"integer"},"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Doe"},"email":{"type":"string","format":"email","example":"john@example.com"},"email_status":{"type":"string"},"image_url":{"type":"string","nullable":true},"timezone":{"type":"string","example":"Europe/Berlin"},"config":{"type":"object","additionalProperties":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/team":{"id":"components/schemas/team","kind":"json-schema","title":"team","data":{"type":"object","description":"A team (workspace) in the system.","properties":{"id":{"type":"integer"},"cluster_id":{"type":"integer"},"subscription_id":{"type":"integer","nullable":true},"license_uuid":{"type":"string","nullable":true},"name":{"type":"string","example":"My Team"},"color":{"type":"string","nullable":true},"status":{"type":"string","enum":["active"],"example":"active"},"features":{"type":"object","properties":{"sender_profiles":{"type":"integer","nullable":true},"cloud_browsers":{"type":"integer","nullable":true},"contacts":{"type":"integer","nullable":true},"linkedin_accounts":{"type":"integer","nullable":true},"email_accounts":{"type":"integer","nullable":true},"users":{"type":"integer","nullable":true}}},"credits":{"type":"object","properties":{"activities":{"type":"integer","nullable":true},"advanced_enrichment":{"type":"integer","nullable":true},"llm":{"type":"integer","nullable":true}}},"config":{"type":"object","properties":{"is_onboarding_completed":{"type":"boolean"},"is_cloud_browser_disabled":{"type":"boolean"}}},"user_id":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/flow-workspace":{"id":"components/schemas/flow-workspace","kind":"json-schema","title":"flow-workspace","data":{"type":"object","description":"An automation folder (workspace) for organizing automations.","properties":{"uuid":{"type":"string"},"team_id":{"type":"integer"},"user_id":{"type":"integer"},"name":{"type":"string","example":"Q2 Campaigns"},"order":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/data-source":{"id":"components/schemas/data-source","kind":"json-schema","title":"data-source","data":{"type":"object","description":"A LinkedIn import job (data source).","properties":{"uuid":{"type":"string"},"team_id":{"type":"integer"},"sender_profile_uuid":{"type":"string","nullable":true},"list_uuid":{"type":"string"},"payload":{"type":"object"},"tags":{"type":"array","nullable":true,"items":{"type":"string"}},"type":{"type":"string","enum":["csv_leads","sn_leads_search","sn_leads_saved_search","sn_leads_list","sn_accounts_search","sn_accounts_saved_search","sn_accounts_list","ln_leads_search","ln_accounts_search","ln_my_network","ln_my_messenger","post_engagement","recruiter_leads_search"]},"status":{"type":"string","enum":["not_started","in_progress","on_hold","completed","failed","contacts_limit_achieved"]},"errors":{"type":"array","items":{"type":"object"}},"user_id":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/linkedin-browser":{"id":"components/schemas/linkedin-browser","kind":"json-schema","title":"linkedin-browser","data":{"type":"object","description":"A LinkedIn browser profile used for automation.","properties":{"id":{"type":"integer"},"team_id":{"type":"integer"},"sender_profile_uuid":{"type":"string"},"linkedin_account_uuid":{"type":"string","nullable":true},"external_id":{"type":"string"},"name":{"type":"string"},"shared_emails":{"type":"array","items":{"type":"string"}},"linkedin_automation_server_id":{"type":"integer","nullable":true},"linkedin_proxy_id":{"type":"integer","nullable":true},"proxy_country_code":{"type":"string","nullable":true},"custom_proxy_config":{"type":"array","items":{"type":"object"}},"schedule":{"$ref":"#/components/schemas/schedule"},"linkedin_login":{"type":"string","nullable":true},"linkedin_password":{"type":"string","nullable":true},"ln_code":{"type":"string","nullable":true},"browser_owner":{"type":"string"},"status":{"type":"string","enum":["running","stopped","idle","start_issue","running_issue","login_issue","initializing"]},"error_reason":{"type":"string","nullable":true},"user_id":{"type":"integer"},"last_start_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/linkedin-conversation":{"id":"components/schemas/linkedin-conversation","kind":"json-schema","title":"linkedin-conversation","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A LinkedIn conversation thread with one contact, on one LinkedIn account. Not attributed to an automation — see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"List LinkedIn conversations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"uuid":{"type":"string","format":"uuid"},"id":{"type":"integer"},"team_id":{"type":"integer"},"lead_uuid":{"type":"string","format":"uuid","description":"Contact this conversation is with."},"linkedin_account_uuid":{"type":"string","format":"uuid","description":"LinkedIn account the thread belongs to."},"ln_id":{"type":"string","description":"LinkedIn member URN of the contact."},"ln_member_id":{"type":"string","nullable":true},"sn_id":{"type":"string","nullable":true,"description":"Sales Navigator thread id, when applicable."},"conversation_hash":{"type":"string"},"linkedin_messenger_type":{"type":"string","description":"Messenger surface the thread lives on.","example":"basic"},"lead_nickname":{"type":"string","nullable":true},"group_context":{"type":"string","nullable":true},"event_count":{"type":"integer"},"last_activity_at":{"type":"string","format":"date-time","nullable":true},"last_stored_message_at":{"type":"string","format":"date-time","nullable":true},"last_msg_sync_at":{"type":"string","format":"date-time","nullable":true},"need_to_sync":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/mixed-filter-type":{"id":"components/schemas/mixed-filter-type","kind":"json-schema","title":"mixed-filter-type","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flexible filter value. Supports: scalar (equals), array (IN), object with operator, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"is_null\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"is_not_null\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"object","additionalProperties":{"oneOf":[{"type":"string"},{"type":"integer"}]}},{"type":"string","enum":["is_null","is_not_null"]},{"type":"string"},{"type":"integer"}]}},"components/schemas/lead-blacklist-entry":{"id":"components/schemas/lead-blacklist-entry","kind":"json-schema","title":"lead-blacklist-entry","data":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"team_id":{"type":"integer"},"name":{"type":"string","nullable":true},"company_name":{"type":"string","nullable":true},"linkedin":{"type":"string","nullable":true,"description":"LinkedIn handle."},"ln_id":{"type":"string","nullable":true,"description":"LinkedIn member ID."},"email":{"type":"string","format":"email","nullable":true},"user_id":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/company-blacklist-entry":{"id":"components/schemas/company-blacklist-entry","kind":"json-schema","title":"company-blacklist-entry","data":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"team_id":{"type":"integer"},"name":{"type":"string","nullable":true},"domain":{"type":"string","nullable":true},"linkedin":{"type":"string","nullable":true},"ln_id":{"type":"string","nullable":true},"user_id":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/ai-agent":{"id":"components/schemas/ai-agent","kind":"json-schema","title":"ai-agent","data":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"public_uuid":{"type":"string","format":"uuid","nullable":true},"team_id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"avatar_url":{"type":"string","nullable":true},"classification_llm_uuid":{"type":"string","format":"uuid","nullable":true},"classification_llm_config":{"type":"object","nullable":true},"classification_prompt":{"type":"string","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"components/schemas/ai-template":{"id":"components/schemas/ai-template","kind":"json-schema","title":"ai-template","data":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"team_id":{"type":"integer"},"template_category_uuid":{"type":"string","format":"uuid","nullable":true},"name":{"type":"string"},"subject":{"type":"string","nullable":true},"body":{"type":"string","nullable":true},"attachments":{"type":"array","nullable":true,"items":{"type":"object"}},"type":{"type":"string","description":"Template type.","enum":["message","connection_note","email","post_comment"]},"llm_uuid":{"type":"string","format":"uuid","nullable":true},"llm_config":{"type":"object","nullable":true},"prompt":{"type":"string","nullable":true},"enable_validation":{"type":"boolean"},"validation_llm_uuid":{"type":"string","format":"uuid","nullable":true},"validation_llm_config":{"type":"object","nullable":true},"validation_prompt":{"type":"string","nullable":true},"enable_fallback":{"type":"boolean"},"settings":{"type":"object","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}},"schema_153":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":20,"example":20},"id":"schema_153"},"schema_154":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":0,"example":0},"id":"schema_154"},"schema_155":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/team"}},"limit":{"type":"integer","example":20},"offset":{"type":"integer","example":0},"total":{"type":"integer","example":3},"has_more":{"type":"boolean"}}},"id":"schema_155"},"schema_156":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_156"},"schema_157":{"kind":"json-schema","data":{"type":"object","required":["sender_profiles_limit"],"properties":{"sender_profiles_limit":{"type":"integer","minimum":1,"description":"Number of additional sender profiles to check capacity for.","example":1}}},"id":"schema_157"},"schema_158":{"kind":"json-schema","data":{"type":"object","properties":{"monthly":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monthly subscription capacity, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if no monthly plan."},"children":[]}]}]}]},"yearly":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yearly subscription capacity, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if no yearly plan."},"children":[]}]}]}]}}},"id":"schema_158"},"schema_159":{"kind":"json-schema","data":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Human-readable name for the API key.","example":"production-integration"}}},"id":"schema_159"},"schema_160":{"kind":"json-schema","data":{"type":"object","properties":{"jti":{"type":"string","description":"JWT ID. Use this to identify the key.","example":"mnsPNOxciRqSNFec"},"user_id":{"type":"integer","example":20},"team_id":{"type":"integer","nullable":true,"example":134},"name":{"type":"string","example":"production-integration"},"last_token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The actual JWT token. Pass this in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Save it immediately — it cannot be retrieved later."},"children":[]}]}]}]},"created_at":{"type":"string","format":"date-time"}}},"id":"schema_160"},"schema_161":{"kind":"json-schema","data":{"type":"object","properties":{"linkedin_id":{"type":"string","nullable":true,"description":"LinkedIn profile URL or member ID.","example":"john-doe-123456"},"email":{"type":"string","nullable":true,"description":"Email address to search by.","example":"john@example.com"},"name":{"type":"string","nullable":true,"description":"Full name of the contact.","example":"John Doe"},"company_name":{"type":"string","nullable":true,"description":"Company name (required when searching by name).","example":"Acme Inc"},"disable_aggregation":{"type":"boolean","description":"Skip enrichment data aggregation in the response."}},"anyOf":[{"required":["linkedin_id"]},{"required":["email"]},{"required":["name","company_name"]}]},"id":"schema_161"},"schema_162":{"kind":"json-schema","data":{"type":"object","properties":{"filter":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter criteria. Supports scalar values (equals), arrays (IN), objects with operators ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", etc.), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"is_null\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"is_not_null\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":{"company_name":"Acme Inc","email_status":"ok"}},"limit":{"type":"integer","minimum":1,"default":20,"description":"Number of results to return.","example":20},"offset":{"type":"integer","minimum":0,"default":0,"description":"Number of results to skip.","example":0},"order_field":{"type":"string","default":"created_at","description":"Field to sort by.","example":"name"},"order_type":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort direction.","example":"asc"},"disable_aggregation":{"type":"boolean","default":false,"description":"Skip enrichment data aggregation."}}},"id":"schema_162"},"schema_163":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/lead"}},"limit":{"type":"integer","example":20},"offset":{"type":"integer","example":0},"total":{"type":"integer","example":142}}},"id":"schema_163"},"schema_164":{"kind":"json-schema","data":{"type":"string"},"id":"schema_164"},"schema_165":{"kind":"json-schema","data":{"type":"object","properties":{"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Doe"},"company_name":{"type":"string","example":"Acme Inc"},"ln_id":{"type":"string","nullable":true,"description":"LinkedIn member ID.","example":"ACoAAAB6GuQBOXo75numqJfM9u08uHgjOSo4p9U"},"sn_id":{"type":"string","nullable":true,"description":"Sales Navigator ID.","example":"ACwAAAB6GuQBEz2TMHbG4sa7Nw5wSi7cJXMQkPI"},"linkedin":{"type":"string","nullable":true,"description":"LinkedIn profile handle.","example":"john-doe-123456"},"email":{"type":"string","format":"email","example":"john.doe@example.com"},"about":{"type":"string","description":"Bio or description."},"domain":{"type":"string","description":"Company domain (used for email discovery).","example":"acme.com"},"headline":{"type":"string","nullable":true,"example":"VP of Sales at Acme Inc"},"position":{"type":"string","nullable":true,"example":"VP of Sales"},"raw_address":{"type":"string","nullable":true,"example":"San Francisco, CA, USA"}}},"id":"schema_165"},"schema_166":{"kind":"json-schema","data":{"type":"object","required":["lead","list_uuid"],"properties":{"lead":{"allOf":[{"$ref":"#/components/schemas/create-lead-fields"},{"type":"object","required":["linkedin_id"]}]},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom field values as key-value pairs.","example":{"field_position":"CTO","field_experience":"10 years"}},"list_uuid":{"type":"string","description":"Target list UUID.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"update_if_exists":{"type":"boolean","default":true,"description":"Update the contact if it already exists."},"move_to_list":{"type":"boolean","default":false,"description":"Move existing contact to the specified list."}}},"id":"schema_166"},"schema_167":{"kind":"json-schema","data":{"type":"object","required":["type","filter"],"properties":{"type":{"type":"string","description":"Action type.","enum":["contact_add_tags","contact_remove_tags","contact_replace_tags","contact_change_list","contact_change_pipeline_stage","contact_change_custom_field","contact_add_to_flow","contact_cancel_from_flows","contact_delete","contact_export_csv","contact_mark_read"],"example":"contact_add_tags"},"filter":{"type":"object","additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter to select contacts. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ids: [\"uuid1\", \"uuid2\"]}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for specific contacts or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{all: true}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all matching contacts."},"children":[]}]}]}]},"payload":{"type":"object","additionalProperties":true,"description":"Action-specific payload (see table above)."}}},"id":"schema_167"},"schema_168":{"kind":"json-schema","data":{"type":"object","properties":{"ids":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specific contact UUIDs to count. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string","format":"uuid"},"example":["02dcb6ac-9b15-49f6-8882-fbca91e986ab"]},"all":{"type":"boolean","default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", count every contact in the team and ignore "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"filter":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional filter object — same shape as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/leads/api/leads/search"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"id":"schema_168"},"schema_169":{"kind":"json-schema","data":{"type":"object","properties":{"total":{"type":"integer","example":1234}}},"id":"schema_169"},"schema_170":{"kind":"json-schema","data":{"type":"object","required":["period_from","period_to","metrics"],"properties":{"period_from":{"type":"string","format":"date-time","description":"ISO 8601 datetime for the start of the period (inclusive).","example":"2026-04-01T00:00:00Z"},"period_to":{"type":"string","format":"date-time","description":"ISO 8601 datetime for the end of the period (inclusive).","example":"2026-04-28T23:59:59Z"},"flows":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional list of flow UUIDs to scope the metrics. Empty array = all flows."},"children":[]}]}]}],"items":{"type":"string","format":"uuid"},"default":[]},"metrics":{"type":"array","description":"List of metric names to retrieve. See the enum below.","items":{"type":"string","enum":["linkedin_connection_request_sent_count","linkedin_connection_request_accepted_count","linkedin_sent_count","linkedin_opened_count","linkedin_inbox_count","linkedin_inmail_sent_count","linkedin_inmail_replied_count","email_sent_count","email_opened_count","email_clicked_count","email_bounced_count","email_unsubscribed_count","email_inbox_count"]},"example":["linkedin_sent_count","linkedin_inbox_count","email_sent_count"]},"filter":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently ignored"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — included for forward compatibility once the backend filter is fixed. See the description above."},"children":[]}]}]}]},"group_by":{"type":"string","description":"Group key. Accepted values do not currently affect the response shape on the public endpoint.\n","enum":["sender_profiles","flows","lists","tags","pipeline_stages","workflows","date"],"example":"sender_profiles"}}},"id":"schema_170"},"schema_171":{"kind":"json-schema","data":{"type":"object","properties":{"total":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Map of metric name → count. Only the metrics requested in the input are present in the response."},"children":[]}]}]}],"additionalProperties":{"type":"integer"}}},"example":{"total":{"linkedin_connection_request_sent_count":7694,"linkedin_connection_request_accepted_count":3530,"linkedin_sent_count":5250,"linkedin_opened_count":2265,"linkedin_inbox_count":1202}}},"id":"schema_171"},"schema_172":{"kind":"json-schema","data":{"type":"object","properties":{"uuids":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact UUIDs to enrich. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not provided."},"children":[]}]}]}],"items":{"type":"string","format":"uuid"},"example":["02dcb6ac-9b15-49f6-8882-fbca91e986ab"]},"filter":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter to select contacts. Use instead of explicit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uuids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"anyOf":[{"required":["uuids"]},{"required":["filter"]}]},"id":"schema_172"},"schema_173":{"kind":"json-schema","data":{"type":"string","default":"created_at","example":"created_at"},"id":"schema_173"},"schema_174":{"kind":"json-schema","data":{"type":"string","enum":["asc","desc"],"default":"asc","example":"asc"},"id":"schema_174"},"schema_175":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object"}}}},"id":"schema_175"},"schema_176":{"kind":"json-schema","data":{"type":"object"},"id":"schema_176"},"schema_177":{"kind":"json-schema","data":{"type":"object","properties":{"this_month_count":{"type":"integer","example":0}}},"id":"schema_177"},"schema_178":{"kind":"json-schema","data":{"type":"object","properties":{"q":{"type":"string","description":"Search query."}}},"id":"schema_178"},"schema_179":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/company"}},"limit":{"type":"integer","example":20},"offset":{"type":"integer","example":0},"total":{"type":"integer","example":58}}},"id":"schema_179"},"schema_180":{"kind":"json-schema","data":{"type":"object","required":["companies"],"properties":{"companies":{"type":"array","description":"Array of company objects to create.","items":{"type":"object","properties":{"name":{"type":"string","example":"Acme Inc"},"domain":{"type":"string","example":"acme.com"},"website":{"type":"string","example":"https://acme.com"},"linkedin":{"type":"string","example":"acme-inc"},"industry":{"type":"string","example":"Technology"},"employees_range":{"type":"string","example":"51-200"},"hq_raw_address":{"type":"string","example":"San Francisco, CA"}}}},"list_uuids":{"type":"array","items":{"type":"string"},"description":"List UUIDs to assign companies to."},"data_source_uuid":{"type":"string"}}},"id":"schema_180"},"schema_181":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/company"}},"id":"schema_181"},"schema_182":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string","example":"Acme Inc"},"domain":{"type":"string","example":"acme.com"},"website":{"type":"string","example":"https://acme.com"},"linkedin":{"type":"string","example":"acme-inc"},"ln_id":{"type":"integer","description":"LinkedIn company numeric ID."},"industry":{"type":"string","example":"Technology"},"employees_range":{"type":"string","example":"51-200"},"hq_raw_address":{"type":"string","example":"San Francisco, CA"},"phone":{"type":"string"},"about":{"type":"string"},"lead_status_uuid":{"type":"string","description":"Pipeline stage UUID."}}},"id":"schema_182"},"schema_183":{"kind":"json-schema","data":{"type":"object","properties":{"filter":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter criteria. Same shape as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /leads/api/companies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter."},"children":[]}]}]}],"example":{"industry":"SaaS"}},"limit":{"type":"integer","minimum":1,"default":20,"example":20},"offset":{"type":"integer","minimum":0,"default":0,"example":0},"order_field":{"type":"string","default":"created_at"},"order_type":{"type":"string","enum":["asc","desc"],"default":"desc"}}},"id":"schema_183"},"schema_184":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/company"}},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"type":"integer"},"has_more":{"type":"boolean"}}},"id":"schema_184"},"schema_185":{"kind":"json-schema","data":{"type":"object","required":["lookups"],"properties":{"lookups":{"type":"array","items":{"type":"object","properties":{"ln_id":{"type":"string"},"linkedin":{"type":"string"},"website":{"type":"string"},"name":{"type":"string"}}}}}},"id":"schema_185"},"schema_186":{"kind":"json-schema","data":{"type":"object","required":["uuids"],"properties":{"uuids":{"type":"array","items":{"type":"string"},"description":"Array of company UUIDs."}}},"id":"schema_186"},"schema_187":{"kind":"json-schema","data":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/lead"}}},"id":"schema_187"},"schema_188":{"kind":"json-schema","data":{"type":"object","properties":{"filter":{"type":"object","description":"Filter to select companies for enrichment."},"uuids":{"type":"array","items":{"type":"string"},"description":"Specific company UUIDs to enrich."}}},"id":"schema_188"},"schema_189":{"kind":"json-schema","data":{"type":"object","properties":{"count":{"type":"integer","description":"Number of companies queued."}}},"id":"schema_189"},"schema_190":{"kind":"json-schema","data":{"type":"object","required":["type","filter"],"properties":{"type":{"type":"string","description":"Action type.","enum":["company_add_tags","company_remove_tags","company_replace_tags","company_change_pipeline_stage","company_delete"],"example":"company_add_tags"},"filter":{"type":"object","additionalProperties":true,"description":"Filter to select companies."},"payload":{"type":"object","additionalProperties":true,"description":"Action-specific payload."}}},"id":"schema_190"},"schema_191":{"kind":"json-schema","data":{"type":"object","properties":{"q":{"type":"string","nullable":true,"description":"Search by list name."},"uuid":{"$ref":"#/components/schemas/mixed-filter-type"},"name":{"$ref":"#/components/schemas/mixed-filter-type"}}},"id":"schema_191"},"schema_192":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/list"}},"limit":{"type":"integer","example":20},"offset":{"type":"integer","example":0},"total":{"type":"integer","example":12}}},"id":"schema_192"},"schema_193":{"kind":"json-schema","data":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name for the new list.","example":"CMO Germany"}}},"id":"schema_193"},"schema_194":{"kind":"json-schema","data":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Updated List Name"}}},"id":"schema_194"},"schema_195":{"kind":"json-schema","data":{"type":"object","required":["uuids"],"properties":{"uuids":{"type":"array","items":{"type":"string"},"description":"Array of list UUIDs."}}},"id":"schema_195"},"schema_196":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/tag"}}}},"id":"schema_196"},"schema_197":{"kind":"json-schema","data":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Hot Lead"},"color":{"type":"string","description":"Hex color code.","example":"#ff5733"}}},"id":"schema_197"},"schema_198":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string","example":"Warm Lead"},"color":{"type":"string","example":"#33ff57"}}},"id":"schema_198"},"schema_199":{"kind":"json-schema","data":{"type":"object","required":["uuids","metrics"],"properties":{"uuids":{"type":"array","items":{"type":"string"},"description":"Array of tag UUIDs."},"metrics":{"type":"array","items":{"type":"string","enum":["leads_count","companies_count"]},"description":"Which metrics to retrieve."}}},"id":"schema_199"},"schema_200":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/pipeline-stage"}}}},"id":"schema_200"},"schema_201":{"kind":"json-schema","data":{"type":"object","required":["name","object","category"],"properties":{"name":{"type":"string","example":"Demo Booked"},"object":{"type":"string","enum":["lead","company"],"example":"lead"},"category":{"type":"string","enum":["cold","engaging","positive","negative"],"description":"Visual category for the stage.","example":"positive"},"order":{"type":"integer","description":"Display order.","example":5}}},"id":"schema_201"},"schema_202":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string"},"category":{"type":"string","enum":["cold","engaging","positive","negative"]},"order":{"type":"integer"}}},"id":"schema_202"},"schema_203":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/custom-field"}}}},"id":"schema_203"},"schema_204":{"kind":"json-schema","data":{"type":"object","required":["name","object"],"properties":{"name":{"type":"string","description":"Field name.","example":"Industry Vertical"},"object":{"type":"string","enum":["lead","company"],"description":"Whether this field applies to contacts or companies.","example":"lead"},"order":{"type":"integer","description":"Display order."}}},"id":"schema_204"},"schema_205":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string"},"order":{"type":"integer"}}},"id":"schema_205"},"schema_206":{"kind":"json-schema","data":{"type":"object","required":["custom_field_uuid","object_type","object_uuid"],"properties":{"custom_field_uuid":{"type":"string","description":"UUID of the custom field."},"object_type":{"type":"string","enum":["lead","company"]},"object_uuid":{"type":"string","description":"UUID of the contact or company."},"value":{"type":"string","nullable":true,"description":"Field value, or null to clear.","example":"Enterprise"}}},"id":"schema_206"},"schema_207":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/note"}}}},"id":"schema_207"},"schema_208":{"kind":"json-schema","data":{"type":"object","required":["object","object_uuid","note"],"properties":{"object":{"type":"string","enum":["lead","company"],"example":"lead"},"object_uuid":{"type":"string","description":"UUID of the contact or company."},"note":{"type":"string","example":"Follow up after demo next week."}}},"id":"schema_208"},"schema_209":{"kind":"json-schema","data":{"type":"object","required":["note"],"properties":{"note":{"type":"string","example":"Updated note content."}}},"id":"schema_209"},"schema_210":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/activity"}}}},"id":"schema_210"},"schema_211":{"kind":"json-schema","data":{"type":"object","required":["object_uuid","object_type","type"],"properties":{"object_uuid":{"type":"string","description":"UUID of the contact or company."},"object_type":{"type":"string","enum":["lead","company"]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Activity type (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_message_sent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email_sent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"linkedin_message_sent"},"payload":{"type":"object","additionalProperties":true,"description":"Activity-specific data."}}},"id":"schema_211"},"schema_212":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/lead-blacklist-entry"}},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"type":"integer"},"has_more":{"type":"boolean"}}},"id":"schema_212"},"schema_213":{"kind":"json-schema","data":{"type":"object","properties":{"linkedin":{"type":"string","description":"LinkedIn profile handle.","example":"john-doe-123456"},"email":{"type":"string","format":"email"},"name":{"type":"string"},"company_name":{"type":"string"}},"anyOf":[{"required":["linkedin"]},{"required":["email"]},{"required":["name"]}]},"id":"schema_213"},"schema_214":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/company-blacklist-entry"}},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"type":"integer"},"has_more":{"type":"boolean"}}},"id":"schema_214"},"schema_215":{"kind":"json-schema","data":{"type":"object","properties":{"linkedin":{"type":"string","description":"LinkedIn company handle.","example":"acme-inc"},"domain":{"type":"string","example":"acme.com"},"name":{"type":"string","example":"Acme Inc"}},"anyOf":[{"required":["linkedin"]},{"required":["domain"]},{"required":["name"]}]},"id":"schema_215"},"schema_216":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/data-source"}},"limit":{"type":"integer","example":20},"offset":{"type":"integer","example":0},"total":{"type":"integer","example":10},"has_more":{"type":"boolean"}}},"id":"schema_216"},"schema_217":{"kind":"json-schema","data":{"type":"object","required":["type","list_uuid"],"properties":{"type":{"type":"string","enum":["csv_leads","sn_leads_search","sn_leads_saved_search","sn_leads_list","sn_accounts_search","sn_accounts_saved_search","sn_accounts_list","ln_leads_search","ln_accounts_search","ln_my_network","ln_my_messenger","post_engagement","recruiter_leads_search"],"example":"sn_leads_search"},"list_uuid":{"type":"string","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"payload":{"type":"object","description":"Import configuration specific to the data source type."},"tags":{"type":"array","nullable":true,"items":{"type":"string"}}}},"id":"schema_217"},"schema_218":{"kind":"json-schema","data":{"type":"object","properties":{"type":{"type":"string"},"list_uuid":{"type":"string"},"payload":{"type":"object"},"tags":{"type":"array","nullable":true,"items":{"type":"string"}}}},"id":"schema_218"},"schema_219":{"kind":"json-schema","data":{"type":"object","required":["uuids"],"properties":{"uuids":{"type":"array","items":{"type":"string","format":"uuid"},"example":["6df2d07d-36dc-4401-81e2-7d6bd5075214"]}}},"id":"schema_219"},"schema_220":{"kind":"json-schema","data":{"type":"object","additionalProperties":{"type":"object","properties":{"queued_records":{"type":"integer"},"saved_records":{"type":"integer"},"duplicate_records":{"type":"integer"},"blacklisted_records":{"type":"integer"},"error_records":{"type":"integer"},"child_queued_records":{"type":"integer"},"child_saved_records":{"type":"integer"},"child_duplicate_records":{"type":"integer"}}}},"id":"schema_220"},"schema_221":{"kind":"json-schema","data":{"type":"object","required":["file","type"],"properties":{"file":{"type":"string","format":"binary","description":"CSV file with header row."},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source type. Currently only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"csv_leads"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is accepted."},"children":[]}]}]}],"enum":["csv_leads"],"example":"csv_leads"}}},"id":"schema_221"},"schema_222":{"kind":"json-schema","data":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"team_id":{"type":"integer"},"type":{"type":"string"},"payload":{"type":"object","description":"Includes file path, delimiter, enclosure, and config."},"status":{"type":"string"}}},"id":"schema_222"},"schema_223":{"kind":"json-schema","data":{"type":"object","required":["columns"],"properties":{"columns":{"type":"array","description":"Ordered list of column mappings (one per CSV column).","items":{"type":"object","properties":{"source":{"type":"string","description":"CSV column header."},"target":{"type":"string","description":"Contact field to map to."}}},"example":[{"source":"first_name","target":"first_name"},{"source":"email","target":"email"}]},"list_uuid":{"type":"string","format":"uuid","description":"Optional list to add imported contacts to."},"tags":{"type":"array","description":"Optional tag UUIDs to apply to imported contacts.","items":{"type":"string","format":"uuid"}}}},"id":"schema_223"},"schema_224":{"kind":"json-schema","data":{"type":"object","required":["columns"],"properties":{"columns":{"type":"array","description":"Ordered list of column mappings.","items":{"type":"object","properties":{"source":{"type":"string"},"target":{"type":"string"}}}}}},"id":"schema_224"},"schema_225":{"kind":"json-schema","data":{"type":"object","required":["filter"],"properties":{"filter":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter to select contacts. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{all: true}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to export everything."},"children":[]}]}]}],"example":{"all":true}}}},"id":"schema_225"},"schema_226":{"kind":"json-schema","data":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"team_id":{"type":"integer"},"type":{"type":"string","example":"contact_export_csv"},"filter":{"type":"object"},"status":{"type":"string","example":"queued"}}},"id":"schema_226"},"schema_227":{"kind":"json-schema","data":{"type":"object","required":["filter"],"properties":{"filter":{"type":"object","example":{"all":true}}}},"id":"schema_227"},"schema_228":{"kind":"json-schema","data":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"type":{"type":"string","example":"account_export_csv"},"status":{"type":"string","example":"queued"}}},"id":"schema_228"},"schema_229":{"kind":"json-schema","data":{"type":"object","required":["file_name"],"properties":{"file_name":{"type":"string","description":"File name from the export record.","example":"leads-export-2026-04-28.csv"}}},"id":"schema_229"},"schema_230":{"kind":"json-schema","data":{"type":"string","format":"binary"},"id":"schema_230"},"schema_231":{"kind":"json-schema","data":{"type":"object","properties":{"q":{"type":"string","nullable":true,"description":"Search by automation name."},"status":{"$ref":"#/components/schemas/mixed-filter-type"}}},"id":"schema_231"},"schema_232":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/flow"}},"limit":{"type":"integer","example":20},"offset":{"type":"integer","example":0},"total":{"type":"integer","example":15},"has_more":{"type":"boolean"}}},"id":"schema_232"},"schema_233":{"kind":"json-schema","data":{"type":"object","required":["name","use_sender_schedule","schedule"],"properties":{"name":{"type":"string","description":"Automation name.","example":"DACH CTO Outreach"},"use_sender_schedule":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", each step runs on its sender profile's own working-hours schedule and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object below is ignored at runtime (but is still required in the request). When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the flow "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applies."},"children":[]}]}]}],"example":false},"schedule":{"$ref":"#/components/schemas/schedule"},"description":{"type":"string","nullable":true},"priority":{"type":"integer","description":"Execution priority (higher runs first). Defaults to 2.","example":2},"is_public":{"type":"boolean","description":"Whether the automation is visible to the whole team."},"flow_workspace_uuid":{"type":"string","nullable":true,"description":"UUID of the folder (workspace) to place the automation in."}}},"id":"schema_233"},"schema_234":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string","example":"Updated Campaign Name"},"description":{"type":"string"},"schedule":{"$ref":"#/components/schemas/schedule"}}},"id":"schema_234"},"schema_235":{"kind":"json-schema","data":{"type":"object","required":["flow_uuid","name"],"properties":{"flow_uuid":{"type":"string","description":"UUID of the automation to clone."},"name":{"type":"string","example":"Campaign Q2 - Copy"},"flow_workspace_uuid":{"type":"string"}}},"id":"schema_235"},"schema_236":{"kind":"json-schema","data":{"type":"object","required":["node_ids"],"properties":{"node_ids":{"type":"array","description":"Integer node ids to report on.","items":{"type":"integer"}},"filter":{"type":"object","nullable":true,"description":"Optional date-range / contact filter to scope the counts."}}},"id":"schema_236"},"schema_237":{"kind":"json-schema","data":{"type":"object","additionalProperties":{"type":"object","properties":{"node_statuses":{"type":"object","additionalProperties":{"type":"integer"}},"node_conversions":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object of outcome → count, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the node has none."},"children":[]}]}]}],"oneOf":[{"type":"object","additionalProperties":{"type":"integer"}},{"type":"array"}]},"node_branches":{"type":"object","additionalProperties":{"type":"integer"}}}}},"id":"schema_237"},"schema_238":{"kind":"json-schema","data":{"type":"object","required":["contact_source_ids"],"properties":{"contact_source_ids":{"type":"array","items":{"type":"integer"}}}},"id":"schema_238"},"schema_239":{"kind":"json-schema","data":{"type":"object","additionalProperties":{"type":"object"}},"id":"schema_239"},"schema_240":{"kind":"json-schema","data":{"type":"object","properties":{"filter":{"type":"object","properties":{"flow_uuid":{"type":"array","items":{"type":"string","format":"uuid"}},"lead_uuid":{"type":"array","items":{"type":"string","format":"uuid"}},"status":{"type":"array","items":{"type":"string"}}}},"limit":{"type":"integer","default":20},"offset":{"type":"integer","default":0}}},"id":"schema_240"},"schema_241":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object"}},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"type":"integer"},"has_more":{"type":"boolean"}}},"id":"schema_241"},"schema_242":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_242"},"schema_243":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/flow-workspace"}},"limit":{"type":"integer","example":20},"offset":{"type":"integer","example":0},"total":{"type":"integer","example":5},"has_more":{"type":"boolean"}}},"id":"schema_243"},"schema_244":{"kind":"json-schema","data":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Q2 Campaigns"},"order":{"type":"integer","example":1}}},"id":"schema_244"},"schema_245":{"kind":"json-schema","data":{"type":"object","required":["uuids"],"properties":{"uuids":{"type":"array","description":"List of automation UUIDs.","items":{"type":"string"}}}},"id":"schema_245"},"schema_246":{"kind":"json-schema","data":{"type":"object","additionalProperties":{"type":"object","properties":{"leads_count":{"type":"integer","description":"Total contacts added to this automation."},"in_progress_leads_count":{"type":"integer","description":"Contacts currently in progress."},"finished_leads_count":{"type":"integer","description":"Contacts that completed the sequence."},"failed_leads_count":{"type":"integer","description":"Contacts that failed."},"task_counts":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pending"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tasks keyed by type — i.e. still queued to run (equivalent to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"List tasks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter[status]=in_progress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). This is queue depth, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" how many were sent. For sent volume use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/listTasks"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"listTasks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter[status]=closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"additionalProperties":{"type":"integer"}}}}},"id":"schema_246"},"schema_247":{"kind":"json-schema","data":{"type":"object","required":["lead","list_uuid"],"properties":{"lead":{"allOf":[{"$ref":"#/components/schemas/create-lead-fields"},{"type":"object","required":["linkedin_id"]}]},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom field values.","example":{"field_position":"CTO"}},"list_uuid":{"type":"string","description":"List UUID for the new contact."},"update_lead_if_exists":{"type":"boolean","default":true},"move_to_list":{"type":"boolean","default":false},"flow_segment_id":{"type":"integer","default":1,"description":"Automation segment to enter."},"skip_if_lead_exists":{"type":"boolean","description":"Skip if contact already exists."}}},"id":"schema_247"},"schema_248":{"kind":"json-schema","data":{"type":"object","properties":{"reason":{"type":"string","example":"skipped"}}},"id":"schema_248"},"schema_249":{"kind":"json-schema","data":{"type":"object","required":["flow_uuids"],"properties":{"flow_uuids":{"type":"array","items":{"type":"string"},"description":"Automation UUIDs to cancel from."}}},"id":"schema_249"},"schema_250":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid"},"flow_uuid":{"type":"string","format":"uuid"},"nodes":{"type":"array"},"contact_sources":{"type":"array"},"created_at":{"type":"string","format":"date-time"}}}},"id":"schema_250"},"schema_251":{"kind":"json-schema","data":{"type":"object","required":["nodes","contact_sources"],"properties":{"nodes":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The node tree — an ordered list of steps connected by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"before"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" edges. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#schema/flow-node"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flow-node"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schema for the shape of each node and the payload of every node "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Every branch must terminate in an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#schema/flow-node"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" node — a flow can have several. Branches that reconverge do so before ending; set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_common_node_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the reconvergence node. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every node must include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamps"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (unlike "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"validate-node"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which does not require them)."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/flow-node"}},"contact_sources":{"type":"array","minItems":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Who enters the flow. See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#schema/contact-source"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact-source"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schema. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must contain at least one source"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — an empty array is rejected with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (\"The contact sources field is required.\", verified on prod 2026-07-05). For a version with no audience yet, send one default source with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sender_profiles: []"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" pointing at the tree's entry node — the same shape the backend auto-creates with a new flow shell (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"KNOWN_ISSUES.md"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" §4)."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/contact-source"}},"first_common_node_id":{"type":"integer","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the first node where all branches reconverge. Set by the web editor for layout; may be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for linear trees. Include it when round-tripping a version you read back from the API."},"children":[]}]}]}]}}},"id":"schema_251"},"schema_252":{"kind":"json-schema","data":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"Contact source ID (integer).","example":1},"type":{"type":"string","example":"manual"},"options":{"type":"object"}}},"id":"schema_252"},"schema_253":{"kind":"json-schema","data":{"type":"object","properties":{"flow_uuid":{"$ref":"#/components/schemas/mixed-filter-type"},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Task status. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"closed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = executed (e.g. message/request actually sent)."},"children":[]}]}]}],"type":"string","enum":["in_progress","closed","canceled","failed","skipped"]},"type":{"description":"Task type.","type":"string","enum":["linkedin_send_message","linkedin_send_connection_request","linkedin_send_inmail","linkedin_like_latest_post","linkedin_endorse_skills","linkedin_withdraw_connection_request","email_send_message","trigger_linkedin_connection_request_accepted"]},"automation":{"description":"Task source.","type":"string","enum":["manual","auto"]},"lead_uuid":{"$ref":"#/components/schemas/mixed-filter-type"},"sender_profile_uuid":{"$ref":"#/components/schemas/mixed-filter-type"},"flow_node_id":{"type":"integer","description":"Filter by the node in the flow tree that produced the task."},"executed_at":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the task actually ran. Use operators for ranges, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter[executed_at][>=]=2026-07-22"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/mixed-filter-type"}]},"schedule_at":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the task is scheduled to run (often "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for executed tasks)."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/mixed-filter-type"}]}}},"id":"schema_253"},"schema_254":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/task"}},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"type":"integer"}}},"id":"schema_254"},"schema_255":{"kind":"json-schema","data":{"type":"object","required":["lead_uuid","sender_profile_uuid","text","schedule_at"],"properties":{"lead_uuid":{"type":"string"},"sender_profile_uuid":{"type":"string"},"type":{"type":"string","default":"linkedin_send_message","example":"linkedin_send_message"},"text":{"type":"string","example":"Hi John, I'd love to connect!"},"note":{"type":"string"},"schedule_at":{"type":"string","format":"date-time","example":"2026-03-01T10:00:00.000000Z"},"timezone":{"type":"string","default":"UTC"}}},"id":"schema_255"},"schema_256":{"kind":"json-schema","data":{"type":"object","required":["lead_uuid"],"properties":{"lead_uuid":{"type":"string","description":"UUID of the contact to resume."}}},"id":"schema_256"},"schema_257":{"kind":"json-schema","data":{"type":"string","format":"date"},"id":"schema_257"},"schema_258":{"kind":"json-schema","data":{"type":"object","required":["uuids"],"properties":{"uuids":{"type":"array","items":{"type":"string"},"description":"Array of task UUIDs to cancel."}}},"id":"schema_258"},"schema_259":{"kind":"json-schema","data":{"type":"object","required":["uuids"],"properties":{"uuids":{"type":"array","items":{"type":"string"},"description":"Array of task UUIDs to complete."}}},"id":"schema_259"},"schema_260":{"kind":"json-schema","data":{"type":"object","required":["uuids"],"properties":{"uuids":{"type":"array","items":{"type":"string"},"description":"Array of task UUIDs to retry."}}},"id":"schema_260"},"schema_261":{"kind":"json-schema","data":{"type":"object","required":["uuids"],"properties":{"uuids":{"type":"array","items":{"type":"string"},"description":"Array of task UUIDs to skip."}}},"id":"schema_261"},"schema_262":{"kind":"json-schema","data":{"type":"object","required":["group_field"],"properties":{"group_field":{"type":"string","enum":["flow_uuid","sender_profile_uuid","type","status"],"description":"Field to break the counts down by."},"filter":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional filter, same fields as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"List tasks"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flow_uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sender_profile_uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"executed_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" range, …), composable."},"children":[]}]}]}]}}},"id":"schema_262"},"schema_263":{"kind":"json-schema","data":{"type":"object","additionalProperties":{"type":"integer"}},"id":"schema_263"},"schema_264":{"kind":"json-schema","data":{"type":"object","properties":{"q":{"type":"string","nullable":true},"status":{"$ref":"#/components/schemas/mixed-filter-type"}}},"id":"schema_264"},"schema_265":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/sender-profile"}},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"type":"integer"},"has_more":{"type":"boolean"}}},"id":"schema_265"},"schema_266":{"kind":"json-schema","data":{"type":"object","required":["first_name","last_name","assignee_user_id"],"properties":{"first_name":{"type":"string","example":"John"},"last_name":{"type":"string","example":"Doe"},"assignee_user_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User the profile is assigned to (e.g. your own id from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/id/api/users/current"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"label":{"type":"string","example":"Sales Team - US"},"linkedin_schedule":{"$ref":"#/components/schemas/schedule"},"email_schedule":{"$ref":"#/components/schemas/schedule"}}},"id":"schema_266"},"schema_267":{"kind":"json-schema","data":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"label":{"type":"string"},"schedule":{"type":"object"}}},"id":"schema_267"},"schema_268":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ai-agent"}},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"type":"integer"},"has_more":{"type":"boolean"}}},"id":"schema_268"},"schema_269":{"kind":"json-schema","data":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Reply classifier"},"description":{"type":"string","nullable":true},"avatar_url":{"type":"string","nullable":true},"classification_llm_uuid":{"type":"string","format":"uuid","description":"UUID of the LLM connection used for classification."},"classification_llm_config":{"type":"object"},"classification_prompt":{"type":"string"}}},"id":"schema_269"},"schema_270":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true},"avatar_url":{"type":"string","nullable":true},"classification_llm_uuid":{"type":"string","format":"uuid"},"classification_llm_config":{"type":"object"},"classification_prompt":{"type":"string"}}},"id":"schema_270"},"schema_271":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ai-template"}},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"type":"integer"},"has_more":{"type":"boolean"}}},"id":"schema_271"},"schema_272":{"kind":"json-schema","data":{"type":"object","required":["name","type","is_public"],"properties":{"name":{"type":"string","example":"Cold outreach — CTO"},"type":{"type":"string","description":"Template type.","enum":["message","connection_note","email","post_comment"],"example":"message"},"is_public":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = visible to the whole team, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = private. Required (see note above)."},"children":[]}]}]}],"enum":[0,1],"example":1},"subject":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subject line (for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" templates)."},"children":[]}]}]}]},"body":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template body. Supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{variables}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{{first_name}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"prompt":{"type":"string","nullable":true,"description":"AI personalization prompt."},"llm_uuid":{"type":"string","format":"uuid","nullable":true,"description":"LLM integration to use for AI blocks."},"llm_config":{"type":"object","nullable":true},"enable_validation":{"type":"boolean"},"enable_fallback":{"type":"boolean"},"settings":{"type":"object"}}},"id":"schema_272"},"schema_273":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string"},"subject":{"type":"string","nullable":true},"body":{"type":"string","nullable":true},"prompt":{"type":"string","nullable":true},"llm_uuid":{"type":"string","format":"uuid","nullable":true},"llm_config":{"type":"object","nullable":true},"enable_validation":{"type":"boolean"},"enable_fallback":{"type":"boolean"},"settings":{"type":"object"}}},"id":"schema_273"},"schema_274":{"kind":"json-schema","data":{"type":"object","required":["lead_uuid","sender_profile_uuid"],"properties":{"uuid":{"type":"string","format":"uuid","description":"Existing template UUID. If provided, other fields default from saved template."},"lead_uuid":{"type":"string","format":"uuid"},"sender_profile_uuid":{"type":"string","format":"uuid"},"subject":{"type":"string"},"body":{"type":"string"},"type":{"type":"string"},"llm_uuid":{"type":"string","format":"uuid"},"llm_config":{"type":"object"},"prompt":{"type":"string"},"enable_validation":{"type":"boolean"},"enable_fallback":{"type":"boolean"},"settings":{"type":"object"}}},"id":"schema_274"},"schema_275":{"kind":"json-schema","data":{"type":"object","properties":{"llm_instructions":{"type":"string","nullable":true},"rendered_body":{"type":"string","nullable":true},"ai_generated_body":{"type":"string","nullable":true},"fallback_body":{"type":"string","nullable":true},"handling_error":{"type":"string","nullable":true},"validation_history":{"type":"array","items":{"type":"object"}}}},"id":"schema_275"},"schema_276":{"kind":"json-schema","data":{"type":"object","properties":{"q":{"type":"string","nullable":true},"lead_uuid":{"$ref":"#/components/schemas/mixed-filter-type"},"sender_profile_uuid":{"$ref":"#/components/schemas/mixed-filter-type"},"type":{"$ref":"#/components/schemas/mixed-filter-type"},"status":{"$ref":"#/components/schemas/mixed-filter-type"}}},"id":"schema_276"},"schema_277":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/linkedin-message"}},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"type":"integer"},"has_more":{"type":"boolean"}}},"id":"schema_277"},"schema_278":{"kind":"json-schema","data":{"type":"object","required":["sender_profile_uuid","lead_uuid","text"],"properties":{"sender_profile_uuid":{"type":"string"},"lead_uuid":{"type":"string"},"text":{"type":"string","example":"Hi John, thanks for connecting!"},"template_uuid":{"type":"string","description":"Optional AI template UUID."},"attachments":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files to attach to the message. Upload files first via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /flows/api/attachments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then pass an array of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"uuid\": \"...\" }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" references here."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/attachment-ref"}}}},"id":"schema_278"},"schema_279":{"kind":"json-schema","data":{"type":"object","required":["group_field"],"properties":{"group_field":{"type":"string","enum":["status","type","sender_profile_uuid","linkedin_account_uuid"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to group by. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outbox"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (sent) / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inbox"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (replies); "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"done"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"new"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sender_profile_uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_account_uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → counts per sender / per LinkedIn account."},"children":[]}]}]}]},"filter":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional filter, composable. Supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inbox"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outbox"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sender_profile_uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lead_uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sent_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date range."},"children":[]}]}]}]}}},"id":"schema_279"},"schema_280":{"kind":"json-schema","data":{"type":"object","properties":{"flow_uuid":{"description":"Automation the email belongs to (empty for mailbox-synced mail).","allOf":[{"$ref":"#/components/schemas/mixed-filter-type"}]},"flow_node_id":{"type":"integer","description":"Node in the flow tree that produced the email."},"mailbox_uuid":{"$ref":"#/components/schemas/mixed-filter-type"},"lead_uuid":{"$ref":"#/components/schemas/mixed-filter-type"},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outbox"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (sent) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inbox"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (received)."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/mixed-filter-type"}]},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (sent by automation), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sync"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (synced from mailbox)."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/mixed-filter-type"}]},"sent_at":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date/time sent. Use operators for ranges, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter[sent_at][>=]=2026-07-01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/mixed-filter-type"}]},"from_email":{"$ref":"#/components/schemas/mixed-filter-type"},"to_email":{"$ref":"#/components/schemas/mixed-filter-type"},"thread_uuid":{"$ref":"#/components/schemas/mixed-filter-type"},"template_uuid":{"$ref":"#/components/schemas/mixed-filter-type"},"folder":{"$ref":"#/components/schemas/mixed-filter-type"}}},"id":"schema_280"},"schema_281":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/email"}},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"type":"integer"}}},"id":"schema_281"},"schema_282":{"kind":"json-schema","data":{"type":"object","required":["sender_profile_uuid","lead_uuid","from_name","from_email","to_name","to_email","subject"],"properties":{"sender_profile_uuid":{"type":"string","format":"uuid"},"lead_uuid":{"type":"string","format":"uuid"},"from_name":{"type":"string","example":"John Doe"},"from_email":{"type":"string","example":"john@company.com"},"to_name":{"type":"string","example":"Jane Smith"},"to_email":{"type":"string","example":"jane@acme.com"},"cc":{"type":"array","items":{"type":"string"}},"bcc":{"type":"array","items":{"type":"string"}},"subject":{"type":"string","example":"Quick question about your outreach stack"},"body":{"type":"string","description":"Email body (HTML supported)."},"attachments":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files to attach to the email. Upload files first via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /flows/api/attachments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then pass an array of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{ \"uuid\": \"...\" }"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" references here."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/attachment-ref"}}}},"id":"schema_282"},"schema_283":{"kind":"json-schema","data":{"type":"object","properties":{"emailDomain":{"$ref":"#/components/schemas/email"},"emailBodyDomain":{"$ref":"#/components/schemas/email-body"}}},"id":"schema_283"},"schema_284":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/email-body"}}}},"id":"schema_284"},"schema_285":{"kind":"json-schema","data":{"type":"object","required":["lead_uuids"],"properties":{"lead_uuids":{"type":"array","items":{"type":"string"},"description":"Array of contact UUIDs."}}},"id":"schema_285"},"schema_286":{"kind":"json-schema","data":{"type":"object","required":["sender_profile_uuid","lead_uuid","lead_name"],"properties":{"sender_profile_uuid":{"type":"string"},"lead_uuid":{"type":"string"},"lead_name":{"type":"string","description":"Name of the contact (for personalization)."},"limit":{"type":"string"},"sent_at_recency_in_days":{"type":"integer"}}},"id":"schema_286"},"schema_287":{"kind":"json-schema","data":{"type":"object","properties":{"q":{"type":"string"}}},"id":"schema_287"},"schema_288":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/mailbox"}},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"type":"integer"}}},"id":"schema_288"},"schema_289":{"kind":"json-schema","data":{"type":"object","required":["email","sender_name","sender_profile_uuid"],"properties":{"email":{"type":"string","example":"outreach@company.com"},"sender_name":{"type":"string","example":"John from Company"},"sender_profile_uuid":{"type":"string"},"provider":{"type":"string"},"connection_settings":{"type":"object","properties":{"smtp_host":{"type":"string"},"smtp_port":{"type":"integer"},"smtp_username":{"type":"string"},"smtp_password":{"type":"string"},"imap_host":{"type":"string"},"imap_port":{"type":"integer"},"imap_username":{"type":"string"},"imap_password":{"type":"string"}}},"automation_daily_limit":{"type":"integer","example":50},"automation_task_interval":{"type":"integer","example":120}}},"id":"schema_289"},"schema_290":{"kind":"json-schema","data":{"type":"object","properties":{"sender_name":{"type":"string"},"automation_daily_limit":{"type":"integer"},"automation_task_interval":{"type":"integer"},"connection_settings":{"type":"object"},"custom_tracking_domain_uuid":{"type":"string"}}},"id":"schema_290"},"schema_291":{"kind":"json-schema","data":{"type":"object","required":["automation_reassign_mailboxes"],"properties":{"automation_reassign_mailboxes":{"type":"boolean"},"automation_mailbox_to_reassign":{"type":"string"}}},"id":"schema_291"},"schema_292":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/mailbox-error"}}}},"id":"schema_292"},"schema_293":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/attachment"}},"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"type":"integer"},"has_more":{"type":"boolean"}}},"id":"schema_293"},"schema_294":{"kind":"json-schema","data":{"type":"object","required":["attachment","payload"],"properties":{"attachment":{"type":"string","format":"binary","description":"The file to upload."},"payload":{"type":"object","required":["name","size","type"],"properties":{"name":{"type":"string","description":"Original filename.","example":"photo.png"},"size":{"type":"string","description":"File size in bytes (as string).","example":"324274"},"type":{"type":"string","description":"MIME type.","example":"image/png"}}}}},"id":"schema_294"},"schema_295":{"kind":"json-schema","data":{"type":"object","properties":{"limit":{"type":"integer","default":20,"example":20},"offset":{"type":"integer","default":0,"example":0},"order_field":{"type":"string","default":"created_at","example":"created_at"},"order_type":{"type":"string","enum":["asc","desc"],"default":"asc","example":"asc"}}},"id":"schema_295"},"schema_296":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/linkedin-browser"}},"limit":{"type":"integer","example":20},"offset":{"type":"integer","example":0},"total":{"type":"integer","example":5},"has_more":{"type":"boolean"}}},"id":"schema_296"},"schema_297":{"kind":"json-schema","data":{"type":"object","required":["sender_profile_uuid"],"properties":{"sender_profile_uuid":{"type":"string","description":"UUID of the sender profile to link."},"proxy_country_code":{"type":"string","description":"Proxy country code (e.g., US, DE).","example":"US"}}},"id":"schema_297"},"schema_298":{"kind":"json-schema","data":{"type":"object","properties":{"external_access_key":{"type":"string","example":"lb_ak_ccdxFh94PAOJ6_jTnFPt9ct_bywcdrJo81f0sLUjGgI"},"cloud_browser_url":{"type":"string","format":"uri","description":"Public 7-day login page. Swap the host to your API domain if desired.","example":"https://leadgen.grinfi.io/cloud-browser/public/lb_ak_ccdxFh94PAOJ6_jTnFPt9ct_bywcdrJo81f0sLUjGgI"}}},"id":"schema_298"},"schema_299":{"kind":"json-schema","data":{"type":"object","properties":{"proxy_country_code":{"type":"string","example":"DE"}}},"id":"schema_299"},"schema_300":{"kind":"json-schema","data":{"type":"object","required":["recipients"],"properties":{"recipients":{"type":"array","items":{"type":"string","format":"email"},"description":"Email addresses of team members to share with.","example":["colleague@example.com"]}}},"id":"schema_300"},"schema_301":{"kind":"json-schema","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/webhook"}},"limit":{"type":"integer","example":20},"offset":{"type":"integer","example":0},"total":{"type":"integer","example":3},"has_more":{"type":"boolean"}}},"id":"schema_301"},"schema_302":{"kind":"json-schema","data":{"type":"object","required":["name","event","target_url"],"properties":{"name":{"type":"string","description":"Human-readable label.","example":"New Reply Handler"},"event":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event that triggers the webhook."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender-profile actions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (something was sent): "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sender_profile_sent_email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sender_profile_sent_linkedin_message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sender_profile_sent_linkedin_connection_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sender_profile_sent_linkedin_inmail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contact events"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_accepted_linkedin_connection_request"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_replied_email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_replied_linkedin_message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_replied_linkedin_inmail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_opened_email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_clicked_email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_unsubscribed_email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email_bounced"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_enriched"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_exported"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_updated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_deleted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_tag_added"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_pipeline_stage_changed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#schema/webhook-payload"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webhook-payload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schema for the body delivered to your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["sender_profile_sent_email","sender_profile_sent_linkedin_message","sender_profile_sent_linkedin_connection_request","sender_profile_sent_linkedin_inmail","contact_accepted_linkedin_connection_request","contact_replied_email","contact_replied_linkedin_message","contact_replied_linkedin_inmail","contact_opened_email","contact_clicked_email","contact_unsubscribed_email","email_bounced","contact_enriched","contact_exported","contact_created","contact_updated","contact_deleted","contact_tag_added","contact_pipeline_stage_changed"],"example":"sender_profile_sent_email"},"request_method":{"type":"string","description":"HTTP method for the outgoing request.","enum":["POST","GET","PUT","PATCH","DELETE"],"default":"POST","example":"POST"},"target_url":{"type":"string","format":"uri","description":"URL that will receive the webhook payload.","example":"https://hook.eu2.make.com/abc123"},"filters":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional filter object to narrow which contacts trigger the webhook. Uses a tree-based filter format with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jsonLogic"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter_tree_format"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" keys."},"children":[]}]}]}]},"status":{"type":"string","enum":["on","off"],"default":"on"}}},"id":"schema_302"},"schema_303":{"kind":"json-schema","data":{"$ref":"#/components/schemas/webhook-payload"},"id":"schema_303"},"schema_304":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string"},"event":{"type":"string","enum":["contact_replied_email","contact_replied_linkedin_message","contact_exported","contact_enriched"]},"request_method":{"type":"string","enum":["POST","GET","PUT","PATCH","DELETE"]},"target_url":{"type":"string","format":"uri"},"filters":{"type":"object","nullable":true},"status":{"type":"string","enum":["on","off"]}}},"id":"schema_304"},"schema_305":{"kind":"json-schema","data":{"type":"object","required":["uuid","event","request_method","target_url"],"properties":{"uuid":{"type":"string","description":"UUID of the webhook to test."},"event":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Event whose sample payload to send (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createWebhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for values)."},"children":[]}]}]}],"example":"sender_profile_sent_email"},"request_method":{"type":"string","enum":["POST","GET","PUT","PATCH","DELETE"],"example":"POST"},"target_url":{"type":"string","format":"uri","example":"https://your-endpoint.com/hook"}}},"id":"schema_305"}},"exampleStore":{"paths/~1leads~1api~1leads~1lookup-one/post/requestBody/content/application~1json/example":{"value":{"linkedin_id":"john-doe-123456"},"id":"paths/~1leads~1api~1leads~1lookup-one/post/requestBody/content/application~1json/example"},"paths/~1leads~1api~1leads~1search/post/requestBody/content/application~1json/example":{"value":{"filter":{"company_name":"Acme Inc","email_status":"ok"},"limit":20,"offset":0,"order_field":"created_at","order_type":"desc"},"id":"paths/~1leads~1api~1leads~1search/post/requestBody/content/application~1json/example"},"paths/~1leads~1api~1leads~1upsert/post/requestBody/content/application~1json/example":{"value":{"lead":{"linkedin_id":"john-doe-123456","first_name":"John","last_name":"Doe","company_name":"Acme Inc","email":"john@acme.com"},"list_uuid":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","update_if_exists":true},"id":"paths/~1leads~1api~1leads~1upsert/post/requestBody/content/application~1json/example"},"paths/~1leads~1api~1leads~1mass-action/put/requestBody/content/application~1json/example":{"value":{"type":"contact_add_tags","filter":{"ids":["a1b2c3d4-e5f6-7890-abcd-ef1234567890"]},"payload":{"tag_uuid":"b2c3d4e5-f6a7-8901-bcde-f12345678901"}},"id":"paths/~1leads~1api~1leads~1mass-action/put/requestBody/content/application~1json/example"},"paths/~1leads~1api~1leads~1count/post/requestBody/content/application~1json/example":{"value":{"all":true},"id":"paths/~1leads~1api~1leads~1count/post/requestBody/content/application~1json/example"},"paths/~1leads~1api~1leads~1metrics/post/requestBody/content/application~1json/example":{"value":{"period_from":"2026-04-01T00:00:00Z","period_to":"2026-04-28T23:59:59Z","flows":[],"metrics":["linkedin_connection_request_sent_count","linkedin_connection_request_accepted_count","linkedin_sent_count","linkedin_opened_count","linkedin_inbox_count"],"filter":{},"group_by":"sender_profiles"},"id":"paths/~1leads~1api~1leads~1metrics/post/requestBody/content/application~1json/example"},"paths/~1leads~1api~1leads~1advanced-enrichment/put/requestBody/content/application~1json/example":{"value":{"uuids":["02dcb6ac-9b15-49f6-8882-fbca91e986ab"]},"id":"paths/~1leads~1api~1leads~1advanced-enrichment/put/requestBody/content/application~1json/example"},"paths/~1leads~1api~1enrichment-queue~1metrics/post/requestBody/content/application~1json/example":{"value":{},"id":"paths/~1leads~1api~1enrichment-queue~1metrics/post/requestBody/content/application~1json/example"},"paths/~1leads~1api~1companies/post/requestBody/content/application~1json/example":{"value":{"companies":[{"name":"Acme Inc","domain":"acme.com","industry":"Technology"}],"list_uuids":["a1b2c3d4-e5f6-7890-abcd-ef1234567890"]},"id":"paths/~1leads~1api~1companies/post/requestBody/content/application~1json/example"},"paths/~1leads~1api~1companies~1list/post/requestBody/content/application~1json/example":{"value":{"filter":{},"limit":20,"offset":0},"id":"paths/~1leads~1api~1companies~1list/post/requestBody/content/application~1json/example"},"paths/~1leads~1api~1companies~1lookup/post/requestBody/content/application~1json/example":{"value":{"lookups":[{"linkedin":"acme-inc"},{"website":"acme.com"}]},"id":"paths/~1leads~1api~1companies~1lookup/post/requestBody/content/application~1json/example"},"paths/~1leads~1api~1companies~1leads/post/requestBody/content/application~1json/example":{"value":{"uuids":["a1b2c3d4-e5f6-7890-abcd-ef1234567890"]},"id":"paths/~1leads~1api~1companies~1leads/post/requestBody/content/application~1json/example"},"paths/~1leads~1api~1companies~1advanced-enrichment/put/requestBody/content/application~1json/example":{"value":{"uuids":["a1b2c3d4-e5f6-7890-abcd-ef1234567890"]},"id":"paths/~1leads~1api~1companies~1advanced-enrichment/put/requestBody/content/application~1json/example"},"paths/~1leads~1api~1companies~1mass-action/put/requestBody/content/application~1json/example":{"value":{"type":"company_add_tags","filter":{"ids":["a1b2c3d4-e5f6-7890-abcd-ef1234567890"]},"payload":{"tag_uuid":"b2c3d4e5-f6a7-8901-bcde-f12345678901"}},"id":"paths/~1leads~1api~1companies~1mass-action/put/requestBody/content/application~1json/example"},"paths/~1leads~1api~1lists/post/requestBody/content/application~1json/example":{"value":{"name":"CMO Germany"},"id":"paths/~1leads~1api~1lists/post/requestBody/content/application~1json/example"},"paths/~1leads~1api~1lists~1metrics/post/requestBody/content/application~1json/example":{"value":{"uuids":["a1b2c3d4-e5f6-7890-abcd-ef1234567890"]},"id":"paths/~1leads~1api~1lists~1metrics/post/requestBody/content/application~1json/example"},"paths/~1leads~1api~1tags~1metrics/post/requestBody/content/application~1json/example":{"value":{"uuids":["a1b2c3d4-e5f6-7890-abcd-ef1234567890"],"metrics":["leads_count","companies_count"]},"id":"paths/~1leads~1api~1tags~1metrics/post/requestBody/content/application~1json/example"},"paths/~1leads~1api~1custom-field-values/post/requestBody/content/application~1json/example":{"value":{"custom_field_uuid":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","object_type":"lead","object_uuid":"b2c3d4e5-f6a7-8901-bcde-f12345678901","value":"Enterprise"},"id":"paths/~1leads~1api~1custom-field-values/post/requestBody/content/application~1json/example"},"paths/~1leads~1api~1leads-blacklist/post/requestBody/content/application~1json/example":{"value":{"linkedin":"john-doe-123456"},"id":"paths/~1leads~1api~1leads-blacklist/post/requestBody/content/application~1json/example"},"paths/~1leads~1api~1companies-blacklist/post/requestBody/content/application~1json/example":{"value":{"domain":"spammer.com"},"id":"paths/~1leads~1api~1companies-blacklist/post/requestBody/content/application~1json/example"},"paths/~1leads~1api~1data-sources~1metrics/put/requestBody/content/application~1json/example":{"value":{"uuids":["6df2d07d-36dc-4401-81e2-7d6bd5075214"]},"id":"paths/~1leads~1api~1data-sources~1metrics/put/requestBody/content/application~1json/example"},"paths/~1leads~1api~1data-sources~1metrics/put/responses/200/content/application~1json/example":{"value":{"6df2d07d-36dc-4401-81e2-7d6bd5075214":{"queued_records":0,"saved_records":0,"duplicate_records":0,"blacklisted_records":0,"error_records":0}},"id":"paths/~1leads~1api~1data-sources~1metrics/put/responses/200/content/application~1json/example"},"paths/~1leads~1api~1file-imports~1{uuid}~1import-leads/post/requestBody/content/application~1json/example":{"value":{"columns":[{"source":"first_name","target":"first_name"},{"source":"email","target":"email"}],"list_uuid":"5322e0f5-7135-4eb5-b1c4-7805e832fe2f"},"id":"paths/~1leads~1api~1file-imports~1{uuid}~1import-leads/post/requestBody/content/application~1json/example"},"paths/~1leads~1api~1file-imports~1{uuid}~1import-companies/post/requestBody/content/application~1json/example":{"value":{"columns":[{"source":"name","target":"name"},{"source":"domain","target":"domain"}]},"id":"paths/~1leads~1api~1file-imports~1{uuid}~1import-companies/post/requestBody/content/application~1json/example"},"paths/~1leads~1api~1file-exports~1leads/post/requestBody/content/application~1json/example":{"value":{"filter":{"all":true}},"id":"paths/~1leads~1api~1file-exports~1leads/post/requestBody/content/application~1json/example"},"paths/~1leads~1api~1file-exports~1companies/post/requestBody/content/application~1json/example":{"value":{"filter":{"all":true}},"id":"paths/~1leads~1api~1file-exports~1companies/post/requestBody/content/application~1json/example"},"paths/~1flows~1api~1flows/post/requestBody/content/application~1json/example":{"value":{"name":"DACH CTO Outreach","use_sender_schedule":false,"schedule":{"timezone":"Europe/Berlin","use_lead_timezone":false,"timeblocks":[{"dow":1,"min":540,"max":1080},{"dow":2,"min":540,"max":1080},{"dow":3,"min":540,"max":1080},{"dow":4,"min":540,"max":1080},{"dow":5,"min":540,"max":1080}]}},"id":"paths/~1flows~1api~1flows/post/requestBody/content/application~1json/example"},"paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1nodes/post/requestBody/content/application~1json/example":{"value":{"node_ids":[2,3,6]},"id":"paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1nodes/post/requestBody/content/application~1json/example"},"paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1nodes/post/responses/200/content/application~1json/example":{"value":{"2":{"node_statuses":{"closed":3304,"skipped":1286,"canceled":2088,"failed":44,"in_progress":44},"node_conversions":{"accepted":530,"replied":65}},"3":{"node_statuses":{"closed":679,"restarted":1068,"canceled":558,"failed":43,"in_progress":20},"node_conversions":{"replied":42,"opened":199,"blocked":1}}},"id":"paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1nodes/post/responses/200/content/application~1json/example"},"paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1contact-sources/post/requestBody/content/application~1json/example":{"value":{"contact_source_ids":[1,2]},"id":"paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1contact-sources/post/requestBody/content/application~1json/example"},"paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1contact-sources/post/responses/200/content/application~1json/example":{"value":{"1":{"contact_source_statuses":{"restarted":695,"canceled":3042,"failed":64,"finished":274,"in_progress":194},"contact_source_added_by":{"user":3574,"filter":0},"contact_source_conversions":{"linkedin_connection_request":{"sent":1534,"accepted":204},"linkedin_message":{"sent":590,"opened":216,"replied":68,"blocked":1},"email":{"sent":0,"opened":0,"replied":0}}}},"id":"paths/~1flows~1api~1flows~1{flowUuid}~1statistics~1contact-sources/post/responses/200/content/application~1json/example"},"paths/~1flows~1api~1flows-leads~1list/post/requestBody/content/application~1json/example":{"value":{"filter":{"flow_uuid":["3a4ac30b-1321-449c-9b37-e9fe3174e00e"]},"limit":20,"offset":0},"id":"paths/~1flows~1api~1flows-leads~1list/post/requestBody/content/application~1json/example"},"paths/~1flows~1api~1flows~1metrics/post/requestBody/content/application~1json/example":{"value":{"uuids":["e0280f7c-c2e9-4aec-a6bc-bc17ef028740"]},"id":"paths/~1flows~1api~1flows~1metrics/post/requestBody/content/application~1json/example"},"paths/~1flows~1api~1flows~1metrics/post/responses/200/content/application~1json/example":{"value":{"e0280f7c-c2e9-4aec-a6bc-bc17ef028740":{"leads_count":150,"in_progress_leads_count":42,"finished_leads_count":95,"failed_leads_count":13,"task_counts":{"linkedin_send_connection_request":42,"email_send_message":17}}},"id":"paths/~1flows~1api~1flows~1metrics/post/responses/200/content/application~1json/example"},"paths/~1flows~1api~1flows~1{flowUuid}~1add-new-lead/post/requestBody/content/application~1json/example":{"value":{"lead":{"linkedin_id":"john-doe-123456","first_name":"John","last_name":"Doe","company_name":"Acme Inc"},"list_uuid":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","skip_if_lead_exists":true},"id":"paths/~1flows~1api~1flows~1{flowUuid}~1add-new-lead/post/requestBody/content/application~1json/example"},"paths/~1flows~1api~1flows~1{flowUuid}~1flow-versions/post/requestBody/content/application~1json/example":{"value":{"first_common_node_id":null,"contact_sources":[{"id":1,"name":null,"rotation_strategy":"fair","sender_profiles":[],"after_id":3,"mass_actions_filter":null,"filter_tree_format":null}],"nodes":[{"id":3,"before":[],"after":[{"node_id":5,"branch_id":1}],"type":"linkedin_send_connection_request","automation":"auto","payload":{"template":"Hi {{first_name}}, happy to connect!","fallback_send":true,"template_uuid":null},"delay_in_seconds":0,"created_at":"2026-07-05T10:00:00.000000Z","updated_at":"2026-07-05T10:00:00.000000Z"},{"id":5,"before":[{"node_id":3,"branch_id":1}],"after":[{"node_id":1,"branch_id":1}],"type":"linkedin_send_message","automation":"auto","payload":{"template":"Thanks for connecting! ...","attachments":[],"template_uuid":null,"stop_on_reply_level":"always"},"delay_in_seconds":7200,"created_at":"2026-07-05T10:00:00.000000Z","updated_at":"2026-07-05T10:00:00.000000Z"},{"id":1,"before":[{"node_id":5,"branch_id":1}],"after":[],"type":"end","automation":"auto","payload":[],"delay_in_seconds":0,"created_at":"2026-07-05T10:00:00.000000Z","updated_at":"2026-07-05T10:00:00.000000Z"}]},"id":"paths/~1flows~1api~1flows~1{flowUuid}~1flow-versions/post/requestBody/content/application~1json/example"},"paths/~1flows~1api~1flow-versions~1validate-node/post/requestBody/content/application~1json/example":{"value":{"id":1,"before":[],"after":[],"type":"linkedin_send_connection_request","automation":"auto","payload":{"template":"Hi {{first_name}}, happy to connect!","fallback_send":true,"template_uuid":null},"delay_in_seconds":0},"id":"paths/~1flows~1api~1flow-versions~1validate-node/post/requestBody/content/application~1json/example"},"paths/~1flows~1api~1flow-versions~1validate-contact-source/post/requestBody/content/application~1json/example":{"value":{"id":1,"type":"manual","options":{}},"id":"paths/~1flows~1api~1flow-versions~1validate-contact-source/post/requestBody/content/application~1json/example"},"paths/~1flows~1api~1tasks/post/requestBody/content/application~1json/example":{"value":{"lead_uuid":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","sender_profile_uuid":"b2c3d4e5-f6a7-8901-bcde-f12345678901","type":"linkedin_send_message","text":"Hi John, I'd love to connect!","schedule_at":"2026-03-01T10:00:00.000000Z"},"id":"paths/~1flows~1api~1tasks/post/requestBody/content/application~1json/example"},"paths/~1flows~1api~1tasks~1group-counts/post/requestBody/content/application~1json/example":{"value":{"group_field":"flow_uuid","filter":{"type":"linkedin_send_connection_request","status":"closed"}},"id":"paths/~1flows~1api~1tasks~1group-counts/post/requestBody/content/application~1json/example"},"paths/~1flows~1api~1tasks~1group-counts/post/responses/200/content/application~1json/example":{"value":{"8bc693be-acc2-4897-968a-fcd09fa74bd5":870,"f64f42a1-e33c-4c15-988b-2b3b7d803277":5098},"id":"paths/~1flows~1api~1tasks~1group-counts/post/responses/200/content/application~1json/example"},"paths/~1flows~1api~1sender-profiles/post/requestBody/content/application~1json/example":{"value":{"first_name":"John","last_name":"Doe","assignee_user_id":20,"label":"Sales Team - US"},"id":"paths/~1flows~1api~1sender-profiles/post/requestBody/content/application~1json/example"},"paths/~1flows~1api~1ai-agents/post/requestBody/content/application~1json/example":{"value":{"name":"Reply classifier","classification_llm_uuid":"c04fb3e3-a590-49ba-99c5-c270c7beeb08"},"id":"paths/~1flows~1api~1ai-agents/post/requestBody/content/application~1json/example"},"paths/~1flows~1api~1ai-agents~1{uuid}/put/requestBody/content/application~1json/example":{"value":{"name":"Reply classifier (v2)"},"id":"paths/~1flows~1api~1ai-agents~1{uuid}/put/requestBody/content/application~1json/example"},"paths/~1flows~1api~1ai-templates/post/requestBody/content/application~1json/example":{"value":{"name":"Cold outreach — CTO","type":"message","is_public":1,"body":"Hi {{first_name}}, saw you lead engineering at {{company}} — worth a chat?"},"id":"paths/~1flows~1api~1ai-templates/post/requestBody/content/application~1json/example"},"paths/~1flows~1api~1ai-templates~1{uuid}/put/requestBody/content/application~1json/example":{"value":{"name":"Cold outreach v2"},"id":"paths/~1flows~1api~1ai-templates~1{uuid}/put/requestBody/content/application~1json/example"},"paths/~1flows~1api~1ai-templates~1render/post/requestBody/content/application~1json/example":{"value":{"uuid":"ace0258f-c311-4af4-9abd-6b4f4907adc7","lead_uuid":"02dcb6ac-9b15-49f6-8882-fbca91e986ab","sender_profile_uuid":"b290a1be-8131-423d-94eb-8dda4fef0017"},"id":"paths/~1flows~1api~1ai-templates~1render/post/requestBody/content/application~1json/example"},"paths/~1flows~1api~1linkedin-messages/post/requestBody/content/application~1json/example":{"value":{"sender_profile_uuid":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","lead_uuid":"b2c3d4e5-f6a7-8901-bcde-f12345678901","text":"Hi John, here's the deck we discussed.","attachments":[{"uuid":"e94a3b39-1242-4d70-8703-8b600d8960d6"}]},"id":"paths/~1flows~1api~1linkedin-messages/post/requestBody/content/application~1json/example"},"paths/~1flows~1api~1linkedin-messages~1group-counts/post/requestBody/content/application~1json/example":{"value":{"group_field":"sender_profile_uuid","filter":{"type":"inbox"}},"id":"paths/~1flows~1api~1linkedin-messages~1group-counts/post/requestBody/content/application~1json/example"},"paths/~1flows~1api~1linkedin-messages~1group-counts/post/responses/200/content/application~1json/example":{"value":{"e87e2f2e-625c-45cf-a859-6c8c5fb2ae4b":2707,"66b8ead6-55d5-483d-b516-847403026c3e":1840},"id":"paths/~1flows~1api~1linkedin-messages~1group-counts/post/responses/200/content/application~1json/example"},"paths/~1emails~1api~1emails~1send-email/post/requestBody/content/application~1json/example":{"value":{"sender_profile_uuid":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","lead_uuid":"b2c3d4e5-f6a7-8901-bcde-f12345678901","from_name":"John Doe","from_email":"john@company.com","to_name":"Jane Smith","to_email":"jane@acme.com","subject":"Quick question about your outreach stack","body":"<p>Hi Jane, attached is our deck.</p>","attachments":[{"uuid":"e94a3b39-1242-4d70-8703-8b600d8960d6"}]},"id":"paths/~1emails~1api~1emails~1send-email/post/requestBody/content/application~1json/example"},"paths/~1integrations~1api~1webhooks/post/requestBody/content/application~1json/example":{"value":{"name":"New Reply Handler","event":"contact_replied_linkedin_message","request_method":"POST","target_url":"https://hook.eu2.make.com/abc123","status":"on"},"id":"paths/~1integrations~1api~1webhooks/post/requestBody/content/application~1json/example"},"paths/~1integrations~1api~1webhooks~1test/post/requestBody/content/application~1json/example":{"value":{"uuid":"b27f3cfc-84a0-4fb8-956b-91d032f9c523","event":"sender_profile_sent_email","request_method":"POST","target_url":"https://your-endpoint.com/hook"},"id":"paths/~1integrations~1api~1webhooks~1test/post/requestBody/content/application~1json/example"}},"securitySchemeStore":{"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://leadgen.grinfi.io/settings/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings -> API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"servers":[{"url":"https://leadgen.grinfi.io","description":"Production"}]},"options":{"theme":{"colors":{"primary":{"main":"#06a408"}},"sidebar":{"width":"280px"},"typography":{"headings":{"fontFamily":"-apple-system, BlinkMacSystemFont, \"Segoe UI\", Roboto, sans-serif"}}},"generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"Node.js"},{"lang":"JavaScript"},{"lang":"Python"},{"lang":"PHP"}]},"hideTryItPanel":false,"schemaExpansionLevel":2,"showExtensions":false,"sortTagsAlphabetically":false,"sortOperationsAlphabetically":false,"feedback":{"hide":true,"settings":{"label":""}},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi.json?download"},{"url":"/_bundle/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Grinfi.io API","description":"Complete API reference for Grinfi.io — the all-in-one LinkedIn & email outreach platform.\nUse this API to manage your CRM contacts, run outreach automations, send messages, and integrate Grinfi with your own tools.\n\n## Authentication\nAll requests require a Bearer token in the `Authorization` header.\n1. Log in at [leadgen.grinfi.io](https://leadgen.grinfi.io/)\n2. Go to [Settings → API Keys](https://leadgen.grinfi.io/settings/api-keys)\n3. Copy your key and pass it as:\n   ```\n   Authorization: Bearer YOUR_API_KEY\n   ```\n\n\n## Pagination\nList endpoints support `limit` (default 20) and `offset` (default 0) query parameters. Responses include `total` count and `has_more` boolean.\n\n## Filtering\nMost list endpoints accept a `filter` object. Supported value types:\n| Type | Example | SQL equivalent | |------|---------|----------------| | Scalar | `\"status\": \"ok\"` | `= 'ok'` | | Array | `\"status\": [\"ok\", \"pending\"]` | `IN ('ok', 'pending')` | | Object | `\"created_at\": {\">=\": \"2024-01-01\"}` | `>= '2024-01-01'` | | `\"is_null\"` | `\"email\": \"is_null\"` | `IS NULL` | | `\"is_not_null\"` | `\"email\": \"is_not_null\"` | `IS NOT NULL` |\nSupported operators: `=`, `!=`, `<`, `<=`, `>`, `>=`, `<>`\n\n## Rate Limits\nAPI requests are rate-limited to **300 requests per minute** per API key. If you exceed the limit, you'll receive a `429` response. Use exponential backoff when retrying.\n\n## Contact Deduplication\nWhen creating contacts via upsert, the system checks for duplicates using the following field priority (first match wins):\n1. `ln_member_id` (LinkedIn member ID)\n2. `ln_id` (LinkedIn public ID)\n3. `sn_id` (Sales Navigator ID)\n4. LinkedIn nickname\n5. `work_email`\n6. `personal_email`\n7. `name` + `company_name` combination\n"}},"baseSlug":"/openapi","routesMapping":{}}