{"openapi":"3.1.0","info":{"title":"ZYNT API","version":"1.0.0","description":"Read your signals, events, companies and people over HTTP, rate, star, move and assign your signals, add, rate and answer events, add tasks and notes, fill your audiences, change your statuses, excluded companies, notifications and preferences, send your business notes to a setup, and get webhooks when signals arrive or are assigned."},"servers":[{"url":"https://app.getzynt.com"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Create a key in Settings → API keys. It acts as its user in its organization: it reads the signals and events available to them, rates, moves and assigns the signals it can read, adds their tasks, writes the user’s notes, adds events from links, rates events and answers whether the user goes, fills the team’s audiences, changes the user’s own preferences and notifications and the team’s excluded companies, and, for an admin, the team’s statuses. Its webhooks hear of the signals the user can see."}}},"paths":{"/api/v1/audiences":{"get":{"operationId":"listAudiences","summary":"List audiences","description":"Your team’s lists of companies and people, as the app shows them. subject_type says which records a list holds. The Excluded list is not here; /api/v1/exclusions holds it. No paging.","responses":{"200":{"description":"The audiences.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"subject_type":{"enum":["company","person"],"type":"string"},"member_count":{"type":"number"},"from_crm_list":{"type":"boolean"}},"required":["id","name","subject_type","member_count","from_crm_list"],"additionalProperties":false},"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":[{"id":"8b2e4c61-3f9a-4d07-a5c1-6e8d2b4f0a93","name":"Logistics prospects","subject_type":"company","member_count":42,"from_crm_list":false}]}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}},"post":{"operationId":"createAudience","summary":"Make an audience","description":"Makes an empty list of companies or people for the team, as in the app. Only an organization admin can. A team has at most 5 lists of its own; lists imported from your CRM do not count, and a sixth answers 409 audience_limit_reached.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"The list’s name as your team sees it."},"subject_type":{"enum":["company","person"],"type":"string","description":"Whether the list holds companies or people."}},"required":["name","subject_type"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"name":"Trade fair leads","subject_type":"company"}}}},"responses":{"200":{"description":"The new list.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"subject_type":{"enum":["company","person"],"type":"string"},"member_count":{"type":"number"},"from_crm_list":{"type":"boolean"}},"required":["id","name","subject_type","member_count","from_crm_list"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"6a2f9c41-8d3e-4b7a-a915-2c4e8f0b7d63","name":"Trade fair leads","subject_type":"company","member_count":0,"from_crm_list":false}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/audiences/{id}":{"patch":{"operationId":"renameAudience","summary":"Rename an audience","description":"Renames the list for the whole team. Only an organization admin can.","parameters":[{"name":"id","in":"path","required":true,"description":"An audience id from /api/v1/audiences.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"The list’s name as your team sees it."}},"required":["name"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"name":"Trade fair leads 2027"}}}},"responses":{"200":{"description":"The renamed list.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"subject_type":{"enum":["company","person"],"type":"string"},"member_count":{"type":"number"},"from_crm_list":{"type":"boolean"}},"required":["id","name","subject_type","member_count","from_crm_list"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"6a2f9c41-8d3e-4b7a-a915-2c4e8f0b7d63","name":"Trade fair leads 2027","subject_type":"company","member_count":0,"from_crm_list":false}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}},"delete":{"operationId":"deleteAudience","summary":"Delete an audience","description":"Deletes the list for the whole team and cannot be undone. Its companies and people stay in ZYNT; only the list goes. Only an organization admin can. An agent must ask the user and get a clear yes before every deletion, even when told to work without asking.","parameters":[{"name":"id","in":"path","required":true,"description":"An audience id from /api/v1/audiences.","schema":{"type":"string"}}],"responses":{"200":{"description":"The list is gone.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"const":true}},"required":["id","deleted"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"6a2f9c41-8d3e-4b7a-a915-2c4e8f0b7d63","deleted":true}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/audiences/{id}/timeline":{"get":{"operationId":"getAudienceTimeline","summary":"Get a list's timeline","description":"Returns the newest news, articles, LinkedIn posts, comments, reactions, job posts and signals about every company or person on one list, newest first, each with the member it is about. It answers \"any news about my list?\" at once: a source shows as soon as ZYNT finds it, while a signal comes later, after scoring. occurred_at is when ZYNT found the source. One URL comes once for each member; a source about two members comes for each. A company merged into one on the list counts as that company. When your organization has a non-archived signal from the source, signal holds the highest-scored one, with app_url to open it in the ZYNT app. To read another page, send cursor=<next_cursor> from the previous response with the same filters; a null next_cursor marks the end. An unknown id, or another team's list, answers 404.","parameters":[{"name":"id","in":"path","required":true,"description":"An audience id from /api/v1/audiences.","schema":{"type":"string"}},{"name":"period","in":"query","required":false,"description":"Only items ZYNT found in the last 7, 30, 90 or 365 days, or all. Defaults to 7. With nothing in 7 days, ask for 30, then 90.","schema":{"enum":["all","7","30","90","365"],"type":"string","description":"Only items ZYNT found in the last 7, 30, 90 or 365 days, or all. Defaults to 7. With nothing in 7 days, ask for 30, then 90.","default":"7"}},{"name":"cursor","in":"query","required":false,"description":"The next_cursor of the previous page. Omit on the first request.","schema":{"type":"string","description":"The next_cursor of the previous page. Omit on the first request."}},{"name":"limit","in":"query","required":false,"description":"How many timeline items to return, from 1 to 100; 25 when you leave it out. To read more than a few, ask for 100: one page of 100 is one request instead of four.","schema":{"type":"string","description":"How many timeline items to return, from 1 to 100; 25 when you leave it out. To read more than a few, ask for 100: one page of 100 is one request instead of four.","pattern":"^[1-9]\\d*$","default":"25"}}],"responses":{"200":{"description":"A page of the list's timeline.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"member":{"type":"object","properties":{"type":{"enum":["company","person"],"type":"string"},"id":{"type":"string"},"name":{"type":"string"}},"required":["type","id","name"],"additionalProperties":false},"kind":{"enum":["article","news","mention","linkedin_post","comment","reaction","repost","job_post","signal"],"type":"string"},"title":{"type":"string"},"occurred_at":{"type":"string"},"source":{"type":"object","properties":{"label":{"type":"string"},"platform":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"type":"string"}},"required":["label","platform","url"],"additionalProperties":false},"signal":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"score":{"type":"number"},"scenario":{"anyOf":[{"type":"string"},{"type":"null"}]},"app_url":{"type":"string","description":"The signal's page in the ZYNT app; give it when someone asks for a link to the signal."}},"required":["id","score","scenario","app_url"],"additionalProperties":false},{"type":"null"}]}},"required":["id","member","kind","title","occurred_at","source","signal"],"additionalProperties":false}},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","next_cursor"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"data":[{"id":"5b8e2f14-7a3c-4d91-b6e0-2c4f8a1d9e73:7c5a1e3b-9d2f-4a60-b817-3e6c8d0f2a49","member":{"type":"company","id":"7c5a1e3b-9d2f-4a60-b817-3e6c8d0f2a49","name":"Acme Robotics"},"kind":"news","title":"Acme Robotics opens a second plant in Gdańsk","occurred_at":"2026-09-24T08:30:00.000Z","source":{"label":"example.com","platform":null,"url":"https://example.com/news/acme-gdansk-plant"},"signal":{"id":"0f2c1e7a-3b4d-4f6a-8c9e-1d2f3a4b5c6d","score":82,"scenario":"Manufacturing expansion","app_url":"https://app.getzynt.com/signals?signalId=0f2c1e7a-3b4d-4f6a-8c9e-1d2f3a4b5c6d"}}],"next_cursor":null}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/companies":{"post":{"operationId":"createCompanies","summary":"Add companies","description":"The app’s company import: puts up to 100 companies on one of your lists, and adds to ZYNT the ones it does not know yet, so ZYNT starts following them. Each needs a name and a website; ZYNT matches companies by the website and by LinkedIn. Each company gets its own result in the order you sent them; a company ZYNT cannot read comes back invalid with the reason in issue and does not stop the rest.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"audience_id":{"type":"string","minLength":1,"description":"The list to add them to, from /api/v1/audiences. Leave it out for the team’s default list, as the app’s import does."},"companies":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":300,"description":"The company name."},"website_url":{"type":"string","minLength":1,"maxLength":2048,"description":"The company website or domain, e.g. acme.pl. Required: ZYNT matches companies by it."},"linkedin_url":{"type":"string","minLength":1,"maxLength":2048,"description":"The company LinkedIn page."},"tax_id":{"type":"string","minLength":1,"maxLength":64,"description":"The tax id, such as a Polish NIP."}},"required":["name","website_url"],"additionalProperties":false},"minItems":1,"maxItems":100,"description":"1 to 100 companies."}},"required":["companies"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"audience_id":"6a2f9c41-8d3e-4b7a-a915-2c4e8f0b7d63","companies":[{"name":"Nordwave Logistics","website_url":"nordwave-logistics.example","linkedin_url":"https://www.linkedin.com/company/nordwave-logistics"}]}}}},"responses":{"200":{"description":"The list and what happened to each company.","content":{"application/json":{"schema":{"type":"object","properties":{"audience_id":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"index":{"type":"number","description":"The position of the record in your request, from 0."},"outcome":{"enum":["created","existing","already_in_audience","invalid","failed"],"type":"string","description":"created: ZYNT did not know it and added it. existing: ZYNT knew it and put it on the list. already_in_audience: it was on the list. invalid: see issue. failed: ZYNT could not save it; try again."},"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"issue":{"anyOf":[{"enum":["name_required","website_required","first_name_required","last_name_required","linkedin_required","invalid_linkedin","invalid_website","invalid_email"],"type":"string"},{"type":"null"}],"description":"Why ZYNT could not read it, when outcome is invalid: name_required, website_required, first_name_required, last_name_required, linkedin_required, invalid_linkedin, invalid_website, invalid_email. invalid_linkedin and invalid_website mean the link is not a LinkedIn profile or page, or not a website."}},"required":["index","outcome","id","name","issue"],"additionalProperties":false}}},"required":["audience_id","results"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"audience_id":"6a2f9c41-8d3e-4b7a-a915-2c4e8f0b7d63","results":[{"index":0,"outcome":"created","id":"3d8e1a5c-7f2b-4c90-b6e4-9a1d0c5f2e87","name":"Nordwave Logistics","issue":null}]}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/people":{"post":{"operationId":"createPeople","summary":"Add people","description":"The app’s people import: puts up to 100 people on one of your lists, and adds to ZYNT the ones it does not know yet, so ZYNT starts following them. Each needs a first and last name, a LinkedIn profile and an email; ZYNT matches people by LinkedIn and email. Each person gets its own result in the order you sent them; a person ZYNT cannot read comes back invalid with the reason in issue and does not stop the rest.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"audience_id":{"type":"string","minLength":1,"description":"The list to add them to, from /api/v1/audiences. Leave it out for the team’s default list, as the app’s import does."},"people":{"type":"array","items":{"type":"object","properties":{"first_name":{"type":"string","minLength":1,"maxLength":200,"description":"First name."},"last_name":{"type":"string","minLength":1,"maxLength":200,"description":"Last name."},"linkedin_url":{"type":"string","minLength":1,"maxLength":2048,"description":"The person’s LinkedIn profile. Required: ZYNT matches people by it."},"email":{"type":"string","minLength":1,"maxLength":254,"description":"The person’s work email. Required."},"title":{"type":"string","minLength":1,"maxLength":300,"description":"Job title."}},"required":["first_name","last_name","linkedin_url","email"],"additionalProperties":false},"minItems":1,"maxItems":100,"description":"1 to 100 people."}},"required":["people"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"people":[{"first_name":"Marta","last_name":"Wiśniewska","linkedin_url":"https://www.linkedin.com/in/marta-wisniewska-example","email":"marta@nordwave-logistics.example","title":"Head of Operations"}]}}}},"responses":{"200":{"description":"The list and what happened to each person.","content":{"application/json":{"schema":{"type":"object","properties":{"audience_id":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"index":{"type":"number","description":"The position of the record in your request, from 0."},"outcome":{"enum":["created","existing","already_in_audience","invalid","failed"],"type":"string","description":"created: ZYNT did not know it and added it. existing: ZYNT knew it and put it on the list. already_in_audience: it was on the list. invalid: see issue. failed: ZYNT could not save it; try again."},"id":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"issue":{"anyOf":[{"enum":["name_required","website_required","first_name_required","last_name_required","linkedin_required","invalid_linkedin","invalid_website","invalid_email"],"type":"string"},{"type":"null"}],"description":"Why ZYNT could not read it, when outcome is invalid: name_required, website_required, first_name_required, last_name_required, linkedin_required, invalid_linkedin, invalid_website, invalid_email. invalid_linkedin and invalid_website mean the link is not a LinkedIn profile or page, or not a website."}},"required":["index","outcome","id","name","issue"],"additionalProperties":false}}},"required":["audience_id","results"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"audience_id":"legacy-people","results":[{"index":0,"outcome":"existing","id":"8b4f2e6a-1c9d-4a37-95e0-7d3c2b1a6f48","name":"Marta Wiśniewska","issue":null}]}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/people/{id}/contacts":{"get":{"operationId":"getPersonContacts","summary":"Read a person’s email and phone","description":"The emails and phones your team already has for the person in ZYNT. Finding a new one uses credits, so the API does not do it: when your team has none, the answer is 404 and a person must use Find email or Find phone on the person in the app.","parameters":[{"name":"id","in":"path","required":true,"description":"A person id from a signal, a lookup or a search.","schema":{"type":"string"}}],"responses":{"200":{"description":"The emails and phones your team has.","content":{"application/json":{"schema":{"type":"object","properties":{"person_id":{"type":"string"},"contacts":{"type":"array","items":{"type":"object","properties":{"channel":{"enum":["email","phone"],"type":"string"},"value":{"type":"string"},"status":{"type":"string"},"source":{"type":"string"},"verified_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["channel","value","status","source","verified_at"],"additionalProperties":false}}},"required":["person_id","contacts"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"person_id":"8b4f2e6a-1c9d-4a37-95e0-7d3c2b1a6f48","contacts":[{"channel":"email","value":"marta@nordwave-logistics.example","status":"valid","source":"prospeo","verified_at":"2026-10-21T09:12:00.000Z"}]}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/audiences/{id}/members/{record_id}":{"put":{"operationId":"addAudienceMember","summary":"Add a company or person to an audience","description":"Adds a company or person ZYNT already knows to the audience, as the app does. ZYNT makes no new record. Adding one the audience holds changes nothing. A list imported from your CRM takes its members from the CRM again at its next import, so a record added there can leave it.","parameters":[{"name":"id","in":"path","required":true,"description":"An audience id from /api/v1/audiences.","schema":{"type":"string"}},{"name":"record_id","in":"path","required":true,"description":"A company or person id, from a signal, a lookup or a search, of the kind the audience holds.","schema":{"type":"string"}}],"responses":{"200":{"description":"The record and whether the audience holds it now.","content":{"application/json":{"schema":{"type":"object","properties":{"audience_id":{"type":"string"},"record_id":{"type":"string"},"included":{"type":"boolean"}},"required":["audience_id","record_id","included"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"audience_id":"8b2e4c61-3f9a-4d07-a5c1-6e8d2b4f0a93","record_id":"7c5a1e3b-9d2f-4a60-b817-3e6c8d0f2a49","included":true}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}},"delete":{"operationId":"removeAudienceMember","summary":"Remove a company or person from an audience","description":"Takes the record off the audience. A record the audience does not hold answers the same; an id ZYNT does not know answers 404.","parameters":[{"name":"id","in":"path","required":true,"description":"An audience id from /api/v1/audiences.","schema":{"type":"string"}},{"name":"record_id","in":"path","required":true,"description":"A company or person id, from a signal, a lookup or a search, of the kind the audience holds.","schema":{"type":"string"}}],"responses":{"200":{"description":"The record and whether the audience holds it now.","content":{"application/json":{"schema":{"type":"object","properties":{"audience_id":{"type":"string"},"record_id":{"type":"string"},"included":{"type":"boolean"}},"required":["audience_id","record_id","included"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"audience_id":"8b2e4c61-3f9a-4d07-a5c1-6e8d2b4f0a93","record_id":"7c5a1e3b-9d2f-4a60-b817-3e6c8d0f2a49","included":false}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/signals/{id}/notes":{"get":{"operationId":"listSignalNotes","summary":"List a signal’s notes","description":"The notes on the signal that the key’s user can see, newest first: their own, private ones included, and the ones teammates shared. own is true for the user’s own notes; public is false for a private one. Do not post a private note where the team can read it.","parameters":[{"name":"id","in":"path","required":true,"description":"A signal id from /api/v1/signals.","schema":{"type":"string"}}],"responses":{"200":{"description":"The notes.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"public":{"type":"boolean"},"own":{"type":"boolean"},"author_name":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","content","public","own","author_name","created_at","updated_at"],"additionalProperties":false},"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":[{"id":"4f1c8e2a-7b3d-4a69-9e05-2d6b8c1f3a74","content":"Anna wants a demo after their Q4 board meeting.","public":true,"own":true,"author_name":"Ada Lovelace","created_at":"2026-11-09T10:12:00.000Z","updated_at":"2026-11-09T10:12:00.000Z"}]}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}},"post":{"operationId":"createSignalNote","summary":"Add a note to a signal","description":"Adds a note by the key’s user to the signal. It is private unless public is true, as in the app.","parameters":[{"name":"id","in":"path","required":true,"description":"A signal id from /api/v1/signals.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"content":{"type":"string","minLength":1,"maxLength":5000,"description":"The note’s text, 1 to 5000 characters."},"public":{"type":"boolean","description":"true shares the note with the team; false keeps it to its author."}},"required":["content"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"content":"Anna wants a demo after their Q4 board meeting.","public":true}}}},"responses":{"200":{"description":"The new note.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"public":{"type":"boolean"}},"required":["id","content","public"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"4f1c8e2a-7b3d-4a69-9e05-2d6b8c1f3a74","content":"Anna wants a demo after their Q4 board meeting.","public":true}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/signals/{id}/notes/{note_id}":{"patch":{"operationId":"updateSignalNote","summary":"Edit or share a signal note","description":"Changes the text, shares the note with the team or makes it private again. A field you leave out stays as it is. Only the note’s author can change it; anyone else’s note answers 404.","parameters":[{"name":"id","in":"path","required":true,"description":"A signal id from /api/v1/signals.","schema":{"type":"string"}},{"name":"note_id","in":"path","required":true,"description":"An id of your own note, from the record’s notes.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"content":{"type":"string","minLength":1,"maxLength":5000,"description":"The note’s text, 1 to 5000 characters."},"public":{"type":"boolean","description":"true shares the note with the team; false keeps it to its author."}},"required":[],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"public":false}}}},"responses":{"200":{"description":"The note as saved.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"public":{"type":"boolean"}},"required":["id","content","public"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"4f1c8e2a-7b3d-4a69-9e05-2d6b8c1f3a74","content":"Anna wants a demo after their Q4 board meeting.","public":false}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}},"delete":{"operationId":"deleteSignalNote","summary":"Delete a signal note","description":"Removes the note from the record for everyone. Only its author can; anyone else’s note answers 404.","parameters":[{"name":"id","in":"path","required":true,"description":"A signal id from /api/v1/signals.","schema":{"type":"string"}},{"name":"note_id","in":"path","required":true,"description":"An id of your own note, from the record’s notes.","schema":{"type":"string"}}],"responses":{"200":{"description":"The note is gone.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"const":true}},"required":["id","deleted"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"4f1c8e2a-7b3d-4a69-9e05-2d6b8c1f3a74","deleted":true}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/companies/{id}/notes":{"get":{"operationId":"listCompanyNotes","summary":"List a company’s notes","description":"The notes on the company that the key’s user can see, newest first: their own, private ones included, and the ones teammates shared. own is true for the user’s own notes; public is false for a private one. Do not post a private note where the team can read it.","parameters":[{"name":"id","in":"path","required":true,"description":"A company id from a signal, /api/v1/companies/lookup or /search.","schema":{"type":"string"}}],"responses":{"200":{"description":"The notes.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"public":{"type":"boolean"},"own":{"type":"boolean"},"author_name":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","content","public","own","author_name","created_at","updated_at"],"additionalProperties":false},"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":[{"id":"4f1c8e2a-7b3d-4a69-9e05-2d6b8c1f3a74","content":"Anna wants a demo after their Q4 board meeting.","public":true,"own":true,"author_name":"Ada Lovelace","created_at":"2026-11-09T10:12:00.000Z","updated_at":"2026-11-09T10:12:00.000Z"}]}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}},"post":{"operationId":"createCompanyNote","summary":"Add a note to a company","description":"Adds a note by the key’s user to the company. It is private unless public is true, as in the app.","parameters":[{"name":"id","in":"path","required":true,"description":"A company id from a signal, /api/v1/companies/lookup or /search.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"content":{"type":"string","minLength":1,"maxLength":5000,"description":"The note’s text, 1 to 5000 characters."},"public":{"type":"boolean","description":"true shares the note with the team; false keeps it to its author."}},"required":["content"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"content":"Anna wants a demo after their Q4 board meeting.","public":true}}}},"responses":{"200":{"description":"The new note.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"public":{"type":"boolean"}},"required":["id","content","public"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"4f1c8e2a-7b3d-4a69-9e05-2d6b8c1f3a74","content":"Anna wants a demo after their Q4 board meeting.","public":true}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/companies/{id}/notes/{note_id}":{"patch":{"operationId":"updateCompanyNote","summary":"Edit or share a company note","description":"Changes the text, shares the note with the team or makes it private again. A field you leave out stays as it is. Only the note’s author can change it; anyone else’s note answers 404.","parameters":[{"name":"id","in":"path","required":true,"description":"A company id from a signal, /api/v1/companies/lookup or /search.","schema":{"type":"string"}},{"name":"note_id","in":"path","required":true,"description":"An id of your own note, from the record’s notes.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"content":{"type":"string","minLength":1,"maxLength":5000,"description":"The note’s text, 1 to 5000 characters."},"public":{"type":"boolean","description":"true shares the note with the team; false keeps it to its author."}},"required":[],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"public":false}}}},"responses":{"200":{"description":"The note as saved.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"public":{"type":"boolean"}},"required":["id","content","public"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"4f1c8e2a-7b3d-4a69-9e05-2d6b8c1f3a74","content":"Anna wants a demo after their Q4 board meeting.","public":false}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}},"delete":{"operationId":"deleteCompanyNote","summary":"Delete a company note","description":"Removes the note from the record for everyone. Only its author can; anyone else’s note answers 404.","parameters":[{"name":"id","in":"path","required":true,"description":"A company id from a signal, /api/v1/companies/lookup or /search.","schema":{"type":"string"}},{"name":"note_id","in":"path","required":true,"description":"An id of your own note, from the record’s notes.","schema":{"type":"string"}}],"responses":{"200":{"description":"The note is gone.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"const":true}},"required":["id","deleted"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"4f1c8e2a-7b3d-4a69-9e05-2d6b8c1f3a74","deleted":true}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/people/{id}/notes":{"get":{"operationId":"listPersonNotes","summary":"List a person’s notes","description":"The notes on the person that the key’s user can see, newest first: their own, private ones included, and the ones teammates shared. own is true for the user’s own notes; public is false for a private one. Do not post a private note where the team can read it.","parameters":[{"name":"id","in":"path","required":true,"description":"A person id from a signal, /api/v1/people/lookup or /search.","schema":{"type":"string"}}],"responses":{"200":{"description":"The notes.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"public":{"type":"boolean"},"own":{"type":"boolean"},"author_name":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","content","public","own","author_name","created_at","updated_at"],"additionalProperties":false},"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":[{"id":"4f1c8e2a-7b3d-4a69-9e05-2d6b8c1f3a74","content":"Anna wants a demo after their Q4 board meeting.","public":true,"own":true,"author_name":"Ada Lovelace","created_at":"2026-11-09T10:12:00.000Z","updated_at":"2026-11-09T10:12:00.000Z"}]}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}},"post":{"operationId":"createPersonNote","summary":"Add a note to a person","description":"Adds a note by the key’s user to the person. It is private unless public is true, as in the app.","parameters":[{"name":"id","in":"path","required":true,"description":"A person id from a signal, /api/v1/people/lookup or /search.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"content":{"type":"string","minLength":1,"maxLength":5000,"description":"The note’s text, 1 to 5000 characters."},"public":{"type":"boolean","description":"true shares the note with the team; false keeps it to its author."}},"required":["content"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"content":"Anna wants a demo after their Q4 board meeting.","public":true}}}},"responses":{"200":{"description":"The new note.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"public":{"type":"boolean"}},"required":["id","content","public"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"4f1c8e2a-7b3d-4a69-9e05-2d6b8c1f3a74","content":"Anna wants a demo after their Q4 board meeting.","public":true}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/people/{id}/notes/{note_id}":{"patch":{"operationId":"updatePersonNote","summary":"Edit or share a person note","description":"Changes the text, shares the note with the team or makes it private again. A field you leave out stays as it is. Only the note’s author can change it; anyone else’s note answers 404.","parameters":[{"name":"id","in":"path","required":true,"description":"A person id from a signal, /api/v1/people/lookup or /search.","schema":{"type":"string"}},{"name":"note_id","in":"path","required":true,"description":"An id of your own note, from the record’s notes.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"content":{"type":"string","minLength":1,"maxLength":5000,"description":"The note’s text, 1 to 5000 characters."},"public":{"type":"boolean","description":"true shares the note with the team; false keeps it to its author."}},"required":[],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"public":false}}}},"responses":{"200":{"description":"The note as saved.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"public":{"type":"boolean"}},"required":["id","content","public"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"4f1c8e2a-7b3d-4a69-9e05-2d6b8c1f3a74","content":"Anna wants a demo after their Q4 board meeting.","public":false}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}},"delete":{"operationId":"deletePersonNote","summary":"Delete a person note","description":"Removes the note from the record for everyone. Only its author can; anyone else’s note answers 404.","parameters":[{"name":"id","in":"path","required":true,"description":"A person id from a signal, /api/v1/people/lookup or /search.","schema":{"type":"string"}},{"name":"note_id","in":"path","required":true,"description":"An id of your own note, from the record’s notes.","schema":{"type":"string"}}],"responses":{"200":{"description":"The note is gone.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"const":true}},"required":["id","deleted"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"4f1c8e2a-7b3d-4a69-9e05-2d6b8c1f3a74","deleted":true}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/events/{id}/notes":{"get":{"operationId":"listEventNotes","summary":"List a event’s notes","description":"The notes on the event that the key’s user can see, newest first: their own, private ones included, and the ones teammates shared. own is true for the user’s own notes; public is false for a private one. Do not post a private note where the team can read it.","parameters":[{"name":"id","in":"path","required":true,"description":"A event id from /api/v1/events.","schema":{"type":"string"}}],"responses":{"200":{"description":"The notes.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"public":{"type":"boolean"},"own":{"type":"boolean"},"author_name":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","content","public","own","author_name","created_at","updated_at"],"additionalProperties":false},"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":[{"id":"4f1c8e2a-7b3d-4a69-9e05-2d6b8c1f3a74","content":"Anna wants a demo after their Q4 board meeting.","public":true,"own":true,"author_name":"Ada Lovelace","created_at":"2026-11-09T10:12:00.000Z","updated_at":"2026-11-09T10:12:00.000Z"}]}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}},"post":{"operationId":"createEventNote","summary":"Add a note to a event","description":"Adds a note by the key’s user to the event. It is private unless public is true, as in the app.","parameters":[{"name":"id","in":"path","required":true,"description":"A event id from /api/v1/events.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"content":{"type":"string","minLength":1,"maxLength":5000,"description":"The note’s text, 1 to 5000 characters."},"public":{"type":"boolean","description":"true shares the note with the team; false keeps it to its author."}},"required":["content"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"content":"Anna wants a demo after their Q4 board meeting.","public":true}}}},"responses":{"200":{"description":"The new note.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"public":{"type":"boolean"}},"required":["id","content","public"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"4f1c8e2a-7b3d-4a69-9e05-2d6b8c1f3a74","content":"Anna wants a demo after their Q4 board meeting.","public":true}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/events/{id}/notes/{note_id}":{"patch":{"operationId":"updateEventNote","summary":"Edit or share a event note","description":"Changes the text, shares the note with the team or makes it private again. A field you leave out stays as it is. Only the note’s author can change it; anyone else’s note answers 404.","parameters":[{"name":"id","in":"path","required":true,"description":"A event id from /api/v1/events.","schema":{"type":"string"}},{"name":"note_id","in":"path","required":true,"description":"An id of your own note, from the record’s notes.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"content":{"type":"string","minLength":1,"maxLength":5000,"description":"The note’s text, 1 to 5000 characters."},"public":{"type":"boolean","description":"true shares the note with the team; false keeps it to its author."}},"required":[],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"public":false}}}},"responses":{"200":{"description":"The note as saved.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"string"},"public":{"type":"boolean"}},"required":["id","content","public"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"4f1c8e2a-7b3d-4a69-9e05-2d6b8c1f3a74","content":"Anna wants a demo after their Q4 board meeting.","public":false}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}},"delete":{"operationId":"deleteEventNote","summary":"Delete a event note","description":"Removes the note from the record for everyone. Only its author can; anyone else’s note answers 404.","parameters":[{"name":"id","in":"path","required":true,"description":"A event id from /api/v1/events.","schema":{"type":"string"}},{"name":"note_id","in":"path","required":true,"description":"An id of your own note, from the record’s notes.","schema":{"type":"string"}}],"responses":{"200":{"description":"The note is gone.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"const":true}},"required":["id","deleted"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"4f1c8e2a-7b3d-4a69-9e05-2d6b8c1f3a74","deleted":true}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/signals/{id}/tasks":{"get":{"operationId":"listSignalTasks","summary":"List a signal’s tasks","description":"The signal’s tasks in the app’s order. A task id comes from its text: it stays the same when other tasks are added or removed, and changes when the text changes. Tasks with the same text share an id; a change goes to the first of them it alters.","parameters":[{"name":"id","in":"path","required":true,"description":"A signal id from your own list.","schema":{"type":"string"}}],"responses":{"200":{"description":"The tasks.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"done":{"type":"boolean"}},"required":["id","text","done"],"additionalProperties":false},"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":[{"id":"ta2ee81fcd32b344e","text":"Call Anna Nowak about the warehouse rollout","done":false},{"id":"t8273671229fe0894","text":"Send the case study on Gdańsk logistics","done":true}]}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}},"post":{"operationId":"createSignalTask","summary":"Add a task to a signal","description":"Adds a task at the top of the signal’s list, where the app puts the ones a rep adds. Works on market signals too.","parameters":[{"name":"id","in":"path","required":true,"description":"A signal id from your own list.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"type":"string","minLength":1,"maxLength":500,"description":"The task, 1 to 500 characters."}},"required":["text"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"text":"Call Anna Nowak about the warehouse rollout"}}}},"responses":{"200":{"description":"The new task.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"done":{"type":"boolean"}},"required":["id","text","done"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"ta2ee81fcd32b344e","text":"Call Anna Nowak about the warehouse rollout","done":false}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/signals/{id}/tasks/{task_id}":{"patch":{"operationId":"updateSignalTask","summary":"Tick or reword a task","description":"Ticks or unticks the task, rewords it, or both. A field you leave out stays as it is. A new text gives the task a new id, which the answer holds.","parameters":[{"name":"id","in":"path","required":true,"description":"A signal id from your own list.","schema":{"type":"string"}},{"name":"task_id","in":"path","required":true,"description":"A task id from GET /api/v1/signals/{id}/tasks.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"done":{"type":"boolean","description":"true ticks the task, false unticks it."},"text":{"type":"string","minLength":1,"maxLength":500,"description":"The task, 1 to 500 characters."}},"required":[],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"done":true}}}},"responses":{"200":{"description":"The task as saved.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"text":{"type":"string"},"done":{"type":"boolean"}},"required":["id","text","done"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"ta2ee81fcd32b344e","text":"Call Anna Nowak about the warehouse rollout","done":true}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}},"delete":{"operationId":"deleteSignalTask","summary":"Delete a task","description":"Removes the task from the signal. The other tasks keep their ids.","parameters":[{"name":"id","in":"path","required":true,"description":"A signal id from your own list.","schema":{"type":"string"}},{"name":"task_id","in":"path","required":true,"description":"A task id from GET /api/v1/signals/{id}/tasks.","schema":{"type":"string"}}],"responses":{"200":{"description":"The task is gone.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"const":true}},"required":["id","deleted"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"ta2ee81fcd32b344e","deleted":true}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/companies/lookup":{"get":{"operationId":"lookupCompany","summary":"Look up a company","description":"Use this when you already know the company: send its LinkedIn URL or website (with both, the LinkedIn URL is tried first, then the website; a website can be shared, for example a social page saved as a company website, so the LinkedIn URL is the surer key) and get the one company ZYNT knows by it. The company needs no recent activity, and lead search does not need to be on. A company ZYNT has never seen answers 404; ZYNT does not add it. Sending no key answers 422. Add include=signals to get the newest signals in the same call. Use the id with /api/v1/signals?company_id= and /api/v1/companies/{id}/timeline. To find new companies by industry, size or activity, use /api/v1/companies/search.","parameters":[{"name":"linkedin_url","in":"query","required":false,"description":"The company LinkedIn URL, e.g. https://www.linkedin.com/company/acme. Exact match after normalization.","schema":{"type":"string","description":"The company LinkedIn URL, e.g. https://www.linkedin.com/company/acme. Exact match after normalization.","maxLength":2048}},{"name":"website","in":"query","required":false,"description":"The company website or domain, e.g. acme.pl or https://www.acme.pl/about. Matches the host, without www.","schema":{"type":"string","description":"The company website or domain, e.g. acme.pl or https://www.acme.pl/about. Matches the host, without www.","maxLength":2048}},{"name":"include","in":"query","required":false,"description":"signals adds the 10 newest signals about the record that the key owner can see, with next_cursor for /api/v1/signals.","schema":{"enum":["signals"],"type":"string","description":"signals adds the 10 newest signals about the record that the key owner can see, with next_cursor for /api/v1/signals."}}],"responses":{"200":{"description":"The company.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"domain":{"anyOf":[{"type":"string"},{"type":"null"}]},"website_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"linkedin_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"industry":{"anyOf":[{"type":"string"},{"type":"null"}]},"employee_range":{"anyOf":[{"type":"string"},{"type":"null"}]},"location":{"anyOf":[{"type":"string"},{"type":"null"}]},"logo_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_target":{"type":"boolean"},"signals":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"scenario_id":{"type":"string"},"title":{"type":"string"},"score":{"type":"number"},"status":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","name","type"],"additionalProperties":false},{"type":"null"}]},"assignee_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"summary":{"type":"string"},"source_url":{"type":"string"},"image_url":{"type":"string"},"app_url":{"type":"string","description":"The signal's page in the ZYNT app; give it when someone asks for a link to the signal."},"received_at":{"type":"string"},"companies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"website_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"linkedin_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"type":"string"},"is_target":{"type":"boolean"}},"required":["id","name","website_url","linkedin_url","description","is_target"],"additionalProperties":false}},"favorite":{"type":"boolean"}},"additionalProperties":false}},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","next_cursor"],"additionalProperties":false}},"required":["id","name","domain","website_url","linkedin_url","description","industry","employee_range","location","logo_url","is_target"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"7c5a1e3b-9d2f-4a60-b817-3e6c8d0f2a49","name":"Acme Robotics","domain":"acme-robotics.example","website_url":"https://acme-robotics.example","linkedin_url":"https://www.linkedin.com/company/acme-robotics","description":"Warehouse automation robots for European logistics.","industry":"Automation Machinery Manufacturing","employee_range":"51-200","location":"Wrocław, Poland","logo_url":"https://media.example.com/acme-robotics.png","is_target":true,"signals":{"data":[{"id":"0f2c1e7a-3b4d-4f6a-8c9e-1d2f3a4b5c6d","scenario_id":"9a417d2e-6c3b-4f80-a195-7e2d4c6b8a01","title":"Acme Robotics raises €18M to expand warehouse automation","score":97,"status":{"id":"3b7e2c9d-1a5f-4d68-b023-9c7e6a4f2d10","name":"New","type":"todo"},"assignee_id":null,"summary":"Acme Robotics announced a Series A round to grow its European operations.","source_url":"https://news.example.com/acme-robotics-series-a","image_url":"https://news.example.com/favicon.ico","app_url":"https://app.getzynt.com/signals?signalId=0f2c1e7a-3b4d-4f6a-8c9e-1d2f3a4b5c6d","received_at":"2026-09-01T08:14:00.000Z","companies":[{"id":"7c5a1e3b-9d2f-4a60-b817-3e6c8d0f2a49","name":"Acme Robotics","website_url":"https://acme-robotics.example","linkedin_url":null,"description":"","is_target":true}],"favorite":false}],"next_cursor":null}}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/companies/search":{"get":{"operationId":"searchCompanies","summary":"Search companies by recent activity","description":"Use this to find new companies by what happened to them recently. To get one company you already know, use /api/v1/companies/lookup: search only returns companies with an activity in the activity window and misses the rest. Returns companies with an activity in the activity window, newest activity first. Two filters combine with AND; two values in one list combine with OR. Omit activity to match any activity. There is no total. Pass next_cursor as cursor to read another page; null marks the end. A page can hold fewer than limit records, even none, while next_cursor is not null: a rare filter reads the timeline for a few seconds at most per request. A company can come again on a later page with an older activity, so deduplicate by id. Needs lead search; without it the endpoint answers 403 feature_disabled. Example: GET /api/v1/companies/search?activity=job_post,news&activity_days=30&employee_range=11-50,51-200&location=Poland&limit=25.","parameters":[{"name":"exclude_audience_members","in":"query","required":false,"description":"true hides companies already in any audience of the organization. Defaults to false: they are shown.","schema":{"enum":["true","false"],"type":"string","description":"true hides companies already in any audience of the organization. Defaults to false: they are shown.","default":"false"}},{"name":"activity","in":"query","required":false,"description":"Activity kinds to match. Omit, or send all of them, to match any activity. Comma-separated: job_post, news, linkedin_post, article, signal.","schema":{"type":"string","description":"Activity kinds to match. Omit, or send all of them, to match any activity. Comma-separated: job_post, news, linkedin_post, article, signal.","maxLength":200}},{"name":"activity_days","in":"query","required":false,"description":"Match activity ZYNT found in the last N days. Defaults to 7.","schema":{"enum":["7","30","90"],"type":"string","description":"Match activity ZYNT found in the last N days. Defaults to 7.","default":"7"}},{"name":"industry","in":"query","required":false,"description":"Case-insensitive match inside the LinkedIn industry.","schema":{"type":"string","maxLength":200,"description":"Case-insensitive match inside the LinkedIn industry."}},{"name":"employee_range","in":"query","required":false,"description":"Company size bands. Comma-separated: 1-10, 11-50, 51-200, 201-500, 500+.","schema":{"type":"string","description":"Company size bands. Comma-separated: 1-10, 11-50, 51-200, 201-500, 500+.","maxLength":200}},{"name":"location","in":"query","required":false,"description":"Case-insensitive match inside the headquarters location.","schema":{"type":"string","maxLength":200,"description":"Case-insensitive match inside the headquarters location."}},{"name":"name","in":"query","required":false,"description":"Case-insensitive match inside the name or an alias.","schema":{"type":"string","maxLength":200,"description":"Case-insensitive match inside the name or an alias."}},{"name":"website","in":"query","required":false,"description":"Case-insensitive match inside the website, e.g. acme.pl.","schema":{"type":"string","maxLength":200,"description":"Case-insensitive match inside the website, e.g. acme.pl."}},{"name":"linkedin_url","in":"query","required":false,"description":"A full company LinkedIn URL. Exact match after normalization.","schema":{"type":"string","description":"A full company LinkedIn URL. Exact match after normalization.","maxLength":2048}},{"name":"cursor","in":"query","required":false,"description":"The next_cursor of the previous page. Omit on the first request.","schema":{"type":"string","description":"The next_cursor of the previous page. Omit on the first request."}},{"name":"limit","in":"query","required":false,"description":"How many records to return, from 1 to 100; 25 when you leave it out. To read more than a few, ask for 100: one page of 100 is one request instead of four, and fields keeps a big page small.","schema":{"type":"string","description":"How many records to return, from 1 to 100; 25 when you leave it out. To read more than a few, ask for 100: one page of 100 is one request instead of four, and fields keeps a big page small.","pattern":"^[1-9]\\d*$","default":"25"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated fields to return. Omit to return every field. Available fields: id, name, domain, description, industry, employee_range, location, linkedin_url, logo_url, last_activity, audience_ids.","schema":{"type":"string","description":"Comma-separated fields to return. Omit to return every field. Available fields: id, name, domain, description, industry, employee_range, location, linkedin_url, logo_url, last_activity, audience_ids."}}],"responses":{"200":{"description":"A page of matching companies.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"domain":{"type":"string"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"industry":{"anyOf":[{"type":"string"},{"type":"null"}]},"employee_range":{"anyOf":[{"type":"string"},{"type":"null"}]},"location":{"anyOf":[{"type":"string"},{"type":"null"}]},"linkedin_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"logo_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_activity":{"type":"object","properties":{"kind":{"type":"string"},"occurred_at":{"type":"string"},"source_url":{"type":"string"}},"required":["kind","occurred_at","source_url"],"additionalProperties":false},"audience_ids":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","next_cursor"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"data":[{"id":"cmp_123","name":"Acme Sp. z o.o.","domain":"acme.pl","description":"Payments infrastructure for fintech apps","industry":"Software Development","employee_range":"11-50","location":"Warsaw, Poland","linkedin_url":"https://www.linkedin.com/company/acme","logo_url":"https://media.example.com/acme.png","last_activity":{"kind":"job_post","occurred_at":"2026-09-25T10:12:00Z","source_url":"https://jobs.example.com/acme/sales-lead"},"audience_ids":[]}],"next_cursor":"WyIyMDI2LTA5LTI1VDEwOjEyOjAwLjAwMDAwMFoiLCJzcmNfNzg5Il0"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/companies/{id}/timeline":{"get":{"operationId":"getCompanyTimeline","summary":"Get a company's timeline","description":"Returns the sources that mention the company: news, articles, LinkedIn posts, comments, reactions, job posts and signals, newest first unless sort says otherwise. occurred_at is when ZYNT found the source; sort and period use it. The same timeline as the company profile in the app. One URL comes once; case and a trailing slash do not matter. When your organization has a non-archived signal from the source, signal holds the highest-scored one, with app_url to open it in the ZYNT app. To read another page, send cursor=<next_cursor> from the previous response with the same filters; a null next_cursor marks the end. An unknown id answers 404; a known id with nothing that matches the filters returns an empty page.","parameters":[{"name":"id","in":"path","required":true,"description":"A company id from /api/v1/companies/lookup, /api/v1/companies/search or a signal.","schema":{"type":"string"}},{"name":"kind","in":"query","required":false,"description":"Only items of this kind: article, news, mention, linkedin_post, comment, reaction, repost, job_post, signal.","schema":{"enum":["article","news","mention","linkedin_post","comment","reaction","repost","job_post","signal"],"type":"string","description":"Only items of this kind: article, news, mention, linkedin_post, comment, reaction, repost, job_post, signal."}},{"name":"relation","in":"query","required":false,"description":"Only items where the entity is the author, the subject or only mentioned: author, subject, mentioned.","schema":{"enum":["author","subject","mentioned"],"type":"string","description":"Only items where the entity is the author, the subject or only mentioned: author, subject, mentioned."}},{"name":"period","in":"query","required":false,"description":"Only items ZYNT found in the last 7, 30, 90 or 365 days, or all. Defaults to all.","schema":{"enum":["all","7","30","90","365"],"type":"string","description":"Only items ZYNT found in the last 7, 30, 90 or 365 days, or all. Defaults to all.","default":"all"}},{"name":"search","in":"query","required":false,"description":"Case-insensitive match across the source content, evidence, URL and signal title. Blank values do not filter.","schema":{"type":"string","maxLength":200,"description":"Case-insensitive match across the source content, evidence, URL and signal title. Blank values do not filter."}},{"name":"sort","in":"query","required":false,"description":"newest or oldest first. Defaults to newest.","schema":{"enum":["newest","oldest"],"type":"string","description":"newest or oldest first. Defaults to newest.","default":"newest"}},{"name":"cursor","in":"query","required":false,"description":"The next_cursor of the previous page. Omit on the first request.","schema":{"type":"string","description":"The next_cursor of the previous page. Omit on the first request."}},{"name":"limit","in":"query","required":false,"description":"How many timeline items to return, from 1 to 100; 25 when you leave it out. To read more than a few, ask for 100: one page of 100 is one request instead of four.","schema":{"type":"string","description":"How many timeline items to return, from 1 to 100; 25 when you leave it out. To read more than a few, ask for 100: one page of 100 is one request instead of four.","pattern":"^[1-9]\\d*$","default":"25"}}],"responses":{"200":{"description":"A page of the company's timeline.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"enum":["article","news","mention","linkedin_post","comment","reaction","repost","job_post","signal"],"type":"string"},"title":{"type":"string"},"occurred_at":{"type":"string"},"relation":{"enum":["author","subject","mentioned"],"type":"string"},"evidence":{"anyOf":[{"type":"string"},{"type":"null"}]},"source":{"type":"object","properties":{"label":{"type":"string"},"platform":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"type":"string"}},"required":["label","platform","url"],"additionalProperties":false},"signal":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"score":{"type":"number"},"scenario":{"anyOf":[{"type":"string"},{"type":"null"}]},"app_url":{"type":"string","description":"The signal's page in the ZYNT app; give it when someone asks for a link to the signal."}},"required":["id","score","scenario","app_url"],"additionalProperties":false},{"type":"null"}]}},"required":["id","kind","title","occurred_at","relation","evidence","source","signal"],"additionalProperties":false}},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","next_cursor"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"data":[{"id":"5b8e2f14-7a3c-4d91-b6e0-2c4f8a1d9e73","kind":"news","title":"Acme Robotics opens a second plant in Gdańsk","occurred_at":"2026-09-24T08:30:00.000Z","relation":"subject","evidence":"Acme Robotics will open a second plant in Gdańsk next spring.","source":{"label":"example.com","platform":null,"url":"https://example.com/news/acme-gdansk-plant"},"signal":{"id":"0f2c1e7a-3b4d-4f6a-8c9e-1d2f3a4b5c6d","score":82,"scenario":"Manufacturing expansion","app_url":"https://app.getzynt.com/signals?signalId=0f2c1e7a-3b4d-4f6a-8c9e-1d2f3a4b5c6d"}}],"next_cursor":null}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/companies/{id}/employees":{"get":{"operationId":"listCompanyEmployees","summary":"List a company’s employees","description":"The people ZYNT knows who work at the company now, by last name, as the Employees section of the company in the app. People at a company merged into this one count too. is_target is true when the person is on your team’s watchlist (the default people list in Audiences). total counts them all. To read another page, send cursor=<next_cursor>; a null next_cursor marks the end. An unknown id answers 404.","parameters":[{"name":"id","in":"path","required":true,"description":"A company id from /api/v1/companies/lookup, /api/v1/companies/search or a signal.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"Offset returned as next_cursor by the previous page. Omit on the first request. Must be an integer from 0 to 9007199254740991.","schema":{"type":"string","description":"Offset returned as next_cursor by the previous page. Omit on the first request. Must be an integer from 0 to 9007199254740991.","pattern":"^(0|[1-9]\\d*)$"}},{"name":"limit","in":"query","required":false,"description":"How many people to return, from 1 to 100; 25 when you leave it out. To read more than a few, ask for 100: one page of 100 is one request instead of four.","schema":{"type":"string","description":"How many people to return, from 1 to 100; 25 when you leave it out. To read more than a few, ask for 100: one page of 100 is one request instead of four.","pattern":"^[1-9]\\d*$","default":"25"}}],"responses":{"200":{"description":"A page of the company’s employees.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"full_name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"linkedin_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"profile_image_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_target":{"type":"boolean"}},"required":["id","full_name","title","linkedin_url","profile_image_url","is_target"],"additionalProperties":false}},"total":{"type":"number"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","total","next_cursor"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"data":[{"id":"2e9c4b17-6d3a-4f85-9b21-c7a0e5d3f816","full_name":"Anna Nowak","title":"Head of Operations","linkedin_url":"https://www.linkedin.com/in/anna-nowak","profile_image_url":"https://media.example.com/anna.png","is_target":true},{"id":"5b8d2f61-3c9e-4a17-8e40-d1f6a2c7b935","full_name":"Piotr Zieliński","title":"CTO","linkedin_url":"https://www.linkedin.com/in/piotr-zielinski","profile_image_url":null,"is_target":false}],"total":2,"next_cursor":null}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/companies/{id}/relationships":{"get":{"operationId":"listCompanyRelationships","summary":"List a company’s relationships","description":"The companies and people ZYNT found tied to the company in news, posts and profiles, one record each, strongest first unless sort says otherwise, as the Relationships section of the company in the app. relationship is the strongest tie and other_relationships the other ties of the same section: a record with a business tie lists only business ties. direction says who acted when the tie has a direction (outgoing: this company acquired, founded or invested; incoming: the other did) and is null otherwise. status says whether the person and the company are tied by a job ZYNT can confirm from a work history, now (current) or before (former), whatever the tie; it is unconfirmed otherwise and for two companies or two people. evidence holds the quotes and the sources ZYNT read. is_target is true when the record is on your team’s watchlist. ZYNT reads at most 500 facts, business ones and the newest first, and folds them into records; truncated is true when there were more, so total and the list are a preview. To read another page, send cursor=<next_cursor> with the same filters and limit; a null next_cursor marks the end. An unknown id answers 404.","parameters":[{"name":"id","in":"path","required":true,"description":"A company id from /api/v1/companies/lookup, /api/v1/companies/search or a signal.","schema":{"type":"string"}},{"name":"type","in":"query","required":false,"description":"Only companies or only people. Leave it out for both: company, person.","schema":{"enum":["company","person"],"type":"string","description":"Only companies or only people. Leave it out for both: company, person."}},{"name":"section","in":"query","required":false,"description":"business: ties such as works at, founded, invested or partner. possible: only mentioned together, reposted or attended the same event. Leave it out for both: business, possible.","schema":{"enum":["business","possible"],"type":"string","description":"business: ties such as works at, founded, invested or partner. possible: only mentioned together, reposted or attended the same event. Leave it out for both: business, possible."}},{"name":"label","in":"query","required":false,"description":"Only ties with this label, as relationship or other_relationships show it, in any case: Founded, Works at, Board, Acquired, Investment, Partner, Supplier, Competitor, Collaborated, Organiser, Mentioned together, Reposted, Attended. Other types read as their own words.","schema":{"type":"string","description":"Only ties with this label, as relationship or other_relationships show it, in any case: Founded, Works at, Board, Acquired, Investment, Partner, Supplier, Competitor, Collaborated, Organiser, Mentioned together, Reposted, Attended. Other types read as their own words."}},{"name":"search","in":"query","required":false,"description":"Case-insensitive match across the name, subtitle, labels and evidence quotes. Blank values do not filter.","schema":{"type":"string","maxLength":200,"description":"Case-insensitive match across the name, subtitle, labels and evidence quotes. Blank values do not filter."}},{"name":"sort","in":"query","required":false,"description":"strongest: founders, employers and owners first, mentions last. recent: newest evidence first. mentions: most evidence first. Defaults to strongest.","schema":{"enum":["recent","strongest","mentions"],"type":"string","description":"strongest: founders, employers and owners first, mentions last. recent: newest evidence first. mentions: most evidence first. Defaults to strongest.","default":"strongest"}},{"name":"cursor","in":"query","required":false,"description":"Offset returned as next_cursor by the previous page. Omit on the first request. Must be an integer from 0 to 9007199254740991.","schema":{"type":"string","description":"Offset returned as next_cursor by the previous page. Omit on the first request. Must be an integer from 0 to 9007199254740991.","pattern":"^(0|[1-9]\\d*)$"}},{"name":"limit","in":"query","required":false,"description":"How many related companies and people to return, from 1 to 100; 25 when you leave it out. To read more than a few, ask for 100: one page of 100 is one request instead of four.","schema":{"type":"string","description":"How many related companies and people to return, from 1 to 100; 25 when you leave it out. To read more than a few, ask for 100: one page of 100 is one request instead of four.","pattern":"^[1-9]\\d*$","default":"25"}}],"responses":{"200":{"description":"A page of the company’s relationships.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"enum":["company","person"],"type":"string"},"name":{"type":"string"},"subtitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"image_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_target":{"type":"boolean"},"relationship":{"type":"string"},"other_relationships":{"type":"array","items":{"type":"string"}},"section":{"enum":["business","possible"],"type":"string"},"direction":{"anyOf":[{"enum":["incoming","outgoing"],"type":"string"},{"type":"null"}]},"status":{"enum":["current","former","unconfirmed"],"type":"string"},"last_confirmed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"details":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"}]}},"required":["key","value"],"additionalProperties":false}},"evidence":{"type":"array","items":{"type":"object","properties":{"quote":{"type":"string"},"source":{"type":"string"},"url":{"type":"string"},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"confidence":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["quote","source","url","occurred_at","confidence"],"additionalProperties":false}}},"required":["id","type","name","subtitle","image_url","is_target","relationship","other_relationships","section","direction","status","last_confirmed_at","details","evidence"],"additionalProperties":false}},"total":{"type":"number"},"truncated":{"type":"boolean"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","total","truncated","next_cursor"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"data":[{"id":"2e9c4b17-6d3a-4f85-9b21-c7a0e5d3f816","type":"person","name":"Anna Nowak","subtitle":"Head of Operations","image_url":"https://media.example.com/anna.png","is_target":true,"relationship":"Works at","other_relationships":[],"section":"business","direction":null,"status":"current","last_confirmed_at":"2026-10-02T07:40:00.000Z","details":[{"key":"role","value":"Head of Operations"}],"evidence":[{"quote":"Anna Nowak, Head of Operations at Acme Robotics, said the new site opens in March.","source":"logistics-news.example","url":"https://logistics-news.example/acme-robotics-opens-poznan-site","occurred_at":"2026-10-02T07:40:00.000Z","confidence":0.92}]},{"id":"9f3b6c2e-1d48-4a7f-b5e0-2c8d7a1f6e43","type":"company","name":"Nordwave Logistics","subtitle":"Transportation, Logistics · 201-500","image_url":"https://media.example.com/nordwave.png","is_target":false,"relationship":"Partner","other_relationships":["Supplier"],"section":"business","direction":null,"status":"unconfirmed","last_confirmed_at":"2026-10-02T07:40:00.000Z","details":[],"evidence":[{"quote":"Acme Robotics and Nordwave Logistics will run the Poznań site together.","source":"logistics-news.example","url":"https://logistics-news.example/acme-robotics-opens-poznan-site","occurred_at":"2026-10-02T07:40:00.000Z","confidence":0.92}]}],"total":2,"truncated":false,"next_cursor":null}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/events/{id}":{"get":{"operationId":"getEvent","summary":"Get an event","description":"Returns one visible event, including its score breakdown, description, key insights, and nullable topic. This endpoint has no query parameters.","parameters":[{"name":"id","in":"path","required":true,"description":"An event id from /api/v1/events.","schema":{"type":"string"}}],"responses":{"200":{"description":"The event and its score breakdown.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"source_url":{"type":"string"},"website_url":{"type":"string"},"app_url":{"type":"string","description":"The event's page in the ZYNT app; give it when someone asks for a link to the event."},"start_at":{"type":"string"},"end_at":{"type":"string"},"location_name":{"type":"string"},"location_address":{"type":"string"},"city":{"type":"string"},"is_virtual":{"type":"boolean"},"score":{"anyOf":[{"type":"number"},{"type":"null"}]},"score_breakdown":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"icon":{"type":"string"},"explanation":{"type":"string"},"points":{"type":"number"},"max_points":{"type":"number"}},"required":["key","label","icon","points","max_points"],"additionalProperties":false}},"recommendation":{"type":"string","description":"AI-generated next step based on scoring context, or an empty string when unavailable."}},"required":["items","recommendation"],"additionalProperties":false},"watched_participants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"enum":["company","person"],"type":"string"},"name":{"type":"string"},"role":{"enum":["speaker","organizer","sponsor","exhibitor","partner","attendee","speaker_affiliation","influencer","decision_maker","other"],"type":"string"}},"required":["id","type","name","role"],"additionalProperties":false},"description":"Companies and people you watch that take part in the event, matched by LinkedIn, website or email, or for a company by its exact name or a known alias; empty when there are none. id is the company or person id, as in a signal."},"description":{"type":"string"},"key_insights":{"type":"string"},"topic":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","title","source_url","website_url","app_url","start_at","end_at","location_name","location_address","city","is_virtual","score","score_breakdown","watched_participants","description","key_insights","topic"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/events/{id}/participants":{"get":{"operationId":"listEventParticipants","summary":"List who is at an event","description":"Returns the companies (type=company, the default) or the people (type=person) that take part in one visible event: exhibitors, sponsors, partners, speakers, organizers and the companies speakers come from. Watchlist entries come first, then by name. role keeps one role. booth, hall, tier, session and source_url are what the event pages say, null when they say nothing. Pass next_cursor as cursor with the same limit to read another page; null marks the end. Example: GET /api/v1/events/{id}/participants?type=company&role=exhibitor&limit=50.","parameters":[{"name":"id","in":"path","required":true,"description":"An event id from /api/v1/events.","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"Offset returned as next_cursor by the previous page. Omit on the first request. Must be an integer from 0 to 9007199254740991.","schema":{"type":"string","description":"Offset returned as next_cursor by the previous page. Omit on the first request. Must be an integer from 0 to 9007199254740991.","pattern":"^(0|[1-9]\\d*)$"}},{"name":"limit","in":"query","required":false,"description":"How many participants to return, from 1 to 100; 25 when you leave it out. To read more than a few, ask for 100: one page of 100 is one request instead of four.","schema":{"type":"string","description":"How many participants to return, from 1 to 100; 25 when you leave it out. To read more than a few, ask for 100: one page of 100 is one request instead of four.","pattern":"^[1-9]\\d*$","default":"25"}},{"name":"type","in":"query","required":false,"description":"company (the default) or person.","schema":{"enum":["company","person"],"type":"string","description":"company (the default) or person.","default":"company"}},{"name":"role","in":"query","required":false,"description":"Only participants with this role: speaker, organizer, sponsor, exhibitor, partner, attendee, speaker_affiliation, influencer, decision_maker, other. No value keeps every role.","schema":{"enum":["speaker","organizer","sponsor","exhibitor","partner","attendee","speaker_affiliation","influencer","decision_maker","other"],"type":"string","description":"Only participants with this role: speaker, organizer, sponsor, exhibitor, partner, attendee, speaker_affiliation, influencer, decision_maker, other. No value keeps every role."}}],"responses":{"200":{"description":"A page of the event’s participants.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"enum":["company","person"],"type":"string"},"name":{"type":"string"},"role":{"enum":["speaker","organizer","sponsor","exhibitor","partner","attendee","speaker_affiliation","influencer","decision_maker","other"],"type":"string"},"record_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The ZYNT company or person id when the participant is matched to one, as in a signal; null when not."},"on_watchlist":{"type":"boolean"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"company":{"anyOf":[{"type":"string"},{"type":"null"}]},"linkedin_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"website_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"booth":{"anyOf":[{"type":"string"},{"type":"null"}]},"hall":{"anyOf":[{"type":"string"},{"type":"null"}]},"tier":{"anyOf":[{"type":"string"},{"type":"null"}]},"session":{"anyOf":[{"type":"string"},{"type":"null"}]},"session_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"source_url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The page or list the participant was read from."}},"required":["id","type","name","role","record_id","on_watchlist","title","company","linkedin_url","website_url","booth","hall","tier","session","session_at","source_url"],"additionalProperties":false}},"total":{"type":"number","description":"Participants of this type and role at the event."},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","total","next_cursor"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"data":[{"id":"7c1f3a52-9d4e-4b8a-a0c6-3e5f7b9d1a24","type":"company","name":"Northwind Logistics","role":"exhibitor","record_id":"company_123","on_watchlist":true,"title":null,"company":null,"linkedin_url":"https://www.linkedin.com/company/northwind-logistics","website_url":"https://northwind.example","booth":"B12","hall":"Hall 3","tier":null,"session":null,"session_at":null,"source_url":"https://summit.example/exhibitors"}],"total":1,"next_cursor":null}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/events":{"get":{"operationId":"listEvents","summary":"List events","description":"Returns visible events with scores; score is null for an event that is not scored. Search event, venue, and location text with search; combine it with city. watched=true keeps events where a company or person you watch takes part; watched_participants names them. timing=upcoming keeps events that start now or later; sort=highest-score puts the highest score first. Pass next_cursor as cursor to read another page; null marks the end. Keep the same filters on each page and deduplicate by id because changes can shift offsets. All event fields are returned; fields selection is not supported. Example: GET /api/v1/events?timing=upcoming&sort=highest-score&city=Warsaw&limit=25.","parameters":[{"name":"cursor","in":"query","required":false,"description":"Offset returned as next_cursor by the previous page. Omit on the first request. Must be an integer from 0 to 9007199254740991.","schema":{"type":"string","description":"Offset returned as next_cursor by the previous page. Omit on the first request. Must be an integer from 0 to 9007199254740991.","pattern":"^(0|[1-9]\\d*)$"}},{"name":"limit","in":"query","required":false,"description":"How many events to return, from 1 to 100; 25 when you leave it out. To read more than a few, ask for 100: one page of 100 is one request instead of four.","schema":{"type":"string","description":"How many events to return, from 1 to 100; 25 when you leave it out. To read more than a few, ask for 100: one page of 100 is one request instead of four.","pattern":"^[1-9]\\d*$","default":"25"}},{"name":"search","in":"query","required":false,"description":"Case-insensitive match across event name, description, venue, and full location. Blank values do not filter.","schema":{"type":"string","maxLength":200,"description":"Case-insensitive match across event name, description, venue, and full location. Blank values do not filter."}},{"name":"city","in":"query","required":false,"description":"Case-insensitive city match. Combined with search using AND. Blank values do not filter.","schema":{"type":"string","maxLength":200,"description":"Case-insensitive city match. Combined with search using AND. Blank values do not filter."}},{"name":"watched","in":"query","required":false,"description":"true keeps only events where a company or person you watch takes part (watched_participants is not empty); false or no value keeps all. Combined with the other filters using AND.","schema":{"enum":["true","false"],"type":"string","description":"true keeps only events where a company or person you watch takes part (watched_participants is not empty); false or no value keeps all. Combined with the other filters using AND."}},{"name":"timing","in":"query","required":false,"description":"upcoming keeps events that start now or later, past keeps events that started before now, all (the default) keeps both.","schema":{"enum":["all","upcoming","past"],"type":"string","description":"upcoming keeps events that start now or later, past keeps events that started before now, all (the default) keeps both.","default":"all"}},{"name":"sort","in":"query","required":false,"description":"earliest (the default) and latest order by start date; highest-score and lowest-score order by score, where an unscored event counts as 0.","schema":{"enum":["earliest","latest","highest-score","lowest-score"],"type":"string","description":"earliest (the default) and latest order by start date; highest-score and lowest-score order by score, where an unscored event counts as 0.","default":"earliest"}}],"responses":{"200":{"description":"A page of visible events.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"source_url":{"type":"string"},"website_url":{"type":"string"},"app_url":{"type":"string","description":"The event's page in the ZYNT app; give it when someone asks for a link to the event."},"start_at":{"type":"string"},"end_at":{"type":"string"},"location_name":{"type":"string"},"location_address":{"type":"string"},"city":{"type":"string"},"is_virtual":{"type":"boolean"},"score":{"anyOf":[{"type":"number"},{"type":"null"}]},"score_breakdown":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"icon":{"type":"string"},"explanation":{"type":"string"},"points":{"type":"number"},"max_points":{"type":"number"}},"required":["key","label","icon","points","max_points"],"additionalProperties":false}},"recommendation":{"type":"string","description":"AI-generated next step based on scoring context, or an empty string when unavailable."}},"required":["items","recommendation"],"additionalProperties":false},"watched_participants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"enum":["company","person"],"type":"string"},"name":{"type":"string"},"role":{"enum":["speaker","organizer","sponsor","exhibitor","partner","attendee","speaker_affiliation","influencer","decision_maker","other"],"type":"string"}},"required":["id","type","name","role"],"additionalProperties":false},"description":"Companies and people you watch that take part in the event, matched by LinkedIn, website or email, or for a company by its exact name or a known alias; empty when there are none. id is the company or person id, as in a signal."}},"required":["id","title","source_url","website_url","app_url","start_at","end_at","location_name","location_address","city","is_virtual","score","score_breakdown","watched_participants"],"additionalProperties":false}},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","next_cursor"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"data":[{"id":"7c13...","title":"Technology Summit","source_url":"https://example.com/events/technology-summit","website_url":"https://example.com/summit","app_url":"https://app.getzynt.com/events?eventId=7c13...","start_at":"2026-10-15T08:00:00.000Z","end_at":"2026-10-15T16:00:00.000Z","location_name":"Conference Centre","location_address":"Warsaw, Poland","city":"Warsaw","is_virtual":false,"score":74,"score_breakdown":{"items":[{"key":"audience-value","label":"audience-value","icon":"users","points":18,"max_points":20}],"recommendation":"Book a meeting slot with the logistics track speakers."},"watched_participants":[{"id":"company_123","type":"company","name":"Northwind Logistics","role":"exhibitor"}]}],"next_cursor":null}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}},"post":{"operationId":"addEvents","summary":"Add events from links","description":"The app’s “Add event”: send 1 to 25 links to event pages and ZYNT reads each one, scores the event for a scenario and adds it to your events, usually within minutes. The answer says what happens to each link; the event shows in GET /api/v1/events once it is scored. With one scenario you need not name it; with several, send scenario_id, and unknown_scenario lists them.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"urls":{"type":"array","items":{"type":"string","format":"uri"},"minItems":1,"maxItems":25,"description":"1 to 25 http or https links to event pages. ZYNT reads each page, scores the event and adds it to your events, usually within minutes. ZYNT drops tracking parameters and a trailing slash, and sends one link only once, so events in the answer carry the cleaned link."},"scenario_id":{"type":"string","minLength":1,"description":"The scenario the events are for, as scenario_id on a signal. Leave it out when your organization has one scenario."}},"required":["urls"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"urls":["https://logistics-expo.example.com/2027"]}}}},"responses":{"200":{"description":"The scenario and what happens to each link.","content":{"application/json":{"schema":{"type":"object","properties":{"scenario_id":{"type":"string"},"events":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"outcome":{"enum":["queued","requeued","already_scored"],"type":"string","description":"queued: ZYNT will read and score it. requeued: ZYNT tries again after an earlier failure. already_scored: ZYNT already has it."}},"required":["url","outcome"],"additionalProperties":false}}},"required":["scenario_id","events"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"scenario_id":"9a417d2e-6c3b-4f80-a195-7e2d4c6b8a01","events":[{"url":"https://logistics-expo.example.com/2027","outcome":"queued"}]}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/events/{id}/feedback":{"put":{"operationId":"rateEvent","summary":"Rate an event","description":"Sets the event’s rating and comment, the same feedback as in the app, where 1 or 2 stars show as less like this and 3 to 5 as more like this. An event has one rating for the team, so each call replaces the last one.","parameters":[{"name":"id","in":"path","required":true,"description":"An event id from /api/v1/events.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"stars":{"anyOf":[{"type":"integer","minimum":1,"maximum":5},{"type":"null"}],"description":"1 to 5 stars, or null to clear the rating. The app shows 1 or 2 stars as less like this and 3 to 5 as more like this."},"comment":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"description":"Up to 1000 characters. Omit it, or send null or an empty text, for no comment.","default":null}},"required":["stars"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"stars":4,"comment":"Our buyers go there every year"}}}},"responses":{"200":{"description":"The rating as saved. stars and comment are null when not set.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"stars":{"anyOf":[{"type":"number"},{"type":"null"}]},"comment":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","stars","comment"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"7c13...","stars":4,"comment":"Our buyers go there every year"}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/events/{id}/attendance":{"put":{"operationId":"setEventAttendance","summary":"Say whether you go to an event","description":"Saves the key’s user’s answer to “are you going”, as on the event in the app: yes, no or undecided. Each teammate has their own answer; this one changes only the key’s user’s.","parameters":[{"name":"id","in":"path","required":true,"description":"An event id from /api/v1/events.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"decision":{"enum":["yes","no","undecided"],"type":"string","description":"Whether the key’s user goes: yes, no, or undecided. Each teammate has their own answer, as in the app."}},"required":["decision"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"decision":"yes"}}}},"responses":{"200":{"description":"The answer as saved.","content":{"application/json":{"schema":{"type":"object","properties":{"event_id":{"type":"string"},"decision":{"enum":["yes","no","undecided"],"type":"string"}},"required":["event_id","decision"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"event_id":"7c13...","decision":"yes"}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/exclusions":{"get":{"operationId":"listExclusions","summary":"List excluded companies","description":"The companies your team excluded, by name, as Settings → Exclusions lists them. ZYNT shows nobody on the team signals about them. No paging.","responses":{"200":{"description":"The excluded companies.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"company_id":{"type":"string"},"name":{"type":"string"}},"required":["company_id","name"],"additionalProperties":false},"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":[{"company_id":"7c5a1e3b-9d2f-4a60-b817-3e6c8d0f2a49","name":"Acme Robotics"}]}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/exclusions/{company_id}":{"put":{"operationId":"excludeCompany","summary":"Exclude a company","description":"Puts the company on your team’s Excluded list, as Exclude on a signal does: its signals are hidden for everyone at once, and the next research skips it. Excluding a company already on the list changes nothing. Any member of the team can exclude.","parameters":[{"name":"company_id","in":"path","required":true,"description":"A company id from a signal, /api/v1/companies/lookup or /api/v1/companies/search.","schema":{"type":"string"}}],"responses":{"200":{"description":"The company and whether it is excluded now.","content":{"application/json":{"schema":{"type":"object","properties":{"company_id":{"type":"string"},"name":{"type":"string"},"excluded":{"type":"boolean"}},"required":["company_id","name","excluded"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"company_id":"7c5a1e3b-9d2f-4a60-b817-3e6c8d0f2a49","name":"Acme Robotics","excluded":true}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}},"delete":{"operationId":"includeCompany","summary":"Include a company again","description":"Takes the company off the Excluded list, as Include in Settings → Exclusions does: its signals show again. A company not on the list answers the same.","parameters":[{"name":"company_id","in":"path","required":true,"description":"A company id from a signal, /api/v1/companies/lookup or /api/v1/companies/search.","schema":{"type":"string"}}],"responses":{"200":{"description":"The company and whether it is excluded now.","content":{"application/json":{"schema":{"type":"object","properties":{"company_id":{"type":"string"},"name":{"type":"string"},"excluded":{"type":"boolean"}},"required":["company_id","name","excluded"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"company_id":"7c5a1e3b-9d2f-4a60-b817-3e6c8d0f2a49","name":"Acme Robotics","excluded":false}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/health":{"get":{"operationId":"checkHealth","summary":"Check API key access","description":"Validates the API key and its user identity. Requires the same Bearer token as the data endpoints. No query parameters.","responses":{"200":{"description":"The API key was accepted.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"const":"ok","type":"string"}},"required":["status"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"status":"ok"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/members":{"get":{"operationId":"listMembers","summary":"List team members","description":"The members of your organization, as the app’s member pickers list them. Send an email or id from here as assignee to PATCH /api/v1/signals/{id}. No paging.","responses":{"200":{"description":"The team members.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The Clerk user id."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"First and last name, or null when the member has not set one."},"email":{"type":"string"}},"required":["id","name","email"],"additionalProperties":false},"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":[{"id":"user_2nX8kQvB4yLmR7tZ","name":"Anna Kowalska","email":"anna@acme-sales.example"},{"id":"user_2pR4mWcT9hJsK1vD","name":null,"email":"tom@acme-sales.example"}]}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/members/{user_id}":{"patch":{"operationId":"updateMemberRole","summary":"Change a member’s role","description":"Makes a teammate a manager or a member, as Settings → Team does. Only a manager can, and not for themselves.","parameters":[{"name":"user_id","in":"path","required":true,"description":"A user id from /api/v1/members.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"role":{"enum":["manager","member"],"type":"string","description":"manager: changes the team, statuses and settings for everyone. member: works with signals."}},"required":["role"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"role":"manager"}}}},"responses":{"200":{"description":"The member and their role.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"},"role":{"enum":["manager","member"],"type":"string"}},"required":["id","email","role"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"user_2nX8kQvB4yLmR7tZ","email":"anna@acme-sales.example","role":"manager"}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}},"delete":{"operationId":"removeMember","summary":"Remove a member","description":"Takes the person off the team, as Settings → Team does: they lose access to the workspace at once. Their signals, tasks and notes stay. Only a manager can, and not themselves or ZYNT support. An agent must ask the user and get a clear yes before removing anyone.","parameters":[{"name":"user_id","in":"path","required":true,"description":"A user id from /api/v1/members.","schema":{"type":"string"}}],"responses":{"200":{"description":"The member is removed.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"const":true}},"required":["id","deleted"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"user_2nX8kQvB4yLmR7tZ","deleted":true}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/invitations":{"get":{"operationId":"listInvitations","summary":"List open invitations","description":"The invitations to your team nobody has accepted yet, as Settings → Team shows them. Only a manager can read them. No paging.","responses":{"200":{"description":"The open invitations.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"},"role":{"enum":["manager","member"],"type":"string"},"created_at":{"type":"string"}},"required":["id","email","role","created_at"],"additionalProperties":false},"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":[{"id":"orginv_2pT7xQwK9mLzR4bN","email":"ola@acme-sales.example","role":"member","created_at":"2026-11-10T09:30:00.000Z"}]}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}},"post":{"operationId":"inviteMember","summary":"Invite someone to the team","description":"Sends an invitation email, as Settings → Team does. Only a manager can. Invitations count toward the people your plan allows; past the limit the answer is 409 user_limit_reached, and someone already on the team or invited answers 409 already_member. A team sends at most 20 invitations an hour; past that, 429 rate_limited.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"The address ZYNT sends the invitation to."},"role":{"enum":["manager","member"],"type":"string","description":"manager: changes the team, statuses and settings for everyone. member: works with signals."}},"required":["email","role"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"email":"ola@acme-sales.example","role":"member"}}}},"responses":{"200":{"description":"The invitation.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"},"role":{"enum":["manager","member"],"type":"string"},"created_at":{"type":"string"}},"required":["id","email","role","created_at"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"orginv_2pT7xQwK9mLzR4bN","email":"ola@acme-sales.example","role":"member","created_at":"2026-11-10T09:30:00.000Z"}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/invitations/{id}":{"delete":{"operationId":"revokeInvitation","summary":"Revoke an invitation","description":"Takes back an invitation nobody has accepted, as Settings → Team does, so its link stops working. Only a manager can.","parameters":[{"name":"id","in":"path","required":true,"description":"An invitation id from /api/v1/invitations.","schema":{"type":"string"}}],"responses":{"200":{"description":"The invitation is revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"const":true}},"required":["id","deleted"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"orginv_2pT7xQwK9mLzR4bN","deleted":true}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/writing-skills":{"get":{"operationId":"listWritingSkills","summary":"List writing skills","description":"The writing skills the key’s user can use, as Settings → Writing skills shows them: the team’s and their own. A writing skill is a brief ZYNT follows when it writes an outreach message. No paging.","responses":{"200":{"description":"The writing skills.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"body":{"type":"string","description":"How to write, in Markdown."},"visibility":{"enum":["me","team"],"type":"string","description":"me: only its author sees it. team: everyone on the team does."},"is_default":{"type":"boolean","description":"Whether it is the team’s default, used for anyone who picked no other."},"can_edit":{"type":"boolean","description":"Whether the key’s user may change it: their own, or a team skill for an admin."},"is_own":{"type":"boolean","description":"Whether the key’s user wrote it."}},"required":["id","name","body","visibility","is_default","can_edit","is_own"],"additionalProperties":false},"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":[{"id":"2c7e9b14-5a3d-4f81-b0c6-8e1f4d2a9b57","name":"Short and warm","body":"- Three sentences at most.\n- Open with the news from the signal.\n- End with one question, no meeting link.","visibility":"team","is_default":false,"can_edit":true,"is_own":true}]}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}},"post":{"operationId":"createWritingSkill","summary":"Add a writing skill","description":"Adds a writing skill for the key’s user, or for the whole team with visibility team. A workspace keeps up to 50.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":60,"description":"Up to 60 characters."},"body":{"type":"string","minLength":1,"maxLength":8000,"description":"How ZYNT should write, in Markdown, up to 8000 characters: tone, structure, what to mention and avoid."},"visibility":{"enum":["me","team"],"type":"string","description":"me keeps it to the key’s user; team shares it."}},"required":["name","body","visibility"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"name":"Short and warm","body":"- Three sentences at most.\n- Open with the news from the signal.\n- End with one question, no meeting link.","visibility":"team"}}}},"responses":{"200":{"description":"The new skill.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"body":{"type":"string","description":"How to write, in Markdown."},"visibility":{"enum":["me","team"],"type":"string","description":"me: only its author sees it. team: everyone on the team does."},"is_default":{"type":"boolean","description":"Whether it is the team’s default, used for anyone who picked no other."},"can_edit":{"type":"boolean","description":"Whether the key’s user may change it: their own, or a team skill for an admin."},"is_own":{"type":"boolean","description":"Whether the key’s user wrote it."}},"required":["id","name","body","visibility","is_default","can_edit","is_own"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"2c7e9b14-5a3d-4f81-b0c6-8e1f4d2a9b57","name":"Short and warm","body":"- Three sentences at most.\n- Open with the news from the signal.\n- End with one question, no meeting link.","visibility":"team","is_default":false,"can_edit":true,"is_own":true}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/writing-skills/{id}":{"patch":{"operationId":"updateWritingSkill","summary":"Change a writing skill","description":"Changes the fields you send; the rest stay as they are. The key’s user changes their own skills, and an admin the team’s too. Only a skill’s author changes its visibility.","parameters":[{"name":"id","in":"path","required":true,"description":"A writing skill id from /api/v1/writing-skills.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":60,"description":"Up to 60 characters."},"body":{"type":"string","minLength":1,"maxLength":8000,"description":"How ZYNT should write, in Markdown, up to 8000 characters: tone, structure, what to mention and avoid."},"visibility":{"enum":["me","team"],"type":"string","description":"me keeps it to the key’s user; team shares it."}},"required":[],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"name":"Short, warm, Polish"}}}},"responses":{"200":{"description":"The skill as saved.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"body":{"type":"string","description":"How to write, in Markdown."},"visibility":{"enum":["me","team"],"type":"string","description":"me: only its author sees it. team: everyone on the team does."},"is_default":{"type":"boolean","description":"Whether it is the team’s default, used for anyone who picked no other."},"can_edit":{"type":"boolean","description":"Whether the key’s user may change it: their own, or a team skill for an admin."},"is_own":{"type":"boolean","description":"Whether the key’s user wrote it."}},"required":["id","name","body","visibility","is_default","can_edit","is_own"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"2c7e9b14-5a3d-4f81-b0c6-8e1f4d2a9b57","name":"Short, warm, Polish","body":"- Three sentences at most.\n- Open with the news from the signal.\n- End with one question, no meeting link.","visibility":"team","is_default":false,"can_edit":true,"is_own":true}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}},"delete":{"operationId":"deleteWritingSkill","summary":"Delete a writing skill","description":"Deletes the skill; it cannot be undone. When it was the team’s default, ZYNT writes its own way again until someone picks another.","parameters":[{"name":"id","in":"path","required":true,"description":"A writing skill id from /api/v1/writing-skills.","schema":{"type":"string"}}],"responses":{"200":{"description":"The skill is gone.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"const":true}},"required":["id","deleted"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"2c7e9b14-5a3d-4f81-b0c6-8e1f4d2a9b57","deleted":true}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/writing-skills/default":{"put":{"operationId":"setDefaultWritingSkill","summary":"Pick the team’s default writing skill","description":"Picks the team skill ZYNT follows for anyone who has not picked another, or null for ZYNT’s own way. Only an organization admin can. Answers with every skill, as GET /api/v1/writing-skills does.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"description":"A team skill’s id, or null for ZYNT’s own way of writing."}},"required":["id"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"2c7e9b14-5a3d-4f81-b0c6-8e1f4d2a9b57"}}}},"responses":{"200":{"description":"The skills, with the new default.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"body":{"type":"string","description":"How to write, in Markdown."},"visibility":{"enum":["me","team"],"type":"string","description":"me: only its author sees it. team: everyone on the team does."},"is_default":{"type":"boolean","description":"Whether it is the team’s default, used for anyone who picked no other."},"can_edit":{"type":"boolean","description":"Whether the key’s user may change it: their own, or a team skill for an admin."},"is_own":{"type":"boolean","description":"Whether the key’s user wrote it."}},"required":["id","name","body","visibility","is_default","can_edit","is_own"],"additionalProperties":false},"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":[{"id":"2c7e9b14-5a3d-4f81-b0c6-8e1f4d2a9b57","name":"Short and warm","body":"- Three sentences at most.\n- Open with the news from the signal.\n- End with one question, no meeting link.","visibility":"team","is_default":true,"can_edit":true,"is_own":true}]}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/api-keys":{"get":{"operationId":"listApiKeys","summary":"List your API keys","description":"The working keys of the key’s user, as Settings → API lists them, without their secrets. No paging.","responses":{"200":{"description":"The keys.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"created_at":{"type":"string"},"last_used_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","created_at","last_used_at"],"additionalProperties":false},"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":[{"id":"ak_2qH8vNcR5tYwK3mP","name":"Slack signal bot","created_at":"2026-11-10T09:30:00.000Z","last_used_at":null}]}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}},"post":{"operationId":"createApiKey","summary":"Make an API key","description":"Makes a new key for the key’s user, with the same access. It ends after expires_in_days, at most 90 and never after the key that makes it; a key that never ends is made in Settings → API. A user keeps at most 20 working keys; past that, 409 api_key_limit_reached. The answer carries secret, the key itself, and ZYNT never shows it again, so store it at once.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"description":"A name that says where the key is used, up to 100 characters."},"expires_in_days":{"type":"integer","minimum":1,"maximum":90,"description":"The key stops working after this many days, 1 to 90, and never after the key that makes it. A key that never expires is made in Settings → API."}},"required":["name","expires_in_days"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"name":"Slack signal bot","expires_in_days":30}}}},"responses":{"200":{"description":"The key with its secret.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"created_at":{"type":"string"},"last_used_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"secret":{"type":"string","description":"The key itself. ZYNT shows it only now; keep it somewhere safe."}},"required":["id","name","created_at","last_used_at","secret"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"ak_2qH8vNcR5tYwK3mP","name":"Slack signal bot","created_at":"2026-11-10T09:30:00.000Z","last_used_at":null,"secret":"ak_live_example_shown_once"}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/api-keys/{id}":{"delete":{"operationId":"revokeApiKey","summary":"Revoke an API key","description":"Turns one of the key’s user’s keys off for good, as Settings → API does; every tool using it stops at once. Revoking the key that sends this request works too, and it is the last request that key makes. An agent must ask the user before revoking a key.","parameters":[{"name":"id","in":"path","required":true,"description":"A key id from /api/v1/api-keys.","schema":{"type":"string"}}],"responses":{"200":{"description":"The key is revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"const":true}},"required":["id","deleted"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"ak_2qH8vNcR5tYwK3mP","deleted":true}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/me/notifications":{"get":{"operationId":"getNotificationSettings","summary":"Get your notification settings","description":"The key’s user’s settings from Settings → Notifications: the digest email, and a rule per notification type for the inbox, an email at once and the digest. scenarios lists the scenarios the user can see and set apart from the rules, each with its own rules.","responses":{"200":{"description":"The notification settings.","content":{"application/json":{"schema":{"type":"object","properties":{"email_opt_out":{"type":"boolean","description":"No email from ZYNT at all, whatever the rules say."},"digest_enabled":{"type":"boolean","description":"Send the digest email."},"digest_frequency":{"enum":["daily","weekly"],"type":"string","description":"daily or weekly."},"digest_include_weekends":{"type":"boolean","description":"Send the daily digest on Saturday and Sunday too."},"digest_time":{"type":"string"},"time_zone":{"type":"string"},"rules":{"type":"object","properties":{"new_signal":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":["in_app","email","digest","minimum_score"],"additionalProperties":false},"assigned_signal":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":["in_app","email","digest","minimum_score"],"additionalProperties":false},"signal_status":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":["in_app","email","digest","minimum_score"],"additionalProperties":false},"event_status":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":["in_app","email","digest","minimum_score"],"additionalProperties":false},"new_event":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":["in_app","email","digest","minimum_score"],"additionalProperties":false},"watched_event":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":["in_app","email","digest","minimum_score"],"additionalProperties":false},"event_scoring_failed":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":["in_app","email","digest","minimum_score"],"additionalProperties":false}},"required":["new_signal","assigned_signal","signal_status","event_status","new_event","watched_event","event_scoring_failed"],"additionalProperties":false},"scenarios":{"type":"array","items":{"type":"object","properties":{"scenario_id":{"type":"string"},"rules":{"type":"object","properties":{"new_signal":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":["in_app","email","digest","minimum_score"],"additionalProperties":false},"assigned_signal":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":["in_app","email","digest","minimum_score"],"additionalProperties":false},"signal_status":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":["in_app","email","digest","minimum_score"],"additionalProperties":false},"event_status":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":["in_app","email","digest","minimum_score"],"additionalProperties":false},"new_event":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":["in_app","email","digest","minimum_score"],"additionalProperties":false},"watched_event":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":["in_app","email","digest","minimum_score"],"additionalProperties":false},"event_scoring_failed":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":["in_app","email","digest","minimum_score"],"additionalProperties":false}},"required":["new_signal","assigned_signal","signal_status","event_status","new_event","watched_event","event_scoring_failed"],"additionalProperties":false}},"required":["scenario_id","rules"],"additionalProperties":false}}},"required":["email_opt_out","digest_enabled","digest_frequency","digest_include_weekends","digest_time","time_zone","rules","scenarios"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"email_opt_out":false,"digest_enabled":true,"digest_frequency":"daily","digest_include_weekends":false,"digest_time":"09:00","time_zone":"Europe/Warsaw","rules":{"new_signal":{"in_app":false,"email":false,"digest":true,"minimum_score":70},"assigned_signal":{"in_app":true,"email":false,"digest":false,"minimum_score":0},"signal_status":{"in_app":true,"email":false,"digest":false,"minimum_score":0},"event_status":{"in_app":true,"email":false,"digest":false,"minimum_score":0},"new_event":{"in_app":false,"email":false,"digest":false,"minimum_score":0},"watched_event":{"in_app":false,"email":false,"digest":false,"minimum_score":0},"event_scoring_failed":{"in_app":true,"email":false,"digest":false,"minimum_score":0}},"scenarios":[]}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}},"patch":{"operationId":"updateNotificationSettings","summary":"Change your notification settings","description":"Changes the fields you send for the key’s user only; the rest stay as they are. In rules, send only the types and fields you change. Scenario overrides cannot be changed here and stay as they are. A change made meanwhile in the app is kept.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email_opt_out":{"type":"boolean","description":"No email from ZYNT at all, whatever the rules say."},"digest_enabled":{"type":"boolean","description":"Send the digest email."},"digest_frequency":{"enum":["daily","weekly"],"type":"string","description":"daily or weekly."},"digest_include_weekends":{"type":"boolean","description":"Send the daily digest on Saturday and Sunday too."},"digest_time":{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","description":"When the digest goes out, as HH:MM in time_zone."},"time_zone":{"type":"string","description":"An IANA time zone, for example Europe/Warsaw."},"rules":{"type":"object","properties":{"new_signal":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":[],"additionalProperties":false},"assigned_signal":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":[],"additionalProperties":false},"signal_status":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":[],"additionalProperties":false},"event_status":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":[],"additionalProperties":false},"new_event":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":[],"additionalProperties":false},"watched_event":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":[],"additionalProperties":false},"event_scoring_failed":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":[],"additionalProperties":false}},"required":[],"additionalProperties":false,"description":"Rules by notification type (new_signal, assigned_signal, signal_status, event_status, new_event, watched_event, event_scoring_failed), each with in_app, email, digest and minimum_score. Send only the types and fields you change; the rest stay as they are."}},"required":[],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"digest_time":"08:30","rules":{"new_signal":{"minimum_score":80}}}}}},"responses":{"200":{"description":"All notification settings, as saved.","content":{"application/json":{"schema":{"type":"object","properties":{"email_opt_out":{"type":"boolean","description":"No email from ZYNT at all, whatever the rules say."},"digest_enabled":{"type":"boolean","description":"Send the digest email."},"digest_frequency":{"enum":["daily","weekly"],"type":"string","description":"daily or weekly."},"digest_include_weekends":{"type":"boolean","description":"Send the daily digest on Saturday and Sunday too."},"digest_time":{"type":"string"},"time_zone":{"type":"string"},"rules":{"type":"object","properties":{"new_signal":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":["in_app","email","digest","minimum_score"],"additionalProperties":false},"assigned_signal":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":["in_app","email","digest","minimum_score"],"additionalProperties":false},"signal_status":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":["in_app","email","digest","minimum_score"],"additionalProperties":false},"event_status":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":["in_app","email","digest","minimum_score"],"additionalProperties":false},"new_event":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":["in_app","email","digest","minimum_score"],"additionalProperties":false},"watched_event":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":["in_app","email","digest","minimum_score"],"additionalProperties":false},"event_scoring_failed":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":["in_app","email","digest","minimum_score"],"additionalProperties":false}},"required":["new_signal","assigned_signal","signal_status","event_status","new_event","watched_event","event_scoring_failed"],"additionalProperties":false},"scenarios":{"type":"array","items":{"type":"object","properties":{"scenario_id":{"type":"string"},"rules":{"type":"object","properties":{"new_signal":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":["in_app","email","digest","minimum_score"],"additionalProperties":false},"assigned_signal":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":["in_app","email","digest","minimum_score"],"additionalProperties":false},"signal_status":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":["in_app","email","digest","minimum_score"],"additionalProperties":false},"event_status":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":["in_app","email","digest","minimum_score"],"additionalProperties":false},"new_event":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":["in_app","email","digest","minimum_score"],"additionalProperties":false},"watched_event":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":["in_app","email","digest","minimum_score"],"additionalProperties":false},"event_scoring_failed":{"type":"object","properties":{"in_app":{"type":"boolean","description":"Show it in the ZYNT inbox."},"email":{"type":"boolean","description":"Send an email at once."},"digest":{"type":"boolean","description":"Add it to the digest email."},"minimum_score":{"type":"number","minimum":0,"maximum":100,"description":"For new_signal only: signals below this score, 0 to 100, are not notified. The other types ignore it."}},"required":["in_app","email","digest","minimum_score"],"additionalProperties":false}},"required":["new_signal","assigned_signal","signal_status","event_status","new_event","watched_event","event_scoring_failed"],"additionalProperties":false}},"required":["scenario_id","rules"],"additionalProperties":false}}},"required":["email_opt_out","digest_enabled","digest_frequency","digest_include_weekends","digest_time","time_zone","rules","scenarios"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"email_opt_out":false,"digest_enabled":true,"digest_frequency":"daily","digest_include_weekends":false,"digest_time":"08:30","time_zone":"Europe/Warsaw","rules":{"new_signal":{"in_app":false,"email":false,"digest":true,"minimum_score":80},"assigned_signal":{"in_app":true,"email":false,"digest":false,"minimum_score":0},"signal_status":{"in_app":true,"email":false,"digest":false,"minimum_score":0},"event_status":{"in_app":true,"email":false,"digest":false,"minimum_score":0},"new_event":{"in_app":false,"email":false,"digest":false,"minimum_score":0},"watched_event":{"in_app":false,"email":false,"digest":false,"minimum_score":0},"event_scoring_failed":{"in_app":true,"email":false,"digest":false,"minimum_score":0}},"scenarios":[]}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/people/lookup":{"get":{"operationId":"lookupPerson","summary":"Look up a person","description":"Use this when you already know the person: send their LinkedIn URL and get the one person ZYNT knows by it. The person needs no recent activity, and lead search does not need to be on. A person ZYNT has never seen answers 404; ZYNT does not add it. Sending no key answers 422. Add include=signals to get the newest signals in the same call. Use the id with /api/v1/signals?person_id= and /api/v1/people/{id}/timeline. To find new people by title, employer or activity, use /api/v1/people/search.","parameters":[{"name":"linkedin_url","in":"query","required":false,"description":"The person LinkedIn URL, e.g. https://www.linkedin.com/in/anna-nowak. Exact match after normalization.","schema":{"type":"string","description":"The person LinkedIn URL, e.g. https://www.linkedin.com/in/anna-nowak. Exact match after normalization.","maxLength":2048}},{"name":"include","in":"query","required":false,"description":"signals adds the 10 newest signals about the record that the key owner can see, with next_cursor for /api/v1/signals.","schema":{"enum":["signals"],"type":"string","description":"signals adds the 10 newest signals about the record that the key owner can see, with next_cursor for /api/v1/signals."}}],"responses":{"200":{"description":"The person.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"full_name":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"headline":{"anyOf":[{"type":"string"},{"type":"null"}]},"location":{"anyOf":[{"type":"string"},{"type":"null"}]},"linkedin_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"profile_image_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"company":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"website_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"linkedin_url":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","website_url","linkedin_url"],"additionalProperties":false},{"type":"null"}]},"is_target":{"type":"boolean"},"signals":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"scenario_id":{"type":"string"},"title":{"type":"string"},"score":{"type":"number"},"status":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","name","type"],"additionalProperties":false},{"type":"null"}]},"assignee_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"summary":{"type":"string"},"source_url":{"type":"string"},"image_url":{"type":"string"},"app_url":{"type":"string","description":"The signal's page in the ZYNT app; give it when someone asks for a link to the signal."},"received_at":{"type":"string"},"companies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"website_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"linkedin_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"type":"string"},"is_target":{"type":"boolean"}},"required":["id","name","website_url","linkedin_url","description","is_target"],"additionalProperties":false}},"favorite":{"type":"boolean"}},"additionalProperties":false}},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","next_cursor"],"additionalProperties":false}},"required":["id","full_name","title","headline","location","linkedin_url","profile_image_url","company","is_target"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"2e9c4b17-6d3a-4f85-9b21-c7a0e5d3f816","full_name":"Anna Nowak","title":"Head of Operations","headline":"Head of Operations at Acme Robotics","location":"Wrocław, Poland","linkedin_url":"https://www.linkedin.com/in/anna-nowak","profile_image_url":"https://media.example.com/anna.png","company":{"id":"7c5a1e3b-9d2f-4a60-b817-3e6c8d0f2a49","name":"Acme Robotics","website_url":"https://acme-robotics.example","linkedin_url":"https://www.linkedin.com/company/acme-robotics"},"is_target":true}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/people/search":{"get":{"operationId":"searchPeople","summary":"Search people by recent activity","description":"Use this to find new people by what happened to them recently. To get one person you already know, use /api/v1/people/lookup: search only returns people with an activity in the activity window and misses the rest. Returns people with an activity in the activity window, newest activity first. Two filters combine with AND; two values in one list combine with OR. A person with no current company appears unless an employer filter is set. company is null for a person with no current company. No email and no phone. There is no total. Pass next_cursor as cursor to read another page; null marks the end. A page can hold fewer than limit records, even none, while next_cursor is not null: a rare filter reads the timeline for a few seconds at most per request. A person can come again on a later page with an older activity, so deduplicate by id. Needs lead search; without it the endpoint answers 403 feature_disabled. Example: GET /api/v1/people/search?job_title=head of sales,sales director&employer_employee_range=51-200,201-500&activity_days=30.","parameters":[{"name":"exclude_audience_members","in":"query","required":false,"description":"true hides people already in any audience of the organization. Defaults to false: they are shown.","schema":{"enum":["true","false"],"type":"string","description":"true hides people already in any audience of the organization. Defaults to false: they are shown.","default":"false"}},{"name":"activity","in":"query","required":false,"description":"Activity kinds to match. Omit, or send all of them, to match any activity. Comma-separated: linkedin_post, comment, repost, news, signal.","schema":{"type":"string","description":"Activity kinds to match. Omit, or send all of them, to match any activity. Comma-separated: linkedin_post, comment, repost, news, signal.","maxLength":200}},{"name":"activity_days","in":"query","required":false,"description":"Match activity ZYNT found in the last N days. Defaults to 7.","schema":{"enum":["7","30","90"],"type":"string","description":"Match activity ZYNT found in the last N days. Defaults to 7.","default":"7"}},{"name":"job_title","in":"query","required":false,"description":"Comma-separated job titles, at most 50. Each one is a case-insensitive match inside the current title.","schema":{"type":"string","description":"Comma-separated job titles, at most 50. Each one is a case-insensitive match inside the current title.","maxLength":10050}},{"name":"location","in":"query","required":false,"description":"Case-insensitive match inside the LinkedIn location.","schema":{"type":"string","maxLength":200,"description":"Case-insensitive match inside the LinkedIn location."}},{"name":"employer","in":"query","required":false,"description":"Case-insensitive match inside the current employer name.","schema":{"type":"string","maxLength":200,"description":"Case-insensitive match inside the current employer name."}},{"name":"employer_employee_range","in":"query","required":false,"description":"Size bands of the current employer. Comma-separated: 1-10, 11-50, 51-200, 201-500, 500+.","schema":{"type":"string","description":"Size bands of the current employer. Comma-separated: 1-10, 11-50, 51-200, 201-500, 500+.","maxLength":200}},{"name":"employer_industry","in":"query","required":false,"description":"Case-insensitive match inside the LinkedIn industry of the current employer.","schema":{"type":"string","maxLength":200,"description":"Case-insensitive match inside the LinkedIn industry of the current employer."}},{"name":"name","in":"query","required":false,"description":"Case-insensitive match inside the full name or an alias.","schema":{"type":"string","maxLength":200,"description":"Case-insensitive match inside the full name or an alias."}},{"name":"linkedin_url","in":"query","required":false,"description":"A full person LinkedIn URL. Exact match after normalization.","schema":{"type":"string","description":"A full person LinkedIn URL. Exact match after normalization.","maxLength":2048}},{"name":"cursor","in":"query","required":false,"description":"The next_cursor of the previous page. Omit on the first request.","schema":{"type":"string","description":"The next_cursor of the previous page. Omit on the first request."}},{"name":"limit","in":"query","required":false,"description":"How many records to return, from 1 to 100; 25 when you leave it out. To read more than a few, ask for 100: one page of 100 is one request instead of four, and fields keeps a big page small.","schema":{"type":"string","description":"How many records to return, from 1 to 100; 25 when you leave it out. To read more than a few, ask for 100: one page of 100 is one request instead of four, and fields keeps a big page small.","pattern":"^[1-9]\\d*$","default":"25"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated fields to return. Omit to return every field. Available fields: id, full_name, company, title, location, linkedin_url, profile_image_url, last_activity, audience_ids.","schema":{"type":"string","description":"Comma-separated fields to return. Omit to return every field. Available fields: id, full_name, company, title, location, linkedin_url, profile_image_url, last_activity, audience_ids."}}],"responses":{"200":{"description":"A page of matching people.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"full_name":{"type":"string"},"company":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false},{"type":"null"}]},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"location":{"anyOf":[{"type":"string"},{"type":"null"}]},"linkedin_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"profile_image_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_activity":{"type":"object","properties":{"kind":{"type":"string"},"occurred_at":{"type":"string"},"source_url":{"type":"string"}},"required":["kind","occurred_at","source_url"],"additionalProperties":false},"audience_ids":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","next_cursor"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"data":[{"id":"per_456","full_name":"Anna Nowak","company":{"id":"cmp_123","name":"Acme Sp. z o.o."},"title":"Head of Sales","location":"Warsaw, Poland","linkedin_url":"https://www.linkedin.com/in/anna-nowak","profile_image_url":"https://media.example.com/anna.png","last_activity":{"kind":"linkedin_post","occurred_at":"2026-09-24T08:30:00Z","source_url":"https://www.linkedin.com/posts/anna-nowak_activity"},"audience_ids":[]}],"next_cursor":null}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/people/{id}/timeline":{"get":{"operationId":"getPersonTimeline","summary":"Get a person's timeline","description":"Returns the sources that mention the person: news, articles, LinkedIn posts, comments, reactions, job posts and signals, newest first unless sort says otherwise. occurred_at is when ZYNT found the source; sort and period use it. The same timeline as the person profile in the app. One URL comes once; case and a trailing slash do not matter. When your organization has a non-archived signal from the source, signal holds the highest-scored one, with app_url to open it in the ZYNT app. To read another page, send cursor=<next_cursor> from the previous response with the same filters; a null next_cursor marks the end. An unknown id answers 404; a known id with nothing that matches the filters returns an empty page.","parameters":[{"name":"id","in":"path","required":true,"description":"A person id from /api/v1/people/lookup, /api/v1/people/search or a signal.","schema":{"type":"string"}},{"name":"kind","in":"query","required":false,"description":"Only items of this kind: article, news, mention, linkedin_post, comment, reaction, repost, job_post, signal.","schema":{"enum":["article","news","mention","linkedin_post","comment","reaction","repost","job_post","signal"],"type":"string","description":"Only items of this kind: article, news, mention, linkedin_post, comment, reaction, repost, job_post, signal."}},{"name":"relation","in":"query","required":false,"description":"Only items where the entity is the author, the subject or only mentioned: author, subject, mentioned.","schema":{"enum":["author","subject","mentioned"],"type":"string","description":"Only items where the entity is the author, the subject or only mentioned: author, subject, mentioned."}},{"name":"period","in":"query","required":false,"description":"Only items ZYNT found in the last 7, 30, 90 or 365 days, or all. Defaults to all.","schema":{"enum":["all","7","30","90","365"],"type":"string","description":"Only items ZYNT found in the last 7, 30, 90 or 365 days, or all. Defaults to all.","default":"all"}},{"name":"search","in":"query","required":false,"description":"Case-insensitive match across the source content, evidence, URL and signal title. Blank values do not filter.","schema":{"type":"string","maxLength":200,"description":"Case-insensitive match across the source content, evidence, URL and signal title. Blank values do not filter."}},{"name":"sort","in":"query","required":false,"description":"newest or oldest first. Defaults to newest.","schema":{"enum":["newest","oldest"],"type":"string","description":"newest or oldest first. Defaults to newest.","default":"newest"}},{"name":"cursor","in":"query","required":false,"description":"The next_cursor of the previous page. Omit on the first request.","schema":{"type":"string","description":"The next_cursor of the previous page. Omit on the first request."}},{"name":"limit","in":"query","required":false,"description":"How many timeline items to return, from 1 to 100; 25 when you leave it out. To read more than a few, ask for 100: one page of 100 is one request instead of four.","schema":{"type":"string","description":"How many timeline items to return, from 1 to 100; 25 when you leave it out. To read more than a few, ask for 100: one page of 100 is one request instead of four.","pattern":"^[1-9]\\d*$","default":"25"}}],"responses":{"200":{"description":"A page of the person's timeline.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"enum":["article","news","mention","linkedin_post","comment","reaction","repost","job_post","signal"],"type":"string"},"title":{"type":"string"},"occurred_at":{"type":"string"},"relation":{"enum":["author","subject","mentioned"],"type":"string"},"evidence":{"anyOf":[{"type":"string"},{"type":"null"}]},"source":{"type":"object","properties":{"label":{"type":"string"},"platform":{"anyOf":[{"type":"string"},{"type":"null"}]},"url":{"type":"string"}},"required":["label","platform","url"],"additionalProperties":false},"signal":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"score":{"type":"number"},"scenario":{"anyOf":[{"type":"string"},{"type":"null"}]},"app_url":{"type":"string","description":"The signal's page in the ZYNT app; give it when someone asks for a link to the signal."}},"required":["id","score","scenario","app_url"],"additionalProperties":false},{"type":"null"}]}},"required":["id","kind","title","occurred_at","relation","evidence","source","signal"],"additionalProperties":false}},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","next_cursor"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"data":[{"id":"5b8e2f14-7a3c-4d91-b6e0-2c4f8a1d9e73","kind":"news","title":"Acme Robotics opens a second plant in Gdańsk","occurred_at":"2026-09-24T08:30:00.000Z","relation":"subject","evidence":"Acme Robotics will open a second plant in Gdańsk next spring.","source":{"label":"example.com","platform":null,"url":"https://example.com/news/acme-gdansk-plant"},"signal":{"id":"0f2c1e7a-3b4d-4f6a-8c9e-1d2f3a4b5c6d","score":82,"scenario":"Manufacturing expansion","app_url":"https://app.getzynt.com/signals?signalId=0f2c1e7a-3b4d-4f6a-8c9e-1d2f3a4b5c6d"}}],"next_cursor":null}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/people/{id}/relationships":{"get":{"operationId":"listPersonRelationships","summary":"List a person’s relationships","description":"The companies and people ZYNT found tied to the person in news, posts and profiles, one record each, strongest first unless sort says otherwise, as the Relationships section of the person in the app. relationship is the strongest tie and other_relationships the other ties of the same section: a record with a business tie lists only business ties. direction says who acted when the tie has a direction (outgoing: this person acquired, founded or invested; incoming: the other did) and is null otherwise. status says whether the person and the company are tied by a job ZYNT can confirm from a work history, now (current) or before (former), whatever the tie; it is unconfirmed otherwise and for two companies or two people. evidence holds the quotes and the sources ZYNT read. is_target is true when the record is on your team’s watchlist. ZYNT reads at most 500 facts, business ones and the newest first, and folds them into records; truncated is true when there were more, so total and the list are a preview. To read another page, send cursor=<next_cursor> with the same filters and limit; a null next_cursor marks the end. An unknown id answers 404.","parameters":[{"name":"id","in":"path","required":true,"description":"A person id from /api/v1/people/lookup, /api/v1/people/search, a signal or a company’s employees.","schema":{"type":"string"}},{"name":"type","in":"query","required":false,"description":"Only companies or only people. Leave it out for both: company, person.","schema":{"enum":["company","person"],"type":"string","description":"Only companies or only people. Leave it out for both: company, person."}},{"name":"section","in":"query","required":false,"description":"business: ties such as works at, founded, invested or partner. possible: only mentioned together, reposted or attended the same event. Leave it out for both: business, possible.","schema":{"enum":["business","possible"],"type":"string","description":"business: ties such as works at, founded, invested or partner. possible: only mentioned together, reposted or attended the same event. Leave it out for both: business, possible."}},{"name":"label","in":"query","required":false,"description":"Only ties with this label, as relationship or other_relationships show it, in any case: Founded, Works at, Board, Acquired, Investment, Partner, Supplier, Competitor, Collaborated, Organiser, Mentioned together, Reposted, Attended. Other types read as their own words.","schema":{"type":"string","description":"Only ties with this label, as relationship or other_relationships show it, in any case: Founded, Works at, Board, Acquired, Investment, Partner, Supplier, Competitor, Collaborated, Organiser, Mentioned together, Reposted, Attended. Other types read as their own words."}},{"name":"search","in":"query","required":false,"description":"Case-insensitive match across the name, subtitle, labels and evidence quotes. Blank values do not filter.","schema":{"type":"string","maxLength":200,"description":"Case-insensitive match across the name, subtitle, labels and evidence quotes. Blank values do not filter."}},{"name":"sort","in":"query","required":false,"description":"strongest: founders, employers and owners first, mentions last. recent: newest evidence first. mentions: most evidence first. Defaults to strongest.","schema":{"enum":["recent","strongest","mentions"],"type":"string","description":"strongest: founders, employers and owners first, mentions last. recent: newest evidence first. mentions: most evidence first. Defaults to strongest.","default":"strongest"}},{"name":"cursor","in":"query","required":false,"description":"Offset returned as next_cursor by the previous page. Omit on the first request. Must be an integer from 0 to 9007199254740991.","schema":{"type":"string","description":"Offset returned as next_cursor by the previous page. Omit on the first request. Must be an integer from 0 to 9007199254740991.","pattern":"^(0|[1-9]\\d*)$"}},{"name":"limit","in":"query","required":false,"description":"How many related companies and people to return, from 1 to 100; 25 when you leave it out. To read more than a few, ask for 100: one page of 100 is one request instead of four.","schema":{"type":"string","description":"How many related companies and people to return, from 1 to 100; 25 when you leave it out. To read more than a few, ask for 100: one page of 100 is one request instead of four.","pattern":"^[1-9]\\d*$","default":"25"}}],"responses":{"200":{"description":"A page of the person’s relationships.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"enum":["company","person"],"type":"string"},"name":{"type":"string"},"subtitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"image_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"is_target":{"type":"boolean"},"relationship":{"type":"string"},"other_relationships":{"type":"array","items":{"type":"string"}},"section":{"enum":["business","possible"],"type":"string"},"direction":{"anyOf":[{"enum":["incoming","outgoing"],"type":"string"},{"type":"null"}]},"status":{"enum":["current","former","unconfirmed"],"type":"string"},"last_confirmed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"details":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"}]}},"required":["key","value"],"additionalProperties":false}},"evidence":{"type":"array","items":{"type":"object","properties":{"quote":{"type":"string"},"source":{"type":"string"},"url":{"type":"string"},"occurred_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"confidence":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["quote","source","url","occurred_at","confidence"],"additionalProperties":false}}},"required":["id","type","name","subtitle","image_url","is_target","relationship","other_relationships","section","direction","status","last_confirmed_at","details","evidence"],"additionalProperties":false}},"total":{"type":"number"},"truncated":{"type":"boolean"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","total","truncated","next_cursor"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"data":[{"id":"7c5a1e3b-9d2f-4a60-b817-3e6c8d0f2a49","type":"company","name":"Acme Robotics","subtitle":"Automation Machinery Manufacturing · 51-200","image_url":"https://media.example.com/acme-robotics.png","is_target":true,"relationship":"Works at","other_relationships":[],"section":"business","direction":null,"status":"current","last_confirmed_at":"2026-10-02T07:40:00.000Z","details":[{"key":"role","value":"Head of Operations"}],"evidence":[{"quote":"Anna Nowak, Head of Operations at Acme Robotics, said the new site opens in March.","source":"logistics-news.example","url":"https://logistics-news.example/acme-robotics-opens-poznan-site","occurred_at":"2026-10-02T07:40:00.000Z","confidence":0.92}]}],"total":1,"truncated":false,"next_cursor":null}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/me/preferences":{"get":{"operationId":"getPreferences","summary":"Get your preferences","description":"The key’s user’s own settings from Settings → Signal ownership and Settings → Preferences: when signals become theirs, and the instructions ZYNT follows in the outreach messages it writes for them.","responses":{"200":{"description":"The preferences.","content":{"application/json":{"schema":{"type":"object","properties":{"assign_on_rating":{"type":"boolean","description":"Assign signals I want more of: rating a signal nobody owns 3 stars or more assigns it to the user."},"assign_on_status_change":{"type":"boolean","description":"Assign signals I move: moving a signal nobody owns past to-do assigns it to the user."},"assign_override":{"type":"boolean","description":"Take over from the current owner: with assign_on_rating or assign_on_status_change on, rating or moving a signal takes it from its current owner."},"assign_crm_clients":{"type":"boolean","description":"Assign signals about my clients and deals: new signals about companies and contacts the user owns in the CRM, clients or in a deal, are theirs."},"outreach_instructions":{"type":"string"}},"required":["assign_on_rating","assign_on_status_change","assign_override","assign_crm_clients","outreach_instructions"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"assign_on_rating":true,"assign_on_status_change":false,"assign_override":false,"assign_crm_clients":true,"outreach_instructions":"Write casually and use first names. No emojis. Sign off as Ada from Acme."}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}},"patch":{"operationId":"updatePreferences","summary":"Change your preferences","description":"Changes the fields you send for the key’s user only; the rest stay as they are. The app shows the change at once.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"assign_on_rating":{"type":"boolean","description":"Assign signals I want more of: rating a signal nobody owns 3 stars or more assigns it to the user."},"assign_on_status_change":{"type":"boolean","description":"Assign signals I move: moving a signal nobody owns past to-do assigns it to the user."},"assign_override":{"type":"boolean","description":"Take over from the current owner: with assign_on_rating or assign_on_status_change on, rating or moving a signal takes it from its current owner."},"assign_crm_clients":{"type":"boolean","description":"Assign signals about my clients and deals: new signals about companies and contacts the user owns in the CRM, clients or in a deal, are theirs."},"outreach_instructions":{"type":"string","maxLength":2000,"description":"Up to 2000 characters ZYNT follows in every outreach message it writes for the user: tone, what to mention, what to avoid, how to sign off. An empty text clears them."}},"required":[],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"assign_on_status_change":true}}}},"responses":{"200":{"description":"All preferences, as saved.","content":{"application/json":{"schema":{"type":"object","properties":{"assign_on_rating":{"type":"boolean","description":"Assign signals I want more of: rating a signal nobody owns 3 stars or more assigns it to the user."},"assign_on_status_change":{"type":"boolean","description":"Assign signals I move: moving a signal nobody owns past to-do assigns it to the user."},"assign_override":{"type":"boolean","description":"Take over from the current owner: with assign_on_rating or assign_on_status_change on, rating or moving a signal takes it from its current owner."},"assign_crm_clients":{"type":"boolean","description":"Assign signals about my clients and deals: new signals about companies and contacts the user owns in the CRM, clients or in a deal, are theirs."},"outreach_instructions":{"type":"string"}},"required":["assign_on_rating","assign_on_status_change","assign_override","assign_crm_clients","outreach_instructions"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"assign_on_rating":true,"assign_on_status_change":true,"assign_override":false,"assign_crm_clients":true,"outreach_instructions":"Write casually and use first names. No emojis. Sign off as Ada from Acme."}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/setup":{"get":{"operationId":"getSetup","summary":"Read the setup","description":"The setup chat the key’s user has open, as an agent goes through it for them: what ZYNT said since the last answer (its question last), the answers it takes now and what each means, the answers to tap, what ZYNT knows, and next: the one thing to do now. Steps run in order: company (website, what you sell, LinkedIn, phone), customers (questions about who buys, signals to rate, the list of signals), summary (the user confirms what ZYNT understood), connect (companies to follow, tools only the user connects, colleagues to invite), done. With no setup open, 409 no_open_setup says why.","responses":{"200":{"description":"The setup as it is now.","content":{"application/json":{"schema":{"type":"object","properties":{"revision":{"type":"number"},"step":{"enum":["company","customers","summary","connect","done"],"type":"string"},"zynt_said":{"type":"array","items":{"type":"string"}},"answers":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"means":{"type":"string"}},"required":["kind","means"],"additionalProperties":false}},"suggestions":{"type":"array","items":{"type":"string"}},"signal":{"type":"object","properties":{"title":{"type":"string"},"summary":{"type":"string"},"source_url":{"type":"string"},"date":{"type":"string"}},"required":["title","summary","source_url","date"],"additionalProperties":false},"signal_list":{"type":"object","properties":{"recommended":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"scenario":{"type":"string"}},"required":["id","scenario"],"additionalProperties":false}},"ask_competitors":{"type":"boolean"},"competitor_signal_ids":{"type":"array","items":{"type":"string"}},"catalog":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}},"required":["id","name","description"],"additionalProperties":false}}},"required":["recommended","ask_competitors","competitor_signal_ids","catalog"],"additionalProperties":false},"summary":{"type":"object","properties":{"topics":{"type":"array","items":{"type":"object","properties":{"topic":{"type":"string"},"text":{"anyOf":[{"type":"string"},{"type":"null"}]},"draft":{"type":"boolean"}},"required":["topic","text"],"additionalProperties":false}},"exclude":{"type":"array","items":{"type":"string"}},"unknown":{"type":"array","items":{"type":"string"}}},"required":["topics","exclude","unknown"],"additionalProperties":false},"companies_audience_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"knows":{"type":"array","items":{"type":"object","properties":{"topic":{"type":"string"},"text":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["topic","text"],"additionalProperties":false}},"topics_left":{"anyOf":[{"type":"number"},{"type":"null"}]},"setup_url":{"type":"string"},"next":{"type":"string"}},"required":["revision","step","zynt_said","answers","suggestions","knows","topics_left","setup_url","next"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"revision":7,"step":"customers","zynt_said":["Which markets do you sell to? Name the countries in the order you go after them."],"answers":[{"kind":"text","means":"The answer to ZYNT’s question, in the user’s words."},{"kind":"skip","means":"The user does not know; ZYNT asks something else."}],"suggestions":["Poland","Germany","Czechia"],"knows":[{"topic":"Offer","text":"Route planning software for mid-size carriers"}],"topics_left":4,"setup_url":"https://app.getzynt.com/start","next":"Answer ZYNT with one of answers. Use what you know from the user’s files and notes; ask the user only what you cannot find. Then read the next question in the reply."}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/setup/answer":{"post":{"operationId":"answerSetup","summary":"Answer the setup","description":"Answers the setup chat for the key’s user, as they would in the app: one of the answers GET /api/v1/setup lists now, to the revision you read. The app shows the answer as sent by their AI agent. A yes on the summary confirms what ZYNT understood and starts the watching, so show the summary to the user first. The reply is the setup after the answer, with its next question. An answer it does not take now is 400 unknown_answer, with the ones it takes in allowed; a setup that moved on since you read it is 409 setup_changed. The first answer, the website, takes up to a minute: ZYNT reads the site and looks for the first signals.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"revision":{"type":"integer","minimum":0,"description":"The revision of the setup you read: the answer goes to the question you saw, never to a newer one."},"answer":{"oneOf":[{"type":"object","properties":{"kind":{"const":"text"},"text":{"type":"string","minLength":1,"maxLength":8000}},"required":["kind","text"],"additionalProperties":false},{"type":"object","properties":{"kind":{"const":"yes"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"const":"no"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"const":"skip"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"const":"finish"}},"required":["kind"],"additionalProperties":false},{"type":"object","properties":{"kind":{"const":"rate"},"useful":{"type":"boolean"},"why":{"type":"string","minLength":1,"maxLength":8000}},"required":["kind","useful"],"additionalProperties":false},{"type":"object","properties":{"kind":{"const":"signals"},"signals":{"type":"array","items":{"enum":["rekrutacja-head-c-level","skalowanie-zespolu","nowa-funkcja-w-firmie","rekrutacja-polska","technologia-w-ogloszeniu","nowy-decydent","luka-po-odejsciu","champion-zmienil-firme","nowy-zarzad","runda-finansowania","inwestycja-w-infrastrukture","dotacje-i-programy-publiczne","debiut-lub-emisja-na-gieldzie","wejscie-na-nowy-rynek","nowy-produkt-lub-usluga","nowe-biuro-lub-oddzial","partnerstwo-lub-duzy-kontrakt","przejecie-lub-fuzja","sukcesja-w-firmie-rodzinnej","wejscie-funduszu","rebranding","migracja-systemu","zmiana-na-stronie-firmy","frustracja-obecnym-narzedziem","incydent-lub-awaria","przygotowanie-do-regulacji","certyfikacja","decyzja-urzedu","wystawcy-i-prelegenci","uczestnictwo-decydentow","kalendarz-branzy","problem-ktory-rozwiazujesz","zapowiedz-planow","prosba-o-rekomendacje","niezadowolony-klient-konkurencji","klopoty-konkurenta","zmiana-u-konkurenta","restrukturyzacja","nowa-strategia","wyniki-ponizej-oczekiwan","frazy-zakupowe","przetargi","trend-w-branzy","alternatywa-dla-konkurenta","wzmianki-o-twojej-marce"],"type":"string"},"minItems":1,"maxItems":45},"competitors":{"type":"string","minLength":1,"maxLength":8000}},"required":["kind","signals"],"additionalProperties":false},{"type":"object","properties":{"kind":{"const":"invite"},"emails":{"type":"array","items":{"type":"string","format":"email"},"minItems":1,"maxItems":10}},"required":["kind","emails"],"additionalProperties":false}],"description":"One of the answers the setup lists now, such as {\"kind\":\"text\",\"text\":\"acme.com\"} or {\"kind\":\"yes\"}."}},"required":["revision","answer"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"revision":7,"answer":{"kind":"text","text":"Poland first, then Germany"}}}}},"responses":{"200":{"description":"The setup after the answer.","content":{"application/json":{"schema":{"type":"object","properties":{"revision":{"type":"number"},"step":{"enum":["company","customers","summary","connect","done"],"type":"string"},"zynt_said":{"type":"array","items":{"type":"string"}},"answers":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string"},"means":{"type":"string"}},"required":["kind","means"],"additionalProperties":false}},"suggestions":{"type":"array","items":{"type":"string"}},"signal":{"type":"object","properties":{"title":{"type":"string"},"summary":{"type":"string"},"source_url":{"type":"string"},"date":{"type":"string"}},"required":["title","summary","source_url","date"],"additionalProperties":false},"signal_list":{"type":"object","properties":{"recommended":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"scenario":{"type":"string"}},"required":["id","scenario"],"additionalProperties":false}},"ask_competitors":{"type":"boolean"},"competitor_signal_ids":{"type":"array","items":{"type":"string"}},"catalog":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}},"required":["id","name","description"],"additionalProperties":false}}},"required":["recommended","ask_competitors","competitor_signal_ids","catalog"],"additionalProperties":false},"summary":{"type":"object","properties":{"topics":{"type":"array","items":{"type":"object","properties":{"topic":{"type":"string"},"text":{"anyOf":[{"type":"string"},{"type":"null"}]},"draft":{"type":"boolean"}},"required":["topic","text"],"additionalProperties":false}},"exclude":{"type":"array","items":{"type":"string"}},"unknown":{"type":"array","items":{"type":"string"}}},"required":["topics","exclude","unknown"],"additionalProperties":false},"companies_audience_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"knows":{"type":"array","items":{"type":"object","properties":{"topic":{"type":"string"},"text":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["topic","text"],"additionalProperties":false}},"topics_left":{"anyOf":[{"type":"number"},{"type":"null"}]},"setup_url":{"type":"string"},"next":{"type":"string"}},"required":["revision","step","zynt_said","answers","suggestions","knows","topics_left","setup_url","next"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"revision":7,"step":"customers","zynt_said":["Which markets do you sell to? Name the countries in the order you go after them."],"answers":[{"kind":"text","means":"The answer to ZYNT’s question, in the user’s words."},{"kind":"skip","means":"The user does not know; ZYNT asks something else."}],"suggestions":["Poland","Germany","Czechia"],"knows":[{"topic":"Offer","text":"Route planning software for mid-size carriers"}],"topics_left":4,"setup_url":"https://app.getzynt.com/start","next":"Answer ZYNT with one of answers. Use what you know from the user’s files and notes; ask the user only what you cannot find. Then read the next question in the reply."}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/setup/context":{"post":{"operationId":"addSetupContext","summary":"Send business notes to the setup","description":"Sends what the user’s AI assistant knows about their business, as files (strategy and customer documents, context summaries, the customer list), to the setup the key’s user has open in ZYNT: their sign-up, or a scenario they add in Settings → Business. ZYNT reads each file once and adds the facts it states as guesses; current customers become companies to exclude. The user confirms the guesses in the setup chat at setup_url: the key never confirms them. ZYNT keeps the files and never returns their text. The answer counts the files, the guesses added and the files it could not read, and lists the topics the guesses are about. Reading takes up to a minute.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"files":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200,"description":"What the file is, such as its file name: strategy.md. 1 to 200 characters."},"path":{"type":"string","minLength":1,"maxLength":500,"description":"Where the file lives in the brain or the agent’s memory, such as brain/contexts/icp/context.md. Optional."},"content":{"type":"string","minLength":1,"maxLength":30000,"description":"The file’s text, 1 to 30000 characters. Markdown or plain text."}},"required":["name","content"],"additionalProperties":false},"minItems":1,"maxItems":10,"description":"The files to read, 1 to 10, and 20 for one setup in all: strategy and customer documents, context summaries, the customer list."}},"required":["files"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"files":[{"name":"context.md","path":"brain/contexts/icp/context.md","content":"## Who buys\n- Heads of logistics at mid-size carriers (customer interviews)\n\n## Markets\n- Poland first, then Germany (strategy.md)"}]}}}},"responses":{"200":{"description":"What ZYNT read and where the user confirms it.","content":{"application/json":{"schema":{"type":"object","properties":{"files":{"type":"number"},"facts":{"type":"number"},"unread":{"type":"number"},"topics":{"type":"array","items":{"enum":["offer","markets","buyers","good-customer-signs","why-they-win","why-they-lose","bad-customer-signs","keywords","where-they-talk","competitors","priorities","scoring-rules","example-signals","excluded-companies","excluded-topics"],"type":"string"}},"setup_url":{"type":"string"}},"required":["files","facts","unread","topics","setup_url"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"files":1,"facts":3,"unread":0,"topics":["buyers","markets"],"setup_url":"https://app.getzynt.com/start"}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/signals/{id}":{"get":{"operationId":"getSignal","summary":"Get a signal","description":"Returns one signal with its score breakdown and people. All top-level signal fields are returned unless you select a subset with fields. A score-breakdown item omits explanation when none is available.","parameters":[{"name":"id","in":"path","required":true,"description":"A signal id from your own list.","schema":{"type":"string"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated fields to return. Omit to return every field. Available fields: id, scenario_id, title, score, status, assignee_id, summary, source_url, image_url, app_url, received_at, companies, favorite, score_breakdown, reasoning, sector, people.","schema":{"type":"string","description":"Comma-separated fields to return. Omit to return every field. Available fields: id, scenario_id, title, score, status, assignee_id, summary, source_url, image_url, app_url, received_at, companies, favorite, score_breakdown, reasoning, sector, people."}}],"responses":{"200":{"description":"The signal, including its score breakdown and people.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"scenario_id":{"type":"string"},"title":{"type":"string"},"score":{"type":"number"},"status":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","name","type"],"additionalProperties":false},{"type":"null"}]},"assignee_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"summary":{"type":"string"},"source_url":{"type":"string"},"image_url":{"type":"string"},"app_url":{"type":"string","description":"The signal's page in the ZYNT app; give it when someone asks for a link to the signal."},"received_at":{"type":"string"},"companies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"website_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"linkedin_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"type":"string"},"is_target":{"type":"boolean"}},"required":["id","name","website_url","linkedin_url","description","is_target"],"additionalProperties":false}},"favorite":{"type":"boolean"},"score_breakdown":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"icon":{"type":"string"},"explanation":{"type":"string"},"points":{"type":"number"},"max_points":{"type":"number"}},"required":["key","label","icon","points","max_points"],"additionalProperties":false}},"recommendation":{"type":"string","description":"AI-generated next step based on scoring context, or an empty string when unavailable."}},"required":["items","recommendation"],"additionalProperties":false},"reasoning":{"type":"string"},"sector":{"type":"string"},"people":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"title":{"type":"string"},"company_name":{"type":"string"},"linkedin_url":{"type":"string"},"is_target":{"type":"boolean"},"signal_role":{"type":"string"}},"required":["id","first_name","last_name","title","company_name","linkedin_url","is_target","signal_role"],"additionalProperties":false}}},"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"0f2c1e7a-3b4d-4f6a-8c9e-1d2f3a4b5c6d","scenario_id":"9a417d2e-6c3b-4f80-a195-7e2d4c6b8a01","title":"Acme Robotics raises €18M to expand warehouse automation","score":97,"status":{"id":"3b7e2c9d-1a5f-4d68-b023-9c7e6a4f2d10","name":"New","type":"todo"},"assignee_id":null,"summary":"Acme Robotics announced a Series A round to grow its European operations.","source_url":"https://news.example.com/acme-robotics-series-a","image_url":"https://news.example.com/favicon.ico","app_url":"https://app.getzynt.com/signals?signalId=0f2c1e7a-3b4d-4f6a-8c9e-1d2f3a4b5c6d","received_at":"2026-09-01T08:14:00.000Z","companies":[{"id":"7c5a1e3b-9d2f-4a60-b817-3e6c8d0f2a49","name":"Acme Robotics","website_url":"https://acme-robotics.example","linkedin_url":null,"description":"","is_target":true}],"favorite":false,"score_breakdown":{"items":[{"key":"strategic_value","label":"strategic","icon":"trending-up","explanation":"The expansion matches the workspace growth priorities.","points":28,"max_points":30},{"key":"bonus_factors","label":"bonus","icon":"award","points":7,"max_points":10}],"recommendation":"Review the round and contact the expansion lead."},"reasoning":"The funding, region and operating focus make this a high-priority signal.","sector":"Industrial automation","people":[{"id":"2e9c4b17-6d3a-4f85-9b21-c7a0e5d3f816","first_name":"Anna","last_name":"Nowak","title":"Head of Operations","company_name":"Acme Robotics","linkedin_url":"https://www.linkedin.com/in/anna-nowak","is_target":true,"signal_role":"Leads the expansion"}]}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}},"patch":{"operationId":"updateSignal","summary":"Move or assign a signal","description":"Moves the signal to a status and assigns it, as the key’s user would in the app. Send one field or both; a field you leave out stays as it is. Both are checked before either is saved, so a request with an unknown status or assignee changes nothing. The assignee gets the same notification as in the app. Moving a signal to any status but a to-do one can assign it to the key’s user by their “Assign signals I move” and “Take over from the current owner” settings; an assignee you send wins.","parameters":[{"name":"id","in":"path","required":true,"description":"A signal id from your own list.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","minLength":1,"description":"A status name from /api/v1/statuses, matched without case and spaces at the ends, or a status id."},"assignee":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"description":"The email or user id of a member of your organization from /api/v1/members, or null to unassign."}},"required":[],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"status":"Contacted","assignee":"anna@acme-sales.example"}}}},"responses":{"200":{"description":"The updated signal, the same as GET /api/v1/signals/{id} returns.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"scenario_id":{"type":"string"},"title":{"type":"string"},"score":{"type":"number"},"status":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","name","type"],"additionalProperties":false},{"type":"null"}]},"assignee_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"summary":{"type":"string"},"source_url":{"type":"string"},"image_url":{"type":"string"},"app_url":{"type":"string","description":"The signal's page in the ZYNT app; give it when someone asks for a link to the signal."},"received_at":{"type":"string"},"companies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"website_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"linkedin_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"type":"string"},"is_target":{"type":"boolean"}},"required":["id","name","website_url","linkedin_url","description","is_target"],"additionalProperties":false}},"favorite":{"type":"boolean"},"score_breakdown":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"icon":{"type":"string"},"explanation":{"type":"string"},"points":{"type":"number"},"max_points":{"type":"number"}},"required":["key","label","icon","points","max_points"],"additionalProperties":false}},"recommendation":{"type":"string","description":"AI-generated next step based on scoring context, or an empty string when unavailable."}},"required":["items","recommendation"],"additionalProperties":false},"reasoning":{"type":"string"},"sector":{"type":"string"},"people":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"title":{"type":"string"},"company_name":{"type":"string"},"linkedin_url":{"type":"string"},"is_target":{"type":"boolean"},"signal_role":{"type":"string"}},"required":["id","first_name","last_name","title","company_name","linkedin_url","is_target","signal_role"],"additionalProperties":false}}},"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"0f2c1e7a-3b4d-4f6a-8c9e-1d2f3a4b5c6d","scenario_id":"9a417d2e-6c3b-4f80-a195-7e2d4c6b8a01","title":"Acme Robotics raises €18M to expand warehouse automation","score":97,"status":{"id":"6d2a9f41-8c7e-4b35-a0d6-1f3e5b7c9a82","name":"Contacted","type":"in_progress"},"assignee_id":"user_2nX8kQvB4yLmR7tZ","summary":"Acme Robotics announced a Series A round to grow its European operations.","source_url":"https://news.example.com/acme-robotics-series-a","image_url":"https://news.example.com/favicon.ico","app_url":"https://app.getzynt.com/signals?signalId=0f2c1e7a-3b4d-4f6a-8c9e-1d2f3a4b5c6d","received_at":"2026-09-01T08:14:00.000Z","companies":[{"id":"7c5a1e3b-9d2f-4a60-b817-3e6c8d0f2a49","name":"Acme Robotics","website_url":"https://acme-robotics.example","linkedin_url":null,"description":"","is_target":true}],"favorite":false,"score_breakdown":{"items":[{"key":"strategic_value","label":"strategic","icon":"trending-up","explanation":"The expansion matches the workspace growth priorities.","points":28,"max_points":30},{"key":"bonus_factors","label":"bonus","icon":"award","points":7,"max_points":10}],"recommendation":"Review the round and contact the expansion lead."},"reasoning":"The funding, region and operating focus make this a high-priority signal.","sector":"Industrial automation","people":[{"id":"2e9c4b17-6d3a-4f85-9b21-c7a0e5d3f816","first_name":"Anna","last_name":"Nowak","title":"Head of Operations","company_name":"Acme Robotics","linkedin_url":"https://www.linkedin.com/in/anna-nowak","is_target":true,"signal_role":"Leads the expansion"}]}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/signals/{id}/feedback":{"put":{"operationId":"rateSignal","summary":"Rate a signal","description":"Sets the signal’s rating, the same feedback and comment as in the app, where 1 or 2 stars show as less like this and 3 to 5 as more like this. A signal has one rating, so each call replaces the last one, from anyone. The rating counts as the key’s user. Rating an unassigned signal can assign it to them; auto_assign decides. A signal someone has stays theirs unless the key’s user has “Take over from the current owner” on.","parameters":[{"name":"id","in":"path","required":true,"description":"A signal id from your own list.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"stars":{"anyOf":[{"type":"integer","minimum":1,"maximum":5},{"type":"null"}],"description":"1 to 5 stars, or null to clear the rating. The app shows 1 or 2 stars as less like this and 3 to 5 as more like this."},"comment":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}],"description":"Up to 1000 characters. Omit it, or send null or an empty text, for no comment.","default":null},"auto_assign":{"type":"boolean","description":"Whether rating an unassigned signal assigns it to the key’s user. A signal someone has stays theirs unless the user’s “Take over from the current owner” setting is on. Omit it to follow their “Assign signals I want more of” setting in the app, which assigns on 3 stars or more."}},"required":["stars"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"stars":4,"comment":"Good fit, talking to them next week"}}}},"responses":{"200":{"description":"The rating as saved. stars and comment are null when not set; less like this given in the app reads as 1 star.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"stars":{"anyOf":[{"type":"number"},{"type":"null"}]},"comment":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","stars","comment"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"0f2c1e7a-3b4d-4f6a-8c9e-1d2f3a4b5c6d","stars":4,"comment":"Good fit, talking to them next week"}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/signals/{id}/favorite":{"put":{"operationId":"favoriteSignal","summary":"Mark a signal as favorite","description":"Stars the signal, as the star in the app. The star is shared: the whole team sees it. Marking a favorite again changes nothing. Market signals have no star and answer 404. GET /api/v1/signals?favorite=true lists the favorites.","parameters":[{"name":"id","in":"path","required":true,"description":"A signal id from your own list.","schema":{"type":"string"}}],"responses":{"200":{"description":"The signal and whether it is a favorite now.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"favorite":{"type":"boolean"}},"required":["id","favorite"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"0f2c1e7a-3b4d-4f6a-8c9e-1d2f3a4b5c6d","favorite":true}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}},"delete":{"operationId":"unfavoriteSignal","summary":"Take a signal off the favorites","description":"Takes the star off the signal for the whole team. A signal that is not a favorite answers the same.","parameters":[{"name":"id","in":"path","required":true,"description":"A signal id from your own list.","schema":{"type":"string"}}],"responses":{"200":{"description":"The signal and whether it is a favorite now.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"favorite":{"type":"boolean"}},"required":["id","favorite"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"0f2c1e7a-3b4d-4f6a-8c9e-1d2f3a4b5c6d","favorite":false}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/signals":{"get":{"operationId":"listSignals","summary":"List signals","description":"Returns the newest signals first unless sort says otherwise. All top-level signal fields are returned unless you select a subset with fields. To read another page, send cursor=<next_cursor> from the previous response; a null next_cursor marks the end. Keep the same filters on each page and deduplicate by id because new arrivals can shift offsets. Filters combine with AND. Example: GET /api/v1/signals?search=funding&company=Acme&sort=highest-score&received_after=2026-09-01&limit=25&fields=id,title,summary,received_at.","parameters":[{"name":"search","in":"query","required":false,"description":"Case-insensitive text match across title, description, sector, AI summary, market, and reasoning. Blank values do not filter.","schema":{"type":"string","maxLength":200,"description":"Case-insensitive text match across title, description, sector, AI summary, market, and reasoning. Blank values do not filter."}},{"name":"company","in":"query","required":false,"description":"Case-insensitive company name match through extracted signal relationships. Free-text mentions do not match. Combined with other filters using AND.","schema":{"type":"string","maxLength":200,"description":"Case-insensitive company name match through extracted signal relationships. Free-text mentions do not match. Combined with other filters using AND."}},{"name":"person","in":"query","required":false,"description":"Case-insensitive person name match through extracted signal relationships. Employer signals are not inferred. Combined with other filters using AND.","schema":{"type":"string","maxLength":200,"description":"Case-insensitive person name match through extracted signal relationships. Employer signals are not inferred. Combined with other filters using AND."}},{"name":"company_id","in":"query","required":false,"description":"Only signals about this company, by the id from /api/v1/companies/lookup, /api/v1/companies/search or a signal. The same signals as the company profile in the app. Combined with other filters using AND.","schema":{"type":"string","minLength":1,"description":"Only signals about this company, by the id from /api/v1/companies/lookup, /api/v1/companies/search or a signal. The same signals as the company profile in the app. Combined with other filters using AND."}},{"name":"person_id","in":"query","required":false,"description":"Only signals about this person, by the id from /api/v1/people/lookup, /api/v1/people/search or a signal. The same signals as the person profile in the app. Combined with other filters using AND.","schema":{"type":"string","minLength":1,"description":"Only signals about this person, by the id from /api/v1/people/lookup, /api/v1/people/search or a signal. The same signals as the person profile in the app. Combined with other filters using AND."}},{"name":"audience_id","in":"query","required":false,"description":"Only signals about a member of this list, by the id from /api/v1/audiences: a company list matches the companies, a people list the people. Combined with other filters using AND.","schema":{"type":"string","minLength":1,"description":"Only signals about a member of this list, by the id from /api/v1/audiences: a company list matches the companies, a people list the people. Combined with other filters using AND."}},{"name":"sort","in":"query","required":false,"description":"Result order: newest, oldest, highest-score, lowest-score. Defaults to newest.","schema":{"enum":["newest","oldest","highest-score","lowest-score"],"type":"string","description":"Result order: newest, oldest, highest-score, lowest-score. Defaults to newest."}},{"name":"received_after","in":"query","required":false,"description":"Only signals received at or after this ISO 8601 date or timestamp, e.g. 2026-09-01 or 2026-09-01T08:00:00Z. A date alone means 00:00 UTC.","schema":{"anyOf":[{"type":"string","format":"date"},{"type":"string","format":"date-time"}],"description":"Only signals received at or after this ISO 8601 date or timestamp, e.g. 2026-09-01 or 2026-09-01T08:00:00Z. A date alone means 00:00 UTC."}},{"name":"received_before","in":"query","required":false,"description":"Only signals received at or before this ISO 8601 date or timestamp. A date alone means 00:00 UTC.","schema":{"anyOf":[{"type":"string","format":"date"},{"type":"string","format":"date-time"}],"description":"Only signals received at or before this ISO 8601 date or timestamp. A date alone means 00:00 UTC."}},{"name":"favorite","in":"query","required":false,"description":"true returns only the signals your team starred; false, or leaving it out, returns all signals.","schema":{"enum":["true","false"],"type":"string","description":"true returns only the signals your team starred; false, or leaving it out, returns all signals."}},{"name":"one_per_company","in":"query","required":false,"description":"true keeps only the best matching signal of each company: the highest score, then the newest. A signal counts for the company its source names most, the first of its companies; with audience_id of a company list, for the company on that list its source names most. On a people list, two people of one company count as that company. A signal that names no company stays. Applied after the other filters.","schema":{"enum":["true","false"],"type":"string","description":"true keeps only the best matching signal of each company: the highest score, then the newest. A signal counts for the company its source names most, the first of its companies; with audience_id of a company list, for the company on that list its source names most. On a people list, two people of one company count as that company. A signal that names no company stays. Applied after the other filters."}},{"name":"cursor","in":"query","required":false,"description":"Offset returned as next_cursor by the previous page. Omit on the first request. Must be an integer from 0 to 9007199254740991.","schema":{"type":"string","description":"Offset returned as next_cursor by the previous page. Omit on the first request. Must be an integer from 0 to 9007199254740991.","pattern":"^(0|[1-9]\\d*)$"}},{"name":"limit","in":"query","required":false,"description":"How many signals to return, from 1 to 100; 25 when you leave it out. To read more than a few, ask for 100: one page of 100 is one request instead of four, and fields keeps a big page small.","schema":{"type":"string","description":"How many signals to return, from 1 to 100; 25 when you leave it out. To read more than a few, ask for 100: one page of 100 is one request instead of four, and fields keeps a big page small.","pattern":"^[1-9]\\d*$","default":"25"}},{"name":"fields","in":"query","required":false,"description":"Comma-separated fields to return. Omit to return every field. Available fields: id, scenario_id, title, score, status, assignee_id, summary, source_url, image_url, app_url, received_at, companies, favorite.","schema":{"type":"string","description":"Comma-separated fields to return. Omit to return every field. Available fields: id, scenario_id, title, score, status, assignee_id, summary, source_url, image_url, app_url, received_at, companies, favorite."}}],"responses":{"200":{"description":"A page of signals visible to the key owner.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"scenario_id":{"type":"string"},"title":{"type":"string"},"score":{"type":"number"},"status":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","name","type"],"additionalProperties":false},{"type":"null"}]},"assignee_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"summary":{"type":"string"},"source_url":{"type":"string"},"image_url":{"type":"string"},"app_url":{"type":"string","description":"The signal's page in the ZYNT app; give it when someone asks for a link to the signal."},"received_at":{"type":"string"},"companies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"website_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"linkedin_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"type":"string"},"is_target":{"type":"boolean"}},"required":["id","name","website_url","linkedin_url","description","is_target"],"additionalProperties":false}},"favorite":{"type":"boolean"}},"additionalProperties":false}},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["data","next_cursor"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"examples":{"page":{"summary":"A terminal page with one signal","value":{"data":[{"id":"0f2c1e7a-3b4d-4f6a-8c9e-1d2f3a4b5c6d","scenario_id":"9a417d2e-6c3b-4f80-a195-7e2d4c6b8a01","title":"Acme Robotics raises €18M to expand warehouse automation","score":97,"status":{"id":"3b7e2c9d-1a5f-4d68-b023-9c7e6a4f2d10","name":"New","type":"todo"},"assignee_id":null,"summary":"Acme Robotics announced a Series A round to grow its European operations.","source_url":"https://news.example.com/acme-robotics-series-a","image_url":"https://news.example.com/favicon.ico","app_url":"https://app.getzynt.com/signals?signalId=0f2c1e7a-3b4d-4f6a-8c9e-1d2f3a4b5c6d","received_at":"2026-09-01T08:14:00.000Z","companies":[{"id":"7c5a1e3b-9d2f-4a60-b817-3e6c8d0f2a49","name":"Acme Robotics","website_url":"https://acme-robotics.example","linkedin_url":null,"description":"","is_target":true}],"favorite":false}],"next_cursor":null}},"empty":{"summary":"An empty final page","value":{"data":[],"next_cursor":null}}}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}},"patch":{"operationId":"updateSignals","summary":"Move or assign many signals","description":"Makes the same change as PATCH /api/v1/signals/{id} on up to 100 signals at once: moves them to a status, assigns them, or both. Send status, assignee or both. Both are checked once, before any signal changes, so an unknown status or assignee changes nothing. Then each signal changes on its own, exactly as PATCH /api/v1/signals/{id} would change it; an id that does not exist or that the key’s user cannot see is listed in not_found and does not stop the rest. Read a signal with GET /api/v1/signals/{id} to see it after the change.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string","minLength":1},"minItems":1,"maxItems":100,"description":"Signal ids from your signal list, 1 to 100. A repeated id changes once."},"status":{"type":"string","minLength":1,"description":"A status name from /api/v1/statuses, matched without case and spaces at the ends, or a status id."},"assignee":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"description":"The email or user id of a member of your organization from /api/v1/members, or null to unassign."}},"required":["ids"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"ids":["0f2c1e7a-3b4d-4f6a-8c9e-1d2f3a4b5c6d","5e8b2d14-7a9c-4f3e-b6d1-0c2a9f4e7b38"],"status":"Contacted","assignee":"anna@acme-sales.example"}}}},"responses":{"200":{"description":"Which signals changed and which were not found.","content":{"application/json":{"schema":{"type":"object","properties":{"updated":{"type":"array","items":{"type":"string"},"description":"The ids of the signals that changed."},"not_found":{"type":"array","items":{"type":"string"},"description":"The ids of signals that do not exist or that the key’s user cannot see. Nothing changed for them."}},"required":["updated","not_found"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"updated":["0f2c1e7a-3b4d-4f6a-8c9e-1d2f3a4b5c6d"],"not_found":["5e8b2d14-7a9c-4f3e-b6d1-0c2a9f4e7b38"]}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/statuses":{"get":{"operationId":"listStatuses","summary":"List statuses","description":"Every status of your organization, in the order the app shows them: todo first, then in_progress, then done. Send a name or an id as status to PATCH /api/v1/signals/{id}.","responses":{"200":{"description":"The statuses, with no paging.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"enum":["todo","in_progress","done"],"type":"string"},"color":{"type":"string"}},"required":["id","name","type","color"],"additionalProperties":false},"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":[{"id":"3b7e2c9d-1a5f-4d68-b023-9c7e6a4f2d10","name":"New","type":"todo","color":"#3b82f6"},{"id":"6d2a9f41-8c7e-4b35-a0d6-1f3e5b7c9a82","name":"Contacted","type":"in_progress","color":"#f59e0b"},{"id":"c4e81b6f-2d9a-4f73-8e05-7a1b3d5f9c26","name":"Won","type":"done","color":"#22c55e"}]}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}},"post":{"operationId":"createStatus","summary":"Add a status","description":"Adds a status at the end of its type, as Settings → Statuses does. Only an admin of your organization can add one; anyone else gets 403. Names are unique without case, so a name another status has is 422. color defaults to #3b82f6.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"description":"The name your team sees in ZYNT."},"type":{"enum":["todo","in_progress","done"],"type":"string","description":"todo, in_progress or done. It decides where the status sits and how the app treats a signal in it; it cannot change later."},"color":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$","description":"A hex color such as #3b82f6."}},"required":["name","type"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"name":"Meeting booked","type":"in_progress","color":"#8b5cf6"}}}},"responses":{"200":{"description":"The new status.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"enum":["todo","in_progress","done"],"type":"string"},"color":{"type":"string"}},"required":["id","name","type","color"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"1f7b3d95-4e2a-4c68-9a0b-5d3e7f1c2b84","name":"Meeting booked","type":"in_progress","color":"#8b5cf6"}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/statuses/{id}":{"patch":{"operationId":"updateStatus","summary":"Rename or recolor a status","description":"Changes the name, the color, or both. A field you leave out stays as it is. The type cannot change. Signals in the status keep it. Only an admin of your organization can change a status.","parameters":[{"name":"id","in":"path","required":true,"description":"A status id from /api/v1/statuses, or its name.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"description":"The name your team sees in ZYNT."},"color":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$","description":"A hex color such as #3b82f6."}},"required":[],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"name":"Reached out"}}}},"responses":{"200":{"description":"The status as saved.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"enum":["todo","in_progress","done"],"type":"string"},"color":{"type":"string"}},"required":["id","name","type","color"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"6d2a9f41-8c7e-4b35-a0d6-1f3e5b7c9a82","name":"Reached out","type":"in_progress","color":"#f59e0b"}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}},"delete":{"operationId":"deleteStatus","summary":"Delete a status","description":"Deletes the status. A status with signals in it, or the one new signals get, needs move_to: its signals and the default move there first. Without move_to such a status answers 409 status_in_use and nothing changes. The last status of a type cannot go (409 last_status_of_type). Only an admin of your organization can delete a status.","parameters":[{"name":"id","in":"path","required":true,"description":"A status id from /api/v1/statuses, or its name.","schema":{"type":"string"}},{"name":"move_to","in":"query","required":false,"description":"A status name or id that takes the signals in the deleted status. Required when a signal is in it or it is the status new signals get.","schema":{"type":"string","minLength":1,"description":"A status name or id that takes the signals in the deleted status. Required when a signal is in it or it is the status new signals get."}}],"responses":{"200":{"description":"The status that was deleted.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"enum":["todo","in_progress","done"],"type":"string"},"color":{"type":"string"}},"required":["id","name","type","color"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"6d2a9f41-8c7e-4b35-a0d6-1f3e5b7c9a82","name":"Contacted","type":"in_progress","color":"#f59e0b"}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/webhooks":{"get":{"operationId":"listWebhooks","summary":"List webhooks","description":"The webhooks you made, oldest first; an admin gets every webhook of the organization. url shows only the host and the last four characters, since a Slack URL lets anyone post to the channel. failing_since and last_error show a URL whose last attempt failed; disabled_at one ZYNT stopped sending to. No paging.","responses":{"200":{"description":"The webhooks.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"events":{"type":"array","items":{"enum":["signal.created","signal.assigned"],"type":"string"},"description":"signal.created, signal.assigned"},"assignee_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The member whose assigned signals the webhook gets, or null for the whole team."},"audience_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The list whose signals the webhook gets, or null for every new signal about the watchlist."},"created_by":{"type":"string","description":"The user id of the key that made it."},"created_at":{"type":"string"},"failing_since":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the URL started failing every attempt, or null while it answers."},"last_error":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What went wrong the last time, or null."},"disabled_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When ZYNT stopped sending to it, or null while it is on."}},"required":["id","url","events","assignee_id","audience_id","created_by","created_at","failing_since","last_error","disabled_at"],"additionalProperties":false},"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":[{"id":"5d8e2f61-0b4c-4a97-9e13-7c2a6b8d4f05","url":"https://hooks.slack.com/…1d4a","events":["signal.assigned"],"assignee_id":"user_2nX8kQvB4yLmR7tZ","audience_id":null,"created_by":"user_2nX8kQvB4yLmR7tZ","created_at":"2026-11-10T09:30:00.000Z","failing_since":null,"last_error":null,"disabled_at":null},{"id":"8a1f4c27-6e3d-4b80-a952-1d7e3c9b6f42","url":"https://crm.acme-sales.example/…ents","events":["signal.created","signal.assigned"],"assignee_id":null,"audience_id":null,"created_by":"user_2nX8kQvB4yLmR7tZ","created_at":"2026-11-10T09:30:00.000Z","failing_since":"2026-11-09T22:04:00.000Z","last_error":"The URL answered 503","disabled_at":null},{"id":"2c7d9e41-8f3a-4b6c-9d25-6a1e0f4b8c37","url":"https://hooks.slack.com/…7b2e","events":["signal.created"],"assignee_id":null,"audience_id":"8b2e4c61-3f9a-4d07-a5c1-6e8d2b4f0a93","created_by":"user_2nX8kQvB4yLmR7tZ","created_at":"2026-11-10T09:30:00.000Z","failing_since":null,"last_error":null,"disabled_at":null}]}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}},"post":{"operationId":"createWebhook","summary":"Add a webhook","description":"Registers an https URL that ZYNT posts events to within a few minutes: signal.created when a new signal the key’s user can see shows in ZYNT and names a company or person on the watchlist, signal.assigned each time someone gives a signal to a member, or a CRM client or audience rule does (not when members take a signal themselves). With assignee, only the signals given to that member that both they and the key’s user can see. Each post is JSON with id, type, created_at, text (a short message with a link, escaped for Slack) and data.signal, as GET /api/v1/signals/{id} returns it. It is signed as Standard Webhooks sign: the webhook-id, webhook-timestamp and webhook-signature headers. A timeout, no answer, 408, 429 or 5xx is tried again for about 7 hours, at the time Retry-After asks for when it does; a redirect or another 4xx is not. A URL failing for 3 days is switched off at its next failure, and at once on 410 Gone. The secret is in this answer only.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","maxLength":2000,"format":"uri","pattern":"^https:\\/\\/","description":"The https URL ZYNT posts the events to, such as a Slack workflow or incoming webhook URL."},"events":{"type":"array","items":{"enum":["signal.created","signal.assigned"],"type":"string"},"minItems":1,"description":"The events to send: signal.created, signal.assigned. With assignee, only signal.assigned."},"assignee":{"type":"string","minLength":1,"description":"An email or user id from /api/v1/members. The webhook then gets only the signals given to that member. Leave it out for the whole team."},"audience_id":{"type":"string","minLength":1,"description":"A list id from /api/v1/audiences. signal.created then tells only of new signals about its members, the same as GET /api/v1/signals?audience_id. Not with assignee."}},"required":["url","events"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"url":"https://hooks.slack.com/triggers/T0123ABCD/8123456789/3f9c2b7e1d4a","events":["signal.assigned"],"assignee":"anna@acme-sales.example"}}}},"responses":{"200":{"description":"The new webhook, with its signing secret.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"events":{"type":"array","items":{"enum":["signal.created","signal.assigned"],"type":"string"},"description":"signal.created, signal.assigned"},"assignee_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The member whose assigned signals the webhook gets, or null for the whole team."},"audience_id":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The list whose signals the webhook gets, or null for every new signal about the watchlist."},"created_by":{"type":"string","description":"The user id of the key that made it."},"created_at":{"type":"string"},"failing_since":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When the URL started failing every attempt, or null while it answers."},"last_error":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What went wrong the last time, or null."},"disabled_at":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When ZYNT stopped sending to it, or null while it is on."},"secret":{"type":"string","description":"The signing secret. It is shown only now; keep it to check the webhook-signature header."}},"required":["id","url","events","assignee_id","audience_id","created_by","created_at","failing_since","last_error","disabled_at","secret"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"5d8e2f61-0b4c-4a97-9e13-7c2a6b8d4f05","url":"https://hooks.slack.com/triggers/T0123ABCD/8123456789/3f9c2b7e1d4a","events":["signal.assigned"],"assignee_id":"user_2nX8kQvB4yLmR7tZ","audience_id":null,"created_by":"user_2nX8kQvB4yLmR7tZ","created_at":"2026-11-10T09:30:00.000Z","failing_since":null,"last_error":null,"disabled_at":null,"secret":"whsec_Zk3QmV9xR2pL7tYw4nB8cD1fH6jK0sA5"}}}},"400":{"description":"The body is not valid JSON, the status, assignee or scenario in it is unknown, or the setup does not take this answer now. Send a status name from /api/v1/statuses; unknown_status lists them in allowed. Send an email or id from /api/v1/members as assignee. unknown_scenario lists your scenario ids in allowed. unknown_answer lists the answers the setup takes now in allowed.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["invalid_json","unknown_status","invalid_assignee","unknown_scenario","unknown_answer"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"409":{"description":"The status still has signals or is the status new signals get, it is the last status of its type, the key’s user has no setup open, the setup moved on since you read it, your team has as many lists, writing skills or people as it can, the user has as many keys as they can, or the person is already on the team. Send move_to with another status for its signals. Keep at least one status of each type. For no_open_setup, its message says what state the setup is in and its hint what to tell the user (reason names the case); usually they click New scenario in Settings → Business, or a new account signs up at /sign-up. For setup_changed, read the setup again and answer its new question. For the limits, delete a list or a skill, revoke an invitation or a key, or remove a member.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["status_in_use","last_status_of_type","no_open_setup","setup_changed","audience_limit_reached","writing_skill_limit_reached","user_limit_reached","already_member","api_key_limit_reached"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"415":{"description":"A body was sent without the Content-Type: application/json header. Send the body as JSON with that header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unsupported_media_type","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"429":{"description":"The setup has read the 20 files of notes it takes, or your team sent as many invitations as an hour allows. Send only the files that matter most, or let the user finish the setup in the chat. For rate_limited, wait an hour.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["setup_file_limit","rate_limited"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/webhooks/{id}":{"delete":{"operationId":"deleteWebhook","summary":"Delete a webhook","description":"Stops the webhook at once; an event still being retried is dropped. A member deletes only the webhooks they made; an admin any of the organization. To turn a webhook ZYNT switched off back on, delete it and add it again.","parameters":[{"name":"id","in":"path","required":true,"description":"A webhook id from GET /api/v1/webhooks.","schema":{"type":"string"}}],"responses":{"200":{"description":"The webhook is gone.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"const":true}},"required":["id","deleted"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"5d8e2f61-0b4c-4a97-9e13-7c2a6b8d4f05","deleted":true}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/webhooks/{id}/ping":{"post":{"operationId":"pingWebhook","summary":"Send a test event","description":"Posts a webhook.ping event to the URL now, signed like any other, and says what the URL answered. It takes no body and changes nothing: a webhook ZYNT switched off stays off.","parameters":[{"name":"id","in":"path","required":true,"description":"A webhook id from GET /api/v1/webhooks.","schema":{"type":"string"}}],"responses":{"200":{"description":"What the URL answered.","content":{"application/json":{"schema":{"type":"object","properties":{"delivered":{"type":"boolean","description":"true when the URL answered with 2xx."},"status":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The HTTP status the URL answered with, or null when it could not be reached."},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What went wrong, or null when it was delivered."}},"required":["delivered","status","error"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"delivered":true,"status":200,"error":null}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}},"/api/v1/webhooks/{id}/scan":{"post":{"operationId":"scanWebhook","summary":"Send unsent events now","description":"Sends the webhook, within a minute, every event of the last 48 hours (since the webhook was made, if later) that it has not had yet: the same check ZYNT runs after each new or assigned signal. An event already sent is not sent again. It takes no body. A webhook ZYNT switched off sends nothing and answers started false.","parameters":[{"name":"id","in":"path","required":true,"description":"A webhook id from GET /api/v1/webhooks.","schema":{"type":"string"}}],"responses":{"200":{"description":"Whether the send started.","content":{"application/json":{"schema":{"type":"object","properties":{"started":{"type":"boolean","description":"true when the send started; false when ZYNT switched the webhook off."}},"required":["started"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"started":true}}}},"401":{"description":"The key is missing, wrong, or revoked. Check the Authorization header. Make a new key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"unauthorized","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"403":{"description":"The key’s user cannot read or change this, or the feature is off for your organization. Use a key of a user with access; only an admin changes statuses. For feature_disabled, ask ZYNT to turn the feature on.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"enum":["forbidden","feature_disabled"],"type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"allowed":{"type":"array","items":{"type":"string"}},"reason":{"type":"string"},"setup_url":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"404":{"description":"The id does not exist or is not yours, or ZYNT does not know the company or person you looked up. Use an id from your own list, a lookup, a search or a signal. For a company lookup, try the other key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"not_found","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"422":{"description":"A parameter or a body field is invalid, for example limit=101 or stars=6. Send limit between 1 and 100, a valid cursor, supported field names, and only the body fields the endpoint lists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"invalid_request","type":"string"},"message":{"type":"string"},"hint":{"type":"string"},"issues":{"type":"object","properties":{"root":{"type":"array","items":{"type":"string"}},"nested":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"array","items":{"type":"string"}}},"other":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}},"required":["error","message","hint","issues"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"500":{"description":"The server could not complete the request. Retry later. Contact support if the error persists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"internal_error","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}},"503":{"description":"A required service is temporarily unavailable. Wait a moment and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"const":"service_unavailable","type":"string"},"message":{"type":"string"},"hint":{"type":"string"}},"required":["error","message","hint"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"}}}}}}}},"webhooks":{"signalEvent":{"post":{"operationId":"signalEvent","summary":"A signal arrived or was assigned","description":"Signed with the webhook-id, webhook-timestamp and webhook-signature headers of Standard Webhooks. Answer 2xx within 10 seconds. A timeout, no answer, 408, 429 or 5xx is tried again with the same id; a redirect or another 4xx is not.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The event id, also in the webhook-id header. A retry sends the same id."},"type":{"enum":["signal.created","signal.assigned","webhook.ping"],"type":"string"},"created_at":{"type":"string","description":"When it happened: the signal was found or assigned."},"text":{"type":"string","description":"A short message for people with a link to the signal, so a Slack workflow or incoming webhook can show it as it is."},"data":{"type":"object","properties":{"signal":{"type":"object","properties":{"id":{"type":"string"},"scenario_id":{"type":"string"},"title":{"type":"string"},"score":{"type":"number"},"status":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","name","type"],"additionalProperties":false},{"type":"null"}]},"assignee_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"summary":{"type":"string"},"source_url":{"type":"string"},"image_url":{"type":"string"},"app_url":{"type":"string","description":"The signal's page in the ZYNT app; give it when someone asks for a link to the signal."},"received_at":{"type":"string"},"companies":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"website_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"linkedin_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"type":"string"},"is_target":{"type":"boolean"}},"required":["id","name","website_url","linkedin_url","description","is_target"],"additionalProperties":false}},"favorite":{"type":"boolean"},"score_breakdown":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"label":{"type":"string"},"icon":{"type":"string"},"explanation":{"type":"string"},"points":{"type":"number"},"max_points":{"type":"number"}},"required":["key","label","icon","points","max_points"],"additionalProperties":false}},"recommendation":{"type":"string","description":"AI-generated next step based on scoring context, or an empty string when unavailable."}},"required":["items","recommendation"],"additionalProperties":false},"reasoning":{"type":"string"},"sector":{"type":"string"},"people":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"title":{"type":"string"},"company_name":{"type":"string"},"linkedin_url":{"type":"string"},"is_target":{"type":"boolean"},"signal_role":{"type":"string"}},"required":["id","first_name","last_name","title","company_name","linkedin_url","is_target","signal_role"],"additionalProperties":false}}},"required":[],"additionalProperties":false},"assignee":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","description":"The Clerk user id."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"First and last name, or null when the member has not set one."},"email":{"type":"string"}},"required":["id","name","email"],"additionalProperties":false},{"type":"null"}]},"webhook_id":{"type":"string"}},"required":[],"additionalProperties":false}},"required":["id","type","created_at","text","data"],"additionalProperties":false,"$schema":"https://json-schema.org/draft/2020-12/schema"},"example":{"id":"signal.assigned:c41e7a92-5b3d-4f68-8a20-9e6d1b7c3f58","type":"signal.assigned","created_at":"2026-11-10T10:02:00.000Z","text":"Signal for Anna Kowalska (score 97): Acme Robotics raises €18M to expand warehouse automation\nhttps://app.getzynt.com/signals?signalId=0f2c1e7a-3b4d-4f6a-8c9e-1d2f3a4b5c6d","data":{"signal":{"id":"0f2c1e7a-3b4d-4f6a-8c9e-1d2f3a4b5c6d","scenario_id":"9a417d2e-6c3b-4f80-a195-7e2d4c6b8a01","title":"Acme Robotics raises €18M to expand warehouse automation","score":97,"status":{"id":"6d2a9f41-8c7e-4b35-a0d6-1f3e5b7c9a82","name":"Contacted","type":"in_progress"},"assignee_id":"user_2nX8kQvB4yLmR7tZ","summary":"Acme Robotics announced a Series A round to grow its European operations.","source_url":"https://news.example.com/acme-robotics-series-a","image_url":"https://news.example.com/favicon.ico","app_url":"https://app.getzynt.com/signals?signalId=0f2c1e7a-3b4d-4f6a-8c9e-1d2f3a4b5c6d","received_at":"2026-09-01T08:14:00.000Z","companies":[{"id":"7c5a1e3b-9d2f-4a60-b817-3e6c8d0f2a49","name":"Acme Robotics","website_url":"https://acme-robotics.example","linkedin_url":null,"description":"","is_target":true}],"favorite":false,"score_breakdown":{"items":[{"key":"strategic_value","label":"strategic","icon":"trending-up","explanation":"The expansion matches the workspace growth priorities.","points":28,"max_points":30},{"key":"bonus_factors","label":"bonus","icon":"award","points":7,"max_points":10}],"recommendation":"Review the round and contact the expansion lead."},"reasoning":"The funding, region and operating focus make this a high-priority signal.","sector":"Industrial automation","people":[{"id":"2e9c4b17-6d3a-4f85-9b21-c7a0e5d3f816","first_name":"Anna","last_name":"Nowak","title":"Head of Operations","company_name":"Acme Robotics","linkedin_url":"https://www.linkedin.com/in/anna-nowak","is_target":true,"signal_role":"Leads the expansion"}]},"assignee":{"id":"user_2nX8kQvB4yLmR7tZ","name":"Anna Kowalska","email":"anna@acme-sales.example"}}}}}},"responses":{"200":{"description":"Received."}}}}}}