{"items":[{"type":"link","label":"Forager public API","link":"/openapi","routeSlug":"/openapi","content":{"contentType":"overview","meta":{"name":"Forager public API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api-v2.forager.ai"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Forager public API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Forager public API endpoints documentation"}],"sectionId":"/openapi"}],"sectionId":"/openapi"}]}]}},{"type":"group","label":"Job Posts","link":"/openapi/job-posts","routeSlug":"/openapi/job-posts","items":[{"label":"Job post event search","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/job-posts/datastorage_job_search_create","routeSlug":"/openapi/job-posts/datastorage_job_search_create","metadata":{"seo":{"title":"Job post event search","description":"Job post event search."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"datastorage_job_search_create","name":"Job post event search","isWebhook":false,"pointer":"/paths/~1api~1{account_id}~1datastorage~1job_search~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Job post event search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Job post event search."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Api-Key","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1job_search~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/JobPostEventSearch"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/JobPostEventSearch"},"multipart/form-data":{"schemaId":"components/schemas/JobPostEventSearch"}},"schemaId":"components/schemas/JobPostEventSearch","pointer":"/paths/~1api~1{account_id}~1datastorage~1job_search~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/{account_id}/datastorage/job_search/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_13"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Api-Key","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/JobPostEventSearch"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/JobPostEventSearch"},"multipart/form-data":{"schemaId":"components/schemas/JobPostEventSearch"}},"responseCodes":["200"],"pointer":"/api/{account_id}/datastorage/job_search/","href":"job-posts/datastorage_job_search_create","openApiOperationId":"datastorage_job_search_create","summary":"Job post event search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"schemaId":"components/schemas/JobPostEventSearch","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/JobPostEventSearch"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/JobPostEventSearch"},"multipart/form-data":{"schemaId":"components/schemas/JobPostEventSearch"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobPostEventSearchResponse"}},"schemaId":"components/schemas/JobPostEventSearchResponse"}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1job_search~1/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/JobPostEventSearchResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobPostEventSearchResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/job-posts/datastorage_job_search_create"}],"panels":[]}]},"httpPath":"/api/{account_id}/datastorage/job_search/"},{"label":"Job post event search totals","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/job-posts/datastorage_job_search_totals_create","routeSlug":"/openapi/job-posts/datastorage_job_search_totals_create","metadata":{"seo":{"title":"Job post event search totals","description":"Job post event search totals."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"datastorage_job_search_totals_create","name":"Job post event search totals","isWebhook":false,"pointer":"/paths/~1api~1{account_id}~1datastorage~1job_search~1totals~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Job post event search totals","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Job post event search totals."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Api-Key","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1job_search~1totals~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/JobPostEventSearch"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/JobPostEventSearch"},"multipart/form-data":{"schemaId":"components/schemas/JobPostEventSearch"}},"schemaId":"components/schemas/JobPostEventSearch","pointer":"/paths/~1api~1{account_id}~1datastorage~1job_search~1totals~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/{account_id}/datastorage/job_search/totals/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_13"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Api-Key","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/JobPostEventSearch"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/JobPostEventSearch"},"multipart/form-data":{"schemaId":"components/schemas/JobPostEventSearch"}},"responseCodes":["200"],"pointer":"/api/{account_id}/datastorage/job_search/totals/","href":"job-posts/datastorage_job_search_totals_create","openApiOperationId":"datastorage_job_search_totals_create","summary":"Job post event search totals"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"schemaId":"components/schemas/JobPostEventSearch","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/JobPostEventSearch"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/JobPostEventSearch"},"multipart/form-data":{"schemaId":"components/schemas/JobPostEventSearch"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobPostEventSearchTotalsResponse"}},"schemaId":"components/schemas/JobPostEventSearchTotalsResponse"}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1job_search~1totals~1/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/JobPostEventSearchTotalsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobPostEventSearchTotalsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/job-posts/datastorage_job_search_totals_create"}],"panels":[]}]},"httpPath":"/api/{account_id}/datastorage/job_search/totals/"}],"content":{"contentType":"group","meta":{"name":"Job Posts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Job Posts","showPageActions":true},{"nodeType":"markdoc","content":"Search the Forager job-post index. Use these endpoints to find job postings by attributes such as title, location, posted date, or hiring organization, and to retrieve aggregate totals for a given query before paginating through full results."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/{account_id}/datastorage/job_search/","summary":"Job post event search","prefix":{"name":"post","color":"post"},"badges":[],"link":"/job-posts/datastorage_job_search_create","deprecated":false},{"title":"/api/{account_id}/datastorage/job_search/totals/","summary":"Job post event search totals","prefix":{"name":"post","color":"post"},"badges":[],"link":"/job-posts/datastorage_job_search_totals_create","deprecated":false}]}]}]}]}},{"type":"group","label":"Organizations","link":"/openapi/organizations","routeSlug":"/openapi/organizations","items":[{"label":"Organization search","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/organizations/datastorage_organization_search_create","routeSlug":"/openapi/organizations/datastorage_organization_search_create","metadata":{"seo":{"title":"Organization search","description":"Organization search."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"datastorage_organization_search_create","name":"Organization search","isWebhook":false,"pointer":"/paths/~1api~1{account_id}~1datastorage~1organization_search~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Organization search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Organization search."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Api-Key","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1organization_search~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrganizationSearchRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/OrganizationSearchRequest"},"multipart/form-data":{"schemaId":"components/schemas/OrganizationSearchRequest"}},"schemaId":"components/schemas/OrganizationSearchRequest","pointer":"/paths/~1api~1{account_id}~1datastorage~1organization_search~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/{account_id}/datastorage/organization_search/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_13"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Api-Key","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrganizationSearchRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/OrganizationSearchRequest"},"multipart/form-data":{"schemaId":"components/schemas/OrganizationSearchRequest"}},"responseCodes":["200"],"pointer":"/api/{account_id}/datastorage/organization_search/","href":"organizations/datastorage_organization_search_create","openApiOperationId":"datastorage_organization_search_create","summary":"Organization search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"schemaId":"components/schemas/OrganizationSearchRequest","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrganizationSearchRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/OrganizationSearchRequest"},"multipart/form-data":{"schemaId":"components/schemas/OrganizationSearchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationSearchResponse"}},"schemaId":"components/schemas/OrganizationSearchResponse"}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1organization_search~1/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrganizationSearchResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationSearchResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/datastorage_organization_search_create"}],"panels":[]}]},"httpPath":"/api/{account_id}/datastorage/organization_search/"},{"label":"Organization search totals","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/organizations/datastorage_organization_search_totals_create","routeSlug":"/openapi/organizations/datastorage_organization_search_totals_create","metadata":{"seo":{"title":"Organization search totals","description":"Organization search totals."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"datastorage_organization_search_totals_create","name":"Organization search totals","isWebhook":false,"pointer":"/paths/~1api~1{account_id}~1datastorage~1organization_search~1totals~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Organization search totals","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Organization search totals."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Api-Key","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1organization_search~1totals~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrganizationSearchRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/OrganizationSearchRequest"},"multipart/form-data":{"schemaId":"components/schemas/OrganizationSearchRequest"}},"schemaId":"components/schemas/OrganizationSearchRequest","pointer":"/paths/~1api~1{account_id}~1datastorage~1organization_search~1totals~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/{account_id}/datastorage/organization_search/totals/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_13"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Api-Key","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrganizationSearchRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/OrganizationSearchRequest"},"multipart/form-data":{"schemaId":"components/schemas/OrganizationSearchRequest"}},"responseCodes":["200"],"pointer":"/api/{account_id}/datastorage/organization_search/totals/","href":"organizations/datastorage_organization_search_totals_create","openApiOperationId":"datastorage_organization_search_totals_create","summary":"Organization search totals"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"schemaId":"components/schemas/OrganizationSearchRequest","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrganizationSearchRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/OrganizationSearchRequest"},"multipart/form-data":{"schemaId":"components/schemas/OrganizationSearchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationSearchTotalsResponse"}},"schemaId":"components/schemas/OrganizationSearchTotalsResponse"}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1organization_search~1totals~1/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrganizationSearchTotalsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrganizationSearchTotalsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/datastorage_organization_search_totals_create"}],"panels":[]}]},"httpPath":"/api/{account_id}/datastorage/organization_search/totals/"}],"content":{"contentType":"group","meta":{"name":"Organizations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Organizations","showPageActions":true},{"nodeType":"markdoc","content":"Search the Forager organization index. Filter companies by attributes such as industry, headcount, location, keywords, and web technologies, and retrieve total match counts alongside the result set."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/{account_id}/datastorage/organization_search/","summary":"Organization search","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organizations/datastorage_organization_search_create","deprecated":false},{"title":"/api/{account_id}/datastorage/organization_search/totals/","summary":"Organization search totals","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organizations/datastorage_organization_search_totals_create","deprecated":false}]}]}]}]}},{"type":"group","label":"People","link":"/openapi/people","routeSlug":"/openapi/people","items":[{"label":"Person detail lookup","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/people/datastorage_person_detail_lookup_create","routeSlug":"/openapi/people/datastorage_person_detail_lookup_create","metadata":{"seo":{"title":"Person detail lookup","description":"Do Person details lookup."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"datastorage_person_detail_lookup_create","name":"Person detail lookup","isWebhook":false,"pointer":"/paths/~1api~1{account_id}~1datastorage~1person_detail_lookup~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Person detail lookup","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Do Person details lookup."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Api-Key","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1person_detail_lookup~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PersonInfoRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/PersonInfoRequest"},"multipart/form-data":{"schemaId":"components/schemas/PersonInfoRequest"}},"schemaId":"components/schemas/PersonInfoRequest","pointer":"/paths/~1api~1{account_id}~1datastorage~1person_detail_lookup~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/{account_id}/datastorage/person_detail_lookup/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_13"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Api-Key","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PersonInfoRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/PersonInfoRequest"},"multipart/form-data":{"schemaId":"components/schemas/PersonInfoRequest"}},"responseCodes":["200"],"pointer":"/api/{account_id}/datastorage/person_detail_lookup/","href":"people/datastorage_person_detail_lookup_create","openApiOperationId":"datastorage_person_detail_lookup_create","summary":"Person detail lookup"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"schemaId":"components/schemas/PersonInfoRequest","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PersonInfoRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/PersonInfoRequest"},"multipart/form-data":{"schemaId":"components/schemas/PersonInfoRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PersonDetail"}},"schemaId":"components/schemas/PersonDetail"}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1person_detail_lookup~1/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PersonDetail","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PersonDetail"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/people/datastorage_person_detail_lookup_create"}],"panels":[]}]},"httpPath":"/api/{account_id}/datastorage/person_detail_lookup/"},{"label":"Person detail lookup by email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/people/datastorage_person_detail_reverse_lookup_by_email_create","routeSlug":"/openapi/people/datastorage_person_detail_reverse_lookup_by_email_create","metadata":{"seo":{"title":"Person detail lookup by email","description":"Do reverse lookup of person details by email."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"datastorage_person_detail_reverse_lookup_by_email_create","name":"Person detail lookup by email","isWebhook":false,"pointer":"/paths/~1api~1{account_id}~1datastorage~1person_detail_reverse_lookup~1by_email~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Person detail lookup by email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Do reverse lookup of person details by email."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Api-Key","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1person_detail_reverse_lookup~1by_email~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PersonReverseSearchByEmail"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/PersonReverseSearchByEmail"},"multipart/form-data":{"schemaId":"components/schemas/PersonReverseSearchByEmail"}},"schemaId":"components/schemas/PersonReverseSearchByEmail","pointer":"/paths/~1api~1{account_id}~1datastorage~1person_detail_reverse_lookup~1by_email~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/{account_id}/datastorage/person_detail_reverse_lookup/by_email/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_13"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Api-Key","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PersonReverseSearchByEmail"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/PersonReverseSearchByEmail"},"multipart/form-data":{"schemaId":"components/schemas/PersonReverseSearchByEmail"}},"responseCodes":["200"],"pointer":"/api/{account_id}/datastorage/person_detail_reverse_lookup/by_email/","href":"people/datastorage_person_detail_reverse_lookup_by_email_create","openApiOperationId":"datastorage_person_detail_reverse_lookup_by_email_create","summary":"Person detail lookup by email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"schemaId":"components/schemas/PersonReverseSearchByEmail","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PersonReverseSearchByEmail"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/PersonReverseSearchByEmail"},"multipart/form-data":{"schemaId":"components/schemas/PersonReverseSearchByEmail"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PersonDetail"}},"schemaId":"components/schemas/PersonDetail"}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1person_detail_reverse_lookup~1by_email~1/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PersonDetail","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PersonDetail"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/people/datastorage_person_detail_reverse_lookup_by_email_create"}],"panels":[]}]},"httpPath":"/api/{account_id}/datastorage/person_detail_reverse_lookup/by_email/"},{"label":"Person detail lookup by phone","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/people/datastorage_person_detail_reverse_lookup_by_phone_number_create","routeSlug":"/openapi/people/datastorage_person_detail_reverse_lookup_by_phone_number_create","metadata":{"seo":{"title":"Person detail lookup by phone","description":"Do reverse lookup of person details by phone number."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"datastorage_person_detail_reverse_lookup_by_phone_number_create","name":"Person detail lookup by phone","isWebhook":false,"pointer":"/paths/~1api~1{account_id}~1datastorage~1person_detail_reverse_lookup~1by_phone_number~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Person detail lookup by phone","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Do reverse lookup of person details by phone number."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Api-Key","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1person_detail_reverse_lookup~1by_phone_number~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PersonReverseSearchByPhoneNumber"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/PersonReverseSearchByPhoneNumber"},"multipart/form-data":{"schemaId":"components/schemas/PersonReverseSearchByPhoneNumber"}},"schemaId":"components/schemas/PersonReverseSearchByPhoneNumber","pointer":"/paths/~1api~1{account_id}~1datastorage~1person_detail_reverse_lookup~1by_phone_number~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/{account_id}/datastorage/person_detail_reverse_lookup/by_phone_number/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_13"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Api-Key","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PersonReverseSearchByPhoneNumber"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/PersonReverseSearchByPhoneNumber"},"multipart/form-data":{"schemaId":"components/schemas/PersonReverseSearchByPhoneNumber"}},"responseCodes":["200"],"pointer":"/api/{account_id}/datastorage/person_detail_reverse_lookup/by_phone_number/","href":"people/datastorage_person_detail_reverse_lookup_by_phone_number_create","openApiOperationId":"datastorage_person_detail_reverse_lookup_by_phone_number_create","summary":"Person detail lookup by phone"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"schemaId":"components/schemas/PersonReverseSearchByPhoneNumber","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PersonReverseSearchByPhoneNumber"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/PersonReverseSearchByPhoneNumber"},"multipart/form-data":{"schemaId":"components/schemas/PersonReverseSearchByPhoneNumber"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PersonDetail"}},"schemaId":"components/schemas/PersonDetail"}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1person_detail_reverse_lookup~1by_phone_number~1/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PersonDetail","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PersonDetail"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/people/datastorage_person_detail_reverse_lookup_by_phone_number_create"}],"panels":[]}]},"httpPath":"/api/{account_id}/datastorage/person_detail_reverse_lookup/by_phone_number/"},{"label":"Person role search","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/people/datastorage_person_role_search_create","routeSlug":"/openapi/people/datastorage_person_role_search_create","metadata":{"seo":{"title":"Person role search","description":"The Person Role Search endpoint lets you search for individuals based on their roles, titles, time periods, and associated organizations. You can filter by attributes like role title or description, current status, start/end dates, person name, skills, industry, and location. The response returns matching person records along with their role history and linked organization details (e.g. name, domain, founding date)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"datastorage_person_role_search_create","name":"Person role search","isWebhook":false,"pointer":"/paths/~1api~1{account_id}~1datastorage~1person_role_search~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Person role search","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The Person Role Search endpoint lets you search for individuals based on their roles, titles, time periods, and associated organizations. You can filter by attributes like role title or description, current status, start/end dates, person name, skills, industry, and location. The response returns matching person records along with their role history and linked organization details (e.g. name, domain, founding date)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Api-Key","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1person_role_search~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrganizationPersonRoleSearch"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/OrganizationPersonRoleSearch"},"multipart/form-data":{"schemaId":"components/schemas/OrganizationPersonRoleSearch"}},"schemaId":"components/schemas/OrganizationPersonRoleSearch","pointer":"/paths/~1api~1{account_id}~1datastorage~1person_role_search~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/{account_id}/datastorage/person_role_search/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_13"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Api-Key","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrganizationPersonRoleSearch"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/OrganizationPersonRoleSearch"},"multipart/form-data":{"schemaId":"components/schemas/OrganizationPersonRoleSearch"}},"responseCodes":["200"],"pointer":"/api/{account_id}/datastorage/person_role_search/","href":"people/datastorage_person_role_search_create","openApiOperationId":"datastorage_person_role_search_create","summary":"Person role search"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"schemaId":"components/schemas/OrganizationPersonRoleSearch","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrganizationPersonRoleSearch"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/OrganizationPersonRoleSearch"},"multipart/form-data":{"schemaId":"components/schemas/OrganizationPersonRoleSearch"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PersonRoleSearchResponse"}},"schemaId":"components/schemas/PersonRoleSearchResponse"}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1person_role_search~1/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PersonRoleSearchResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PersonRoleSearchResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/people/datastorage_person_role_search_create"}],"panels":[]}]},"httpPath":"/api/{account_id}/datastorage/person_role_search/"},{"label":"Person role search totals","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/people/datastorage_person_role_search_totals_create","routeSlug":"/openapi/people/datastorage_person_role_search_totals_create","metadata":{"seo":{"title":"Person role search totals","description":"Organization person role search totals."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"datastorage_person_role_search_totals_create","name":"Person role search totals","isWebhook":false,"pointer":"/paths/~1api~1{account_id}~1datastorage~1person_role_search~1totals~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Person role search totals","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Organization person role search totals."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Api-Key","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1person_role_search~1totals~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrganizationPersonRoleSearch"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/OrganizationPersonRoleSearch"},"multipart/form-data":{"schemaId":"components/schemas/OrganizationPersonRoleSearch"}},"schemaId":"components/schemas/OrganizationPersonRoleSearch","pointer":"/paths/~1api~1{account_id}~1datastorage~1person_role_search~1totals~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/{account_id}/datastorage/person_role_search/totals/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_13"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Api-Key","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrganizationPersonRoleSearch"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/OrganizationPersonRoleSearch"},"multipart/form-data":{"schemaId":"components/schemas/OrganizationPersonRoleSearch"}},"responseCodes":["200"],"pointer":"/api/{account_id}/datastorage/person_role_search/totals/","href":"people/datastorage_person_role_search_totals_create","openApiOperationId":"datastorage_person_role_search_totals_create","summary":"Person role search totals"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"schemaId":"components/schemas/OrganizationPersonRoleSearch","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrganizationPersonRoleSearch"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/OrganizationPersonRoleSearch"},"multipart/form-data":{"schemaId":"components/schemas/OrganizationPersonRoleSearch"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PersonRoleSearchTotalsResponse"}},"schemaId":"components/schemas/PersonRoleSearchTotalsResponse"}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1person_role_search~1totals~1/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PersonRoleSearchTotalsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PersonRoleSearchTotalsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/people/datastorage_person_role_search_totals_create"}],"panels":[]}]},"httpPath":"/api/{account_id}/datastorage/person_role_search/totals/"}],"content":{"contentType":"group","meta":{"name":"People"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"People","showPageActions":true},{"nodeType":"markdoc","content":"Look up people and their records. Use the search endpoints to find people by role, employer, location, or skills, and the detail-lookup endpoints to fetch a full person record by ID, email, or phone number. Contact data has its own sections: Phones, Personal Emails, and Work Emails."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/{account_id}/datastorage/person_detail_lookup/","summary":"Person detail lookup","prefix":{"name":"post","color":"post"},"badges":[],"link":"/people/datastorage_person_detail_lookup_create","deprecated":false},{"title":"/api/{account_id}/datastorage/person_detail_reverse_lookup/by_email/","summary":"Person detail lookup by email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/people/datastorage_person_detail_reverse_lookup_by_email_create","deprecated":false},{"title":"/api/{account_id}/datastorage/person_detail_reverse_lookup/by_phone_number/","summary":"Person detail lookup by phone","prefix":{"name":"post","color":"post"},"badges":[],"link":"/people/datastorage_person_detail_reverse_lookup_by_phone_number_create","deprecated":false},{"title":"/api/{account_id}/datastorage/person_role_search/","summary":"Person role search","prefix":{"name":"post","color":"post"},"badges":[],"link":"/people/datastorage_person_role_search_create","deprecated":false},{"title":"/api/{account_id}/datastorage/person_role_search/totals/","summary":"Person role search totals","prefix":{"name":"post","color":"post"},"badges":[],"link":"/people/datastorage_person_role_search_totals_create","deprecated":false}]}]}]}]}},{"type":"group","label":"Phones","link":"/openapi/phones","routeSlug":"/openapi/phones","items":[{"label":"Phone numbers lookup","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/phones/datastorage_person_contacts_lookup_phone_numbers_create","routeSlug":"/openapi/phones/datastorage_person_contacts_lookup_phone_numbers_create","metadata":{"seo":{"title":"Phone numbers lookup","description":"The Person Phone Numbers Lookup endpoint retrieves phone numbers associated with an individual in the Forager dataset. It allows you to input identifying information (such as Linkedin handle or Forager ID) and returns available phone numbers. This API is useful for enriching person records, supporting lead generation, and verifying phone contact details within your applications."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"datastorage_person_contacts_lookup_phone_numbers_create","name":"Phone numbers lookup","isWebhook":false,"pointer":"/paths/~1api~1{account_id}~1datastorage~1person_contacts_lookup~1phone_numbers~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Phone numbers lookup","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The Person Phone Numbers Lookup endpoint retrieves phone numbers associated with an individual in the Forager dataset. It allows you to input identifying information (such as Linkedin handle or Forager ID) and returns available phone numbers. This API is useful for enriching person records, supporting lead generation, and verifying phone contact details within your applications."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Api-Key","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1person_contacts_lookup~1phone_numbers~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PersonInfoRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/PersonInfoRequest"},"multipart/form-data":{"schemaId":"components/schemas/PersonInfoRequest"}},"schemaId":"components/schemas/PersonInfoRequest","pointer":"/paths/~1api~1{account_id}~1datastorage~1person_contacts_lookup~1phone_numbers~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/{account_id}/datastorage/person_contacts_lookup/phone_numbers/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_13"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Api-Key","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PersonInfoRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/PersonInfoRequest"},"multipart/form-data":{"schemaId":"components/schemas/PersonInfoRequest"}},"responseCodes":["200"],"pointer":"/api/{account_id}/datastorage/person_contacts_lookup/phone_numbers/","href":"phones/datastorage_person_contacts_lookup_phone_numbers_create","openApiOperationId":"datastorage_person_contacts_lookup_phone_numbers_create","summary":"Phone numbers lookup"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"schemaId":"components/schemas/PersonInfoRequest","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PersonInfoRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/PersonInfoRequest"},"multipart/form-data":{"schemaId":"components/schemas/PersonInfoRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_14"}},"schemaId":"schema_14"}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1person_contacts_lookup~1phone_numbers~1/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_14","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_14"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/phones/datastorage_person_contacts_lookup_phone_numbers_create"}],"panels":[]}]},"httpPath":"/api/{account_id}/datastorage/person_contacts_lookup/phone_numbers/"}],"content":{"contentType":"group","meta":{"name":"Phones"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Phones","showPageActions":true},{"nodeType":"markdoc","content":"Retrieve phone numbers for a known person. Provide identifying information (such as a LinkedIn handle or Forager ID) and get back the available phone numbers."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/{account_id}/datastorage/person_contacts_lookup/phone_numbers/","summary":"Phone numbers lookup","prefix":{"name":"post","color":"post"},"badges":[],"link":"/phones/datastorage_person_contacts_lookup_phone_numbers_create","deprecated":false}]}]}]}]}},{"type":"group","label":"Personal Emails","link":"/openapi/personal-emails","routeSlug":"/openapi/personal-emails","items":[{"label":"Personal emails lookup","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/personal-emails/datastorage_person_contacts_lookup_personal_emails_create","routeSlug":"/openapi/personal-emails/datastorage_person_contacts_lookup_personal_emails_create","metadata":{"seo":{"title":"Personal emails lookup","description":"The Person Personal Emails Lookup endpoint retrieves personal email addresses associated with an individual in the Forager dataset. It allows you to input identifying information (such as Linkedin handle or Forager ID) and returns available personal contact emails. The endpoint returns only addresses on free webmail / consumer providers (Gmail, Outlook, Yahoo, iCloud, Proton, and similar). Addresses on corporate domains, educational domains (e.g., .edu, .ac.uk), and any other custom domains are excluded — including custom domains a person uses for personal purposes — to keep deliverability of the returned set high. If the filtered set is empty, the endpoint returns 200 OK with an empty body and does not consume credits."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"datastorage_person_contacts_lookup_personal_emails_create","name":"Personal emails lookup","isWebhook":false,"pointer":"/paths/~1api~1{account_id}~1datastorage~1person_contacts_lookup~1personal_emails~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Personal emails lookup","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Person Personal Emails Lookup endpoint retrieves personal email addresses associated with an individual in the Forager dataset. It allows you to input identifying information (such as Linkedin handle or Forager ID) and returns available personal contact emails. The endpoint returns only addresses on free webmail / consumer providers (Gmail, Outlook, Yahoo, iCloud, Proton, and similar). Addresses on corporate domains, educational domains (e.g., .edu, .ac.uk), and any other custom domains are excluded — including custom domains a person uses for personal purposes — to keep deliverability of the returned set high. If the filtered set is empty, the endpoint returns 200 OK with an empty body and does not consume credits."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Api-Key","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1person_contacts_lookup~1personal_emails~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PersonInfoRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/PersonInfoRequest"},"multipart/form-data":{"schemaId":"components/schemas/PersonInfoRequest"}},"schemaId":"components/schemas/PersonInfoRequest","pointer":"/paths/~1api~1{account_id}~1datastorage~1person_contacts_lookup~1personal_emails~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/{account_id}/datastorage/person_contacts_lookup/personal_emails/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_13"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Api-Key","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PersonInfoRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/PersonInfoRequest"},"multipart/form-data":{"schemaId":"components/schemas/PersonInfoRequest"}},"responseCodes":["200"],"pointer":"/api/{account_id}/datastorage/person_contacts_lookup/personal_emails/","href":"personal-emails/datastorage_person_contacts_lookup_personal_emails_create","openApiOperationId":"datastorage_person_contacts_lookup_personal_emails_create","summary":"Personal emails lookup"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"schemaId":"components/schemas/PersonInfoRequest","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PersonInfoRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/PersonInfoRequest"},"multipart/form-data":{"schemaId":"components/schemas/PersonInfoRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_15"}},"schemaId":"schema_15"}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1person_contacts_lookup~1personal_emails~1/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_15","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_15"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/personal-emails/datastorage_person_contacts_lookup_personal_emails_create"}],"panels":[]}]},"httpPath":"/api/{account_id}/datastorage/person_contacts_lookup/personal_emails/"}],"content":{"contentType":"group","meta":{"name":"Personal Emails"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Personal Emails","showPageActions":true},{"nodeType":"markdoc","content":"Retrieve personal email addresses for a known person. Returns addresses on free webmail / consumer providers (Gmail, Outlook, Yahoo, iCloud, Proton, and similar); corporate, educational, and other custom domains are excluded to keep deliverability high."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/{account_id}/datastorage/person_contacts_lookup/personal_emails/","summary":"Personal emails lookup","prefix":{"name":"post","color":"post"},"badges":[],"link":"/personal-emails/datastorage_person_contacts_lookup_personal_emails_create","deprecated":false}]}]}]}]}},{"type":"group","label":"Work Emails","link":"/openapi/work-emails","routeSlug":"/openapi/work-emails","items":[{"label":"Single work email lookup","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/work-emails/v2_datastorage_person_contacts_lookup_work_emails_create","routeSlug":"/openapi/work-emails/v2_datastorage_person_contacts_lookup_work_emails_create","metadata":{"seo":{"title":"Single work email lookup","description":"Start a work email lookup and return immediately with a job id. Identify the person either by first_name, last_name and domain, or by linkedin_public_identifier, in which case the name and the domain of their current employer are taken from the Forager dataset. The lookup itself runs asynchronously because proving an address is deliverable takes longer than a request should wait: poll the returned status_check_url until status is completed or failed. Credits are charged once, only when an address is found, and polling is always free. This endpoint is rate limited for interactive use - for enrichment runs use the bulk endpoint, which is both faster and cheaper for us to serve."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_datastorage_person_contacts_lookup_work_emails_create","name":"Single work email lookup","isWebhook":false,"pointer":"/paths/~1api~1v2~1{account_id}~1datastorage~1person_contacts_lookup~1work_emails~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Single work email lookup","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start a work email lookup and return immediately with a job id. Identify the person either by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_public_identifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", in which case the name and the domain of their current employer are taken from the Forager dataset. The lookup itself runs asynchronously because proving an address is deliverable takes longer than a request should wait: poll the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status_check_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Credits are charged once, only when an address is found, and polling is always free. This endpoint is rate limited for interactive use - for enrichment runs use the bulk endpoint, which is both faster and cheaper for us to serve."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Api-Key","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1api~1v2~1{account_id}~1datastorage~1person_contacts_lookup~1work_emails~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WorkEmailLookupSubmitRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/WorkEmailLookupSubmitRequest"},"multipart/form-data":{"schemaId":"components/schemas/WorkEmailLookupSubmitRequest"}},"schemaId":"components/schemas/WorkEmailLookupSubmitRequest","pointer":"/paths/~1api~1v2~1{account_id}~1datastorage~1person_contacts_lookup~1work_emails~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/{account_id}/datastorage/person_contacts_lookup/work_emails/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_13"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Api-Key","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WorkEmailLookupSubmitRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/WorkEmailLookupSubmitRequest"},"multipart/form-data":{"schemaId":"components/schemas/WorkEmailLookupSubmitRequest"}},"responseCodes":["202"],"pointer":"/api/v2/{account_id}/datastorage/person_contacts_lookup/work_emails/","href":"work-emails/v2_datastorage_person_contacts_lookup_work_emails_create","openApiOperationId":"v2_datastorage_person_contacts_lookup_work_emails_create","summary":"Single work email lookup"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"schemaId":"components/schemas/WorkEmailLookupSubmitRequest","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WorkEmailLookupSubmitRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/WorkEmailLookupSubmitRequest"},"multipart/form-data":{"schemaId":"components/schemas/WorkEmailLookupSubmitRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkEmailLookupSubmitted"}},"schemaId":"components/schemas/WorkEmailLookupSubmitted"}],"pointer":"/paths/~1api~1v2~1{account_id}~1datastorage~1person_contacts_lookup~1work_emails~1/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"components/schemas/WorkEmailLookupSubmitted","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkEmailLookupSubmitted"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/work-emails/v2_datastorage_person_contacts_lookup_work_emails_create"}],"panels":[]}]},"httpPath":"/api/v2/{account_id}/datastorage/person_contacts_lookup/work_emails/"},{"label":"Single work email lookup result","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/work-emails/v2_datastorage_person_contacts_lookup_work_emails_retrieve","routeSlug":"/openapi/work-emails/v2_datastorage_person_contacts_lookup_work_emails_retrieve","metadata":{"seo":{"title":"Single work email lookup result","description":"Return the current state of a work email lookup. status describes the job (queued, running, awaiting_provider, completed, failed) and result describes the outcome once it is terminal (found or not_found). While the job is not terminal a Retry-After header suggests when to poll again. Polling never consumes credits."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_datastorage_person_contacts_lookup_work_emails_retrieve","name":"Single work email lookup result","isWebhook":false,"pointer":"/paths/~1api~1v2~1{account_id}~1datastorage~1person_contacts_lookup~1work_emails~1{job_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Single work email lookup result","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return the current state of a work email lookup. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" describes the job ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"queued"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"running"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"awaiting_provider"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"result"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" describes the outcome once it is terminal ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). While the job is not terminal a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header suggests when to poll again. Polling never consumes credits."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Api-Key","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_13","required":true},{"name":"job_id","in":"path","schemaId":"schema_16","required":true}],"pointer":"/paths/~1api~1v2~1{account_id}~1datastorage~1person_contacts_lookup~1work_emails~1{job_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/{account_id}/datastorage/person_contacts_lookup/work_emails/{job_id}/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_13"},{"name":"job_id","in":"path","required":true,"schemaId":"schema_16"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Api-Key","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/v2/{account_id}/datastorage/person_contacts_lookup/work_emails/{job_id}/","href":"work-emails/v2_datastorage_person_contacts_lookup_work_emails_retrieve","openApiOperationId":"v2_datastorage_person_contacts_lookup_work_emails_retrieve","summary":"Single work email lookup result"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkEmailLookupJob"}},"schemaId":"components/schemas/WorkEmailLookupJob"}],"pointer":"/paths/~1api~1v2~1{account_id}~1datastorage~1person_contacts_lookup~1work_emails~1{job_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkEmailLookupJob","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkEmailLookupJob"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/work-emails/v2_datastorage_person_contacts_lookup_work_emails_retrieve"}],"panels":[]}]},"httpPath":"/api/v2/{account_id}/datastorage/person_contacts_lookup/work_emails/{job_id}/"},{"label":"Bulk work email lookup","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/work-emails/v2_datastorage_person_contacts_lookup_work_emails_bulk_create","routeSlug":"/openapi/work-emails/v2_datastorage_person_contacts_lookup_work_emails_bulk_create","metadata":{"seo":{"title":"Bulk work email lookup","description":"Submit many work email lookups in one request. Items already answered by our cache are resolved immediately at no vendor cost and reported as resolved_from_cache; duplicates within the request collapse into a single lookup. Your credit balance must cover the whole batch, otherwise the batch is rejected and nothing is charged. Poll the batch for progress and its items endpoint for per-lookup results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_datastorage_person_contacts_lookup_work_emails_bulk_create","name":"Bulk work email lookup","isWebhook":false,"pointer":"/paths/~1api~1v2~1{account_id}~1datastorage~1person_contacts_lookup~1work_emails~1bulk~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk work email lookup","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submit many work email lookups in one request. Items already answered by our cache are resolved immediately at no vendor cost and reported as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resolved_from_cache"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; duplicates within the request collapse into a single lookup. Your credit balance must cover the whole batch, otherwise the batch is rejected and nothing is charged. Poll the batch for progress and its items endpoint for per-lookup results."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Api-Key","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1api~1v2~1{account_id}~1datastorage~1person_contacts_lookup~1work_emails~1bulk~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WorkEmailBulkRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/WorkEmailBulkRequest"},"multipart/form-data":{"schemaId":"components/schemas/WorkEmailBulkRequest"}},"schemaId":"components/schemas/WorkEmailBulkRequest","pointer":"/paths/~1api~1v2~1{account_id}~1datastorage~1person_contacts_lookup~1work_emails~1bulk~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v2/{account_id}/datastorage/person_contacts_lookup/work_emails/bulk/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_13"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Api-Key","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WorkEmailBulkRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/WorkEmailBulkRequest"},"multipart/form-data":{"schemaId":"components/schemas/WorkEmailBulkRequest"}},"responseCodes":["202"],"pointer":"/api/v2/{account_id}/datastorage/person_contacts_lookup/work_emails/bulk/","href":"work-emails/v2_datastorage_person_contacts_lookup_work_emails_bulk_create","openApiOperationId":"v2_datastorage_person_contacts_lookup_work_emails_bulk_create","summary":"Bulk work email lookup"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"schemaId":"components/schemas/WorkEmailBulkRequest","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WorkEmailBulkRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/WorkEmailBulkRequest"},"multipart/form-data":{"schemaId":"components/schemas/WorkEmailBulkRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkEmailBatchSubmitted"}},"schemaId":"components/schemas/WorkEmailBatchSubmitted"}],"pointer":"/paths/~1api~1v2~1{account_id}~1datastorage~1person_contacts_lookup~1work_emails~1bulk~1/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"components/schemas/WorkEmailBatchSubmitted","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkEmailBatchSubmitted"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/work-emails/v2_datastorage_person_contacts_lookup_work_emails_bulk_create"}],"panels":[]}]},"httpPath":"/api/v2/{account_id}/datastorage/person_contacts_lookup/work_emails/bulk/"},{"label":"Bulk work email lookup status and results","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/work-emails/v2_datastorage_person_contacts_lookup_work_emails_bulk_retrieve","routeSlug":"/openapi/work-emails/v2_datastorage_person_contacts_lookup_work_emails_bulk_retrieve","metadata":{"seo":{"title":"Bulk work email lookup status and results","description":"Return a bulk work email lookup batch. Poll until status is completed, at which point results holds one result per submitted lookup, in the order they were submitted, each with the same shape as a single lookup result. results is empty until then, so a partial answer is never mistaken for a whole one."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v2_datastorage_person_contacts_lookup_work_emails_bulk_retrieve","name":"Bulk work email lookup status and results","isWebhook":false,"pointer":"/paths/~1api~1v2~1{account_id}~1datastorage~1person_contacts_lookup~1work_emails~1bulk~1{batch_id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk work email lookup status and results","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return a bulk work email lookup batch. Poll until "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", at which point "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" holds one result per submitted lookup, in the order they were submitted, each with the same shape as a single lookup result. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is empty until then, so a partial answer is never mistaken for a whole one."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Api-Key","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_13","required":true},{"name":"batch_id","in":"path","schemaId":"schema_16","required":true}],"pointer":"/paths/~1api~1v2~1{account_id}~1datastorage~1person_contacts_lookup~1work_emails~1bulk~1{batch_id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v2/{account_id}/datastorage/person_contacts_lookup/work_emails/bulk/{batch_id}/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_13"},{"name":"batch_id","in":"path","required":true,"schemaId":"schema_16"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Api-Key","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/v2/{account_id}/datastorage/person_contacts_lookup/work_emails/bulk/{batch_id}/","href":"work-emails/v2_datastorage_person_contacts_lookup_work_emails_bulk_retrieve","openApiOperationId":"v2_datastorage_person_contacts_lookup_work_emails_bulk_retrieve","summary":"Bulk work email lookup status and results"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkEmailBatch"}},"schemaId":"components/schemas/WorkEmailBatch"}],"pointer":"/paths/~1api~1v2~1{account_id}~1datastorage~1person_contacts_lookup~1work_emails~1bulk~1{batch_id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkEmailBatch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkEmailBatch"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/work-emails/v2_datastorage_person_contacts_lookup_work_emails_bulk_retrieve"}],"panels":[]}]},"httpPath":"/api/v2/{account_id}/datastorage/person_contacts_lookup/work_emails/bulk/{batch_id}/"}],"content":{"contentType":"group","meta":{"name":"Work Emails"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Work Emails","showPageActions":true},{"nodeType":"markdoc","content":"Find and verify a person's work email address. Submit a lookup (single or bulk), poll the job for its result, and optionally receive the result by webhook when the job completes."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v2/{account_id}/datastorage/person_contacts_lookup/work_emails/","summary":"Single work email lookup","prefix":{"name":"post","color":"post"},"badges":[],"link":"/work-emails/v2_datastorage_person_contacts_lookup_work_emails_create","deprecated":false},{"title":"/api/v2/{account_id}/datastorage/person_contacts_lookup/work_emails/{job_id}/","summary":"Single work email lookup result","prefix":{"name":"get","color":"get"},"badges":[],"link":"/work-emails/v2_datastorage_person_contacts_lookup_work_emails_retrieve","deprecated":false},{"title":"/api/v2/{account_id}/datastorage/person_contacts_lookup/work_emails/bulk/","summary":"Bulk work email lookup","prefix":{"name":"post","color":"post"},"badges":[],"link":"/work-emails/v2_datastorage_person_contacts_lookup_work_emails_bulk_create","deprecated":false},{"title":"/api/v2/{account_id}/datastorage/person_contacts_lookup/work_emails/bulk/{batch_id}/","summary":"Bulk work email lookup status and results","prefix":{"name":"get","color":"get"},"badges":[],"link":"/work-emails/v2_datastorage_person_contacts_lookup_work_emails_bulk_retrieve","deprecated":false}]}]}]}]}},{"type":"group","label":"Websites","link":"/openapi/websites","routeSlug":"/openapi/websites","items":[{"label":"Website Details Lookup","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/websites/datastorage_website_detail_lookup_create","routeSlug":"/openapi/websites/datastorage_website_detail_lookup_create","metadata":{"seo":{"title":"Website Details Lookup","description":"The Website Details Lookup endpoint retrieves detailed information about a specific website, including its domain, web rank, traffic, and associated web technologies. This API is useful for analyzing website performance, understanding technology stack, and integrating website data into your applications."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"datastorage_website_detail_lookup_create","name":"Website Details Lookup","isWebhook":false,"pointer":"/paths/~1api~1{account_id}~1datastorage~1website_detail_lookup~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Website Details Lookup","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The Website Details Lookup endpoint retrieves detailed information about a specific website, including its domain, web rank, traffic, and associated web technologies. This API is useful for analyzing website performance, understanding technology stack, and integrating website data into your applications."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Api-Key","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1website_detail_lookup~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebSiteLookupRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/WebSiteLookupRequest"},"multipart/form-data":{"schemaId":"components/schemas/WebSiteLookupRequest"}},"schemaId":"components/schemas/WebSiteLookupRequest","pointer":"/paths/~1api~1{account_id}~1datastorage~1website_detail_lookup~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/{account_id}/datastorage/website_detail_lookup/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_13"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Api-Key","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebSiteLookupRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/WebSiteLookupRequest"},"multipart/form-data":{"schemaId":"components/schemas/WebSiteLookupRequest"}},"responseCodes":["200"],"pointer":"/api/{account_id}/datastorage/website_detail_lookup/","href":"websites/datastorage_website_detail_lookup_create","openApiOperationId":"datastorage_website_detail_lookup_create","summary":"Website Details Lookup"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"schemaId":"components/schemas/WebSiteLookupRequest","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebSiteLookupRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/WebSiteLookupRequest"},"multipart/form-data":{"schemaId":"components/schemas/WebSiteLookupRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebSite"}},"schemaId":"components/schemas/WebSite"}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1website_detail_lookup~1/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebSite","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebSite"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/websites/datastorage_website_detail_lookup_create"}],"panels":[]}]},"httpPath":"/api/{account_id}/datastorage/website_detail_lookup/"}],"content":{"contentType":"group","meta":{"name":"Websites"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Websites","showPageActions":true},{"nodeType":"markdoc","content":"Look up information about a website, including the organization that owns it and the technologies detected on the domain."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/{account_id}/datastorage/website_detail_lookup/","summary":"Website Details Lookup","prefix":{"name":"post","color":"post"},"badges":[],"link":"/websites/datastorage_website_detail_lookup_create","deprecated":false}]}]}]}]}},{"type":"group","label":"Users","link":"/openapi/users","routeSlug":"/openapi/users","items":[{"label":"Credit Balance Change Log","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/subscriptions_balance_change_logs_list","routeSlug":"/openapi/users/subscriptions_balance_change_logs_list","metadata":{"seo":{"title":"Credit Balance Change Log","description":"The Credit Balance Change Log endpoint provides a list of all credit balance change logs related to the current subscription. It returns a list of credit balance change logs, including the change type, change sum, and change data. This endpoint is useful for tracking and analyzing credit consumption patterns, monitoring usage, and ensuring proper subscription management."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subscriptions_balance_change_logs_list","name":"Credit Balance Change Log","isWebhook":false,"pointer":"/paths/~1api~1{account_id}~1subscriptions~1balance_change_logs~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credit Balance Change Log","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The Credit Balance Change Log endpoint provides a list of all credit balance change logs related to the current subscription. It returns a list of credit balance change logs, including the change type, change sum, and change data. This endpoint is useful for tracking and analyzing credit consumption patterns, monitoring usage, and ensuring proper subscription management."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Api-Key","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1api~1{account_id}~1subscriptions~1balance_change_logs~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"date_created_end","in":"query","schemaId":"schema_17"},{"name":"date_created_start","in":"query","schemaId":"schema_17"},{"name":"page","in":"query","schemaId":"schema_13","description":"A page number within the paginated result set."}],"pointer":"/paths/~1api~1{account_id}~1subscriptions~1balance_change_logs~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/{account_id}/subscriptions/balance_change_logs/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_13"}],"query":[{"name":"date_created_end","in":"query","schemaId":"schema_17"},{"name":"date_created_start","in":"query","schemaId":"schema_17"},{"name":"page","in":"query","required":false,"schemaId":"schema_13"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Api-Key","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/{account_id}/subscriptions/balance_change_logs/","href":"users/subscriptions_balance_change_logs_list","openApiOperationId":"subscriptions_balance_change_logs_list","summary":"Credit Balance Change Log"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginatedCreditsBalanceChangeLogList"}},"schemaId":"components/schemas/PaginatedCreditsBalanceChangeLogList"}],"pointer":"/paths/~1api~1{account_id}~1subscriptions~1balance_change_logs~1/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PaginatedCreditsBalanceChangeLogList","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PaginatedCreditsBalanceChangeLogList"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/subscriptions_balance_change_logs_list"}],"panels":[]}]},"httpPath":"/api/{account_id}/subscriptions/balance_change_logs/"},{"label":"Credit Consumption Totals","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/subscriptions_balance_change_logs_totals_retrieve","routeSlug":"/openapi/users/subscriptions_balance_change_logs_totals_retrieve","metadata":{"seo":{"title":"Credit Consumption Totals","description":"The Credit Consumption Totals endpoint calculates the total amount of credits spent during a specified timeframe. It returns the sum of all credit changes that have been made to the subscription balance during the given period. This endpoint is useful for tracking and analyzing credit consumption patterns, monitoring usage, and ensuring proper subscription management."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"subscriptions_balance_change_logs_totals_retrieve","name":"Credit Consumption Totals","isWebhook":false,"pointer":"/paths/~1api~1{account_id}~1subscriptions~1balance_change_logs~1totals~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credit Consumption Totals","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The Credit Consumption Totals endpoint calculates the total amount of credits spent during a specified timeframe. It returns the sum of all credit changes that have been made to the subscription balance during the given period. This endpoint is useful for tracking and analyzing credit consumption patterns, monitoring usage, and ensuring proper subscription management."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Api-Key","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1api~1{account_id}~1subscriptions~1balance_change_logs~1totals~1/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"date_created_end","in":"query","schemaId":"schema_17"},{"name":"date_created_start","in":"query","schemaId":"schema_17"}],"pointer":"/paths/~1api~1{account_id}~1subscriptions~1balance_change_logs~1totals~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/{account_id}/subscriptions/balance_change_logs/totals/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_13"}],"query":[{"name":"date_created_end","in":"query","schemaId":"schema_17"},{"name":"date_created_start","in":"query","schemaId":"schema_17"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Api-Key","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/{account_id}/subscriptions/balance_change_logs/totals/","href":"users/subscriptions_balance_change_logs_totals_retrieve","openApiOperationId":"subscriptions_balance_change_logs_totals_retrieve","summary":"Credit Consumption Totals"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TotalCreditsSpent"}},"schemaId":"components/schemas/TotalCreditsSpent"}],"pointer":"/paths/~1api~1{account_id}~1subscriptions~1balance_change_logs~1totals~1/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TotalCreditsSpent","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TotalCreditsSpent"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/subscriptions_balance_change_logs_totals_retrieve"}],"panels":[]}]},"httpPath":"/api/{account_id}/subscriptions/balance_change_logs/totals/"},{"label":"List API keys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/api_keys_list","routeSlug":"/openapi/users/api_keys_list","metadata":{"seo":{"title":"List API keys","description":"API view for managing API keys."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api_keys_list","name":"List API keys","isWebhook":false,"pointer":"/paths/~1api~1api_keys~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List API keys","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API view for managing API keys."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Api-Key","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/api_keys/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Api-Key","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/api_keys/","href":"users/api_keys_list","openApiOperationId":"api_keys_list","summary":"List API keys"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_18"}},"schemaId":"schema_18"}],"pointer":"/paths/~1api~1api_keys~1/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_18","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_18"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/api_keys_list"}],"panels":[]}]},"httpPath":"/api/api_keys/"},{"label":"Create a new API key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/api_keys_create","routeSlug":"/openapi/users/api_keys_create","metadata":{"seo":{"title":"Create a new API key","description":"Handle creation of a new API key."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api_keys_create","name":"Create a new API key","isWebhook":false,"pointer":"/paths/~1api~1api_keys~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new API key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Handle creation of a new API key."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Api-Key","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/APIKey"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/APIKey"},"multipart/form-data":{"schemaId":"components/schemas/APIKey"}},"schemaId":"components/schemas/APIKey","pointer":"/paths/~1api~1api_keys~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/api_keys/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Api-Key","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/APIKey"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/APIKey"},"multipart/form-data":{"schemaId":"components/schemas/APIKey"}},"responseCodes":["201"],"pointer":"/api/api_keys/","href":"users/api_keys_create","openApiOperationId":"api_keys_create","summary":"Create a new API key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"schemaId":"components/schemas/APIKey","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/APIKey"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/APIKey"},"multipart/form-data":{"schemaId":"components/schemas/APIKey"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIKey"}},"schemaId":"components/schemas/APIKey"}],"pointer":"/paths/~1api~1api_keys~1/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/APIKey","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIKey"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/api_keys_create"}],"panels":[]}]},"httpPath":"/api/api_keys/"},{"label":"View API key details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/api_keys_retrieve","routeSlug":"/openapi/users/api_keys_retrieve","metadata":{"seo":{"title":"View API key details","description":"API view for managing API keys."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api_keys_retrieve","name":"View API key details","isWebhook":false,"pointer":"/paths/~1api~1api_keys~1{prefix}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"View API key details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API view for managing API keys."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Api-Key","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"prefix","in":"path","schemaId":"schema_19","required":true}],"pointer":"/paths/~1api~1api_keys~1{prefix}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/api_keys/{prefix}/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[{"name":"prefix","in":"path","required":true,"schemaId":"schema_19"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Api-Key","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/api_keys/{prefix}/","href":"users/api_keys_retrieve","openApiOperationId":"api_keys_retrieve","summary":"View API key details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIKey"}},"schemaId":"components/schemas/APIKey"}],"pointer":"/paths/~1api~1api_keys~1{prefix}~1/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/APIKey","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/APIKey"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/api_keys_retrieve"}],"panels":[]}]},"httpPath":"/api/api_keys/{prefix}/"},{"label":"Delete API key","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/api_keys_destroy","routeSlug":"/openapi/users/api_keys_destroy","metadata":{"seo":{"title":"Delete API key","description":"API view for managing API keys."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"api_keys_destroy","name":"Delete API key","isWebhook":false,"pointer":"/paths/~1api~1api_keys~1{prefix}~1/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete API key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"API view for managing API keys."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Api-Key","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"prefix","in":"path","schemaId":"schema_19","required":true}],"pointer":"/paths/~1api~1api_keys~1{prefix}~1/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/api_keys/{prefix}/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[{"name":"prefix","in":"path","required":true,"schemaId":"schema_19"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Api-Key","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["204"],"pointer":"/api/api_keys/{prefix}/","href":"users/api_keys_destroy","openApiOperationId":"api_keys_destroy","summary":"Delete API key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No response body"}],"pointer":"/paths/~1api~1api_keys~1{prefix}~1/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/api_keys_destroy"}],"panels":[]}]},"httpPath":"/api/api_keys/{prefix}/"},{"label":"View user information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/users_current_retrieve","routeSlug":"/openapi/users/users_current_retrieve","metadata":{"seo":{"title":"View user information","description":"A view to retrieve current user details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"users_current_retrieve","name":"View user information","isWebhook":false,"pointer":"/paths/~1api~1users~1current~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"View user information","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"A view to retrieve current user details."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Api-Key","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/users/current/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Api-Key","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/users/current/","href":"users/users_current_retrieve","openApiOperationId":"users_current_retrieve","summary":"View user information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}},"schemaId":"components/schemas/User"}],"pointer":"/paths/~1api~1users~1current~1/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/User","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/users_current_retrieve"}],"panels":[]}]},"httpPath":"/api/users/current/"}],"content":{"contentType":"group","meta":{"name":"Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Users","showPageActions":true},{"nodeType":"markdoc","content":"Manage your Forager account. Retrieve the current authenticated user, create and revoke API keys used to authenticate requests to the rest of the API, and review the credit balance-change log that records every lookup charge or adjustment against your account."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/{account_id}/subscriptions/balance_change_logs/","summary":"Credit Balance Change Log","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/subscriptions_balance_change_logs_list","deprecated":false},{"title":"/api/{account_id}/subscriptions/balance_change_logs/totals/","summary":"Credit Consumption Totals","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/subscriptions_balance_change_logs_totals_retrieve","deprecated":false},{"title":"/api/api_keys/","summary":"List API keys","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/api_keys_list","deprecated":false},{"title":"/api/api_keys/","summary":"Create a new API key","prefix":{"name":"post","color":"post"},"badges":[],"link":"/users/api_keys_create","deprecated":false},{"title":"/api/api_keys/{prefix}/","summary":"View API key details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/api_keys_retrieve","deprecated":false},{"title":"/api/api_keys/{prefix}/","summary":"Delete API key","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/users/api_keys_destroy","deprecated":false},{"title":"/api/users/current/","summary":"View user information","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/users_current_retrieve","deprecated":false}]}]}]}]}},{"type":"group","label":"Autocomplete","link":"/openapi/autocomplete","routeSlug":"/openapi/autocomplete","items":[{"label":"Industries lookup","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/autocomplete/v1_industry_lookup","routeSlug":"/openapi/autocomplete/v1_industry_lookup","metadata":{"seo":{"title":"Industries lookup","description":"Industries objects lookup."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v1_industry_lookup","name":"Industries lookup","isWebhook":false,"pointer":"/paths/~1api~1{account_id}~1datastorage~1autocomplete~1industries~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Industries lookup","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"id":"v1_industry_lookup"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Industries objects lookup."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"q","in":"query","schemaId":"schema_19","description":"Industry name.","required":true},{"name":"page","in":"query","schemaId":"schema_13"}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1autocomplete~1industries~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/{account_id}/datastorage/autocomplete/industries/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[],"query":[{"name":"q","in":"query","required":true,"schemaId":"schema_19"},{"name":"page","in":"query","required":false,"schemaId":"schema_13"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/api/{account_id}/datastorage/autocomplete/industries/","href":"autocomplete/v1_industry_lookup","openApiOperationId":"v1_industry_lookup","summary":"Industries lookup"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Valid response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_20"}},"schemaId":"schema_20"}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1autocomplete~1industries~1/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_20","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_20"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/autocomplete/v1_industry_lookup"}],"panels":[]}]},"httpPath":"/api/{account_id}/datastorage/autocomplete/industries/"},{"label":"Organizations lookup","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/autocomplete/v1_organization_lookup","routeSlug":"/openapi/autocomplete/v1_organization_lookup","metadata":{"seo":{"title":"Organizations lookup","description":"Organizations objects lookup."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v1_organization_lookup","name":"Organizations lookup","isWebhook":false,"pointer":"/paths/~1api~1{account_id}~1datastorage~1autocomplete~1organizations~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Organizations lookup","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"id":"v1_organization_lookup"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organizations objects lookup."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"q","in":"query","schemaId":"schema_19","description":"Organization name or domain.","required":true},{"name":"page","in":"query","schemaId":"schema_13"}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1autocomplete~1organizations~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/{account_id}/datastorage/autocomplete/organizations/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[],"query":[{"name":"q","in":"query","required":true,"schemaId":"schema_19"},{"name":"page","in":"query","required":false,"schemaId":"schema_13"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/api/{account_id}/datastorage/autocomplete/organizations/","href":"autocomplete/v1_organization_lookup","openApiOperationId":"v1_organization_lookup","summary":"Organizations lookup"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Valid response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_21"}},"schemaId":"schema_21"}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1autocomplete~1organizations~1/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_21","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_21"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/autocomplete/v1_organization_lookup"}],"panels":[]}]},"httpPath":"/api/{account_id}/datastorage/autocomplete/organizations/"},{"label":"Organization keywords lookup","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/autocomplete/v1_organization_keyword_lookup","routeSlug":"/openapi/autocomplete/v1_organization_keyword_lookup","metadata":{"seo":{"title":"Organization keywords lookup","description":"Organization keywords objects lookup."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v1_organization_keyword_lookup","name":"Organization keywords lookup","isWebhook":false,"pointer":"/paths/~1api~1{account_id}~1datastorage~1autocomplete~1organization_keywords~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Organization keywords lookup","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"id":"v1_organization_keyword_lookup"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organization keywords objects lookup."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"q","in":"query","schemaId":"schema_19","description":"Organization keyword name.","required":true},{"name":"page","in":"query","schemaId":"schema_13"}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1autocomplete~1organization_keywords~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/{account_id}/datastorage/autocomplete/organization_keywords/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[],"query":[{"name":"q","in":"query","required":true,"schemaId":"schema_19"},{"name":"page","in":"query","required":false,"schemaId":"schema_13"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/api/{account_id}/datastorage/autocomplete/organization_keywords/","href":"autocomplete/v1_organization_keyword_lookup","openApiOperationId":"v1_organization_keyword_lookup","summary":"Organization keywords lookup"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Valid response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_22"}},"schemaId":"schema_22"}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1autocomplete~1organization_keywords~1/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_22","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_22"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/autocomplete/v1_organization_keyword_lookup"}],"panels":[]}]},"httpPath":"/api/{account_id}/datastorage/autocomplete/organization_keywords/"},{"label":"Locations lookup","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/autocomplete/v1_location_lookup","routeSlug":"/openapi/autocomplete/v1_location_lookup","metadata":{"seo":{"title":"Locations lookup","description":"Locations objects lookup."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v1_location_lookup","name":"Locations lookup","isWebhook":false,"pointer":"/paths/~1api~1{account_id}~1datastorage~1autocomplete~1locations~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Locations lookup","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"id":"v1_location_lookup"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locations objects lookup."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"q","in":"query","schemaId":"schema_19","description":"City, State, Country or Continent.","required":true},{"name":"page","in":"query","schemaId":"schema_13"}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1autocomplete~1locations~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/{account_id}/datastorage/autocomplete/locations/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[],"query":[{"name":"q","in":"query","required":true,"schemaId":"schema_19"},{"name":"page","in":"query","required":false,"schemaId":"schema_13"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/api/{account_id}/datastorage/autocomplete/locations/","href":"autocomplete/v1_location_lookup","openApiOperationId":"v1_location_lookup","summary":"Locations lookup"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Valid response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_23"}},"schemaId":"schema_23"}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1autocomplete~1locations~1/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_23","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_23"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/autocomplete/v1_location_lookup"}],"panels":[]}]},"httpPath":"/api/{account_id}/datastorage/autocomplete/locations/"},{"label":"Person skills lookup","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/autocomplete/v1_person_skill_lookup","routeSlug":"/openapi/autocomplete/v1_person_skill_lookup","metadata":{"seo":{"title":"Person skills lookup","description":"Person skills objects lookup."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v1_person_skill_lookup","name":"Person skills lookup","isWebhook":false,"pointer":"/paths/~1api~1{account_id}~1datastorage~1autocomplete~1person_skills~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Person skills lookup","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"id":"v1_person_skill_lookup"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Person skills objects lookup."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"q","in":"query","schemaId":"schema_19","description":"Person skill name.","required":true},{"name":"page","in":"query","schemaId":"schema_13"}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1autocomplete~1person_skills~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/{account_id}/datastorage/autocomplete/person_skills/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[],"query":[{"name":"q","in":"query","required":true,"schemaId":"schema_19"},{"name":"page","in":"query","required":false,"schemaId":"schema_13"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/api/{account_id}/datastorage/autocomplete/person_skills/","href":"autocomplete/v1_person_skill_lookup","openApiOperationId":"v1_person_skill_lookup","summary":"Person skills lookup"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Valid response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_24"}},"schemaId":"schema_24"}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1autocomplete~1person_skills~1/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_24","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_24"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/autocomplete/v1_person_skill_lookup"}],"panels":[]}]},"httpPath":"/api/{account_id}/datastorage/autocomplete/person_skills/"},{"label":"Web technologies lookup","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/autocomplete/v1_web_technology_lookup","routeSlug":"/openapi/autocomplete/v1_web_technology_lookup","metadata":{"seo":{"title":"Web technologies lookup","description":"Web technologies objects lookup."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"v1_web_technology_lookup","name":"Web technologies lookup","isWebhook":false,"pointer":"/paths/~1api~1{account_id}~1datastorage~1autocomplete~1web_technologies~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Web technologies lookup","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"span","attrs":{"id":"v1_web_technology_lookup"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Web technologies objects lookup."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"q","in":"query","schemaId":"schema_19","description":"Web technology name.","required":true},{"name":"page","in":"query","schemaId":"schema_13"}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1autocomplete~1web_technologies~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/{account_id}/datastorage/autocomplete/web_technologies/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[],"query":[{"name":"q","in":"query","required":true,"schemaId":"schema_19"},{"name":"page","in":"query","required":false,"schemaId":"schema_13"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/api/{account_id}/datastorage/autocomplete/web_technologies/","href":"autocomplete/v1_web_technology_lookup","openApiOperationId":"v1_web_technology_lookup","summary":"Web technologies lookup"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Valid response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25"}},"schemaId":"schema_25"}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1autocomplete~1web_technologies~1/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_25","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/autocomplete/v1_web_technology_lookup"}],"panels":[]}]},"httpPath":"/api/{account_id}/datastorage/autocomplete/web_technologies/"}],"content":{"contentType":"group","meta":{"name":"Autocomplete"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Autocomplete","showPageActions":true},{"nodeType":"markdoc","content":"Resolve free-text input into the canonical IDs used elsewhere in the API. Each endpoint returns matching options for a search term (industries, organizations, organization keywords, locations, person skills, web technologies) so they can be passed as filters to the search endpoints."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/{account_id}/datastorage/autocomplete/industries/","summary":"Industries lookup","prefix":{"name":"get","color":"get"},"badges":[],"link":"/autocomplete/v1_industry_lookup","deprecated":false},{"title":"/api/{account_id}/datastorage/autocomplete/organizations/","summary":"Organizations lookup","prefix":{"name":"get","color":"get"},"badges":[],"link":"/autocomplete/v1_organization_lookup","deprecated":false},{"title":"/api/{account_id}/datastorage/autocomplete/organization_keywords/","summary":"Organization keywords lookup","prefix":{"name":"get","color":"get"},"badges":[],"link":"/autocomplete/v1_organization_keyword_lookup","deprecated":false},{"title":"/api/{account_id}/datastorage/autocomplete/locations/","summary":"Locations lookup","prefix":{"name":"get","color":"get"},"badges":[],"link":"/autocomplete/v1_location_lookup","deprecated":false},{"title":"/api/{account_id}/datastorage/autocomplete/person_skills/","summary":"Person skills lookup","prefix":{"name":"get","color":"get"},"badges":[],"link":"/autocomplete/v1_person_skill_lookup","deprecated":false},{"title":"/api/{account_id}/datastorage/autocomplete/web_technologies/","summary":"Web technologies lookup","prefix":{"name":"get","color":"get"},"badges":[],"link":"/autocomplete/v1_web_technology_lookup","deprecated":false}]}]}]}]}},{"type":"group","label":"Feedback","link":"/openapi/feedback","routeSlug":"/openapi/feedback","items":[{"label":"Submit personal-email verification feedback","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/feedback/datastorage_feedback_personal_emails_create","routeSlug":"/openapi/feedback/datastorage_feedback_personal_emails_create","metadata":{"seo":{"title":"Submit personal-email verification feedback","description":"Submit verification feedback for a personal email address returned by a Forager person lookup. Required fields: email (lowercased and stripped before storage) and contact_status (one of valid or invalid). Optional: is_correct_person (boolean) — omit it, or send null, when the exchange never revealed whose address it is; an invalid address bounces before anyone can confirm a name. Omitted and null are both stored and returned as null, meaning \"unknown\", which is deliberately distinct from false (\"this is the wrong person\"). Also optional: name (the person's name the email belongs to, e.g. John Doe) and person_id. Every submission creates a new row with 201 Created."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"datastorage_feedback_personal_emails_create","name":"Submit personal-email verification feedback","isWebhook":false,"pointer":"/paths/~1api~1{account_id}~1datastorage~1feedback~1personal_emails~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit personal-email verification feedback","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submit verification feedback for a personal email address returned by a Forager person lookup. Required fields: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (lowercased and stripped before storage) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"valid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Optional: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_correct_person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (boolean) — omit it, or send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when the exchange never revealed whose address it is; an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" address bounces before anyone can confirm a name. Omitted and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are both stored and returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", meaning \"unknown\", which is deliberately distinct from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (\"this is the wrong person\"). Also optional: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the person's name the email belongs to, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"John Doe"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Every submission creates a new row with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201 Created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Api-Key","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1feedback~1personal_emails~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmailFeedbackRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/EmailFeedbackRequest"},"multipart/form-data":{"schemaId":"components/schemas/EmailFeedbackRequest"}},"schemaId":"components/schemas/EmailFeedbackRequest","pointer":"/paths/~1api~1{account_id}~1datastorage~1feedback~1personal_emails~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/{account_id}/datastorage/feedback/personal_emails/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_13"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Api-Key","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EmailFeedbackRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/EmailFeedbackRequest"},"multipart/form-data":{"schemaId":"components/schemas/EmailFeedbackRequest"}},"responseCodes":["201","400","403","429"],"pointer":"/api/{account_id}/datastorage/feedback/personal_emails/","href":"feedback/datastorage_feedback_personal_emails_create","openApiOperationId":"datastorage_feedback_personal_emails_create","summary":"Submit personal-email verification feedback"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"schemaId":"components/schemas/EmailFeedbackRequest","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmailFeedbackRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/EmailFeedbackRequest"},"multipart/form-data":{"schemaId":"components/schemas/EmailFeedbackRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmailFeedbackResponse"}},"schemaId":"components/schemas/EmailFeedbackResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation failed. The body contained an invalid contact value (e.g. a phone number that cannot be parsed as E.164, or a malformed email address), an unrecognised "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value, or a missing required field."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication failed. The request was missing a valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-API-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, the key was for a different account, or the API key user is inactive."},"children":[]}]}]}]},{"code":"429","description":"Rate limit exceeded. Feedback endpoints share a per-account budget of 60 requests per minute."}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1feedback~1personal_emails~1/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/EmailFeedbackResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmailFeedbackResponse"}}},{"code":"400"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feedback/datastorage_feedback_personal_emails_create"}],"panels":[]}]},"httpPath":"/api/{account_id}/datastorage/feedback/personal_emails/"},{"label":"Submit phone-number verification feedback","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/feedback/datastorage_feedback_phone_numbers_create","routeSlug":"/openapi/feedback/datastorage_feedback_phone_numbers_create","metadata":{"seo":{"title":"Submit phone-number verification feedback","description":"Submit verification feedback for a phone number returned by a Forager person lookup. Required fields: phone_number (any format; it is normalised to E.164 before storage) and contact_status (one of connected or disconnected, reflecting the live-call outcome). Optional: is_correct_person (boolean — did the call confirm the number belongs to the matched person). Omit it, or send null, when the call could not answer that question — a disconnected number never reaches anyone, so there is nobody to identify. Omitted and null are both stored and returned as null, meaning \"unknown\", which is deliberately distinct from false (\"this is the wrong person\"). Also optional: name (the person's name the caller believes the number belongs to, e.g. John Doe) and person_id (associate the row with a specific Forager person ID). Every submission creates a new row with 201 Created; repeat submissions for the same contact are preserved as separate rows."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"datastorage_feedback_phone_numbers_create","name":"Submit phone-number verification feedback","isWebhook":false,"pointer":"/paths/~1api~1{account_id}~1datastorage~1feedback~1phone_numbers~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit phone-number verification feedback","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submit verification feedback for a phone number returned by a Forager person lookup. Required fields: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"phone_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (any format; it is normalised to E.164 before storage) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"connected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disconnected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", reflecting the live-call outcome). Optional: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_correct_person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (boolean — did the call confirm the number belongs to the matched person). Omit it, or send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when the call could not answer that question — a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disconnected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" number never reaches anyone, so there is nobody to identify. Omitted and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are both stored and returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", meaning \"unknown\", which is deliberately distinct from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (\"this is the wrong person\"). Also optional: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the person's name the caller believes the number belongs to, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"John Doe"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (associate the row with a specific Forager person ID). Every submission creates a new row with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"201 Created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; repeat submissions for the same contact are preserved as separate rows."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Api-Key","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1feedback~1phone_numbers~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PhoneFeedbackRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/PhoneFeedbackRequest"},"multipart/form-data":{"schemaId":"components/schemas/PhoneFeedbackRequest"}},"schemaId":"components/schemas/PhoneFeedbackRequest","pointer":"/paths/~1api~1{account_id}~1datastorage~1feedback~1phone_numbers~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/{account_id}/datastorage/feedback/phone_numbers/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_13"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Api-Key","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PhoneFeedbackRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/PhoneFeedbackRequest"},"multipart/form-data":{"schemaId":"components/schemas/PhoneFeedbackRequest"}},"responseCodes":["201","400","403","429"],"pointer":"/api/{account_id}/datastorage/feedback/phone_numbers/","href":"feedback/datastorage_feedback_phone_numbers_create","openApiOperationId":"datastorage_feedback_phone_numbers_create","summary":"Submit phone-number verification feedback"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"schemaId":"components/schemas/PhoneFeedbackRequest","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PhoneFeedbackRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/PhoneFeedbackRequest"},"multipart/form-data":{"schemaId":"components/schemas/PhoneFeedbackRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PhoneFeedbackResponse"}},"schemaId":"components/schemas/PhoneFeedbackResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation failed. The body contained an invalid contact value (e.g. a phone number that cannot be parsed as E.164, or a malformed email address), an unrecognised "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value, or a missing required field."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication failed. The request was missing a valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-API-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, the key was for a different account, or the API key user is inactive."},"children":[]}]}]}]},{"code":"429","description":"Rate limit exceeded. Feedback endpoints share a per-account budget of 60 requests per minute."}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1feedback~1phone_numbers~1/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/PhoneFeedbackResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PhoneFeedbackResponse"}}},{"code":"400"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feedback/datastorage_feedback_phone_numbers_create"}],"panels":[]}]},"httpPath":"/api/{account_id}/datastorage/feedback/phone_numbers/"},{"label":"Submit work-email verification feedback","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/feedback/datastorage_feedback_work_emails_create","routeSlug":"/openapi/feedback/datastorage_feedback_work_emails_create","metadata":{"seo":{"title":"Submit work-email verification feedback","description":"Submit verification feedback for a work email address returned by a Forager person lookup. Required fields: email and contact_status (one of valid or invalid). Optional: is_correct_person — omit it, or send null, when the exchange never revealed whose address it is; null means \"unknown\" and is deliberately distinct from false (\"this is the wrong person\"). Also optional: name and person_id. Reports for the same address via both the work and personal endpoints store two distinct rows distinguished by email type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"datastorage_feedback_work_emails_create","name":"Submit work-email verification feedback","isWebhook":false,"pointer":"/paths/~1api~1{account_id}~1datastorage~1feedback~1work_emails~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit work-email verification feedback","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submit verification feedback for a work email address returned by a Forager person lookup. Required fields: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"valid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Optional: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_correct_person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — omit it, or send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when the exchange never revealed whose address it is; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means \"unknown\" and is deliberately distinct from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (\"this is the wrong person\"). Also optional: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Reports for the same address via both the work and personal endpoints store two distinct rows distinguished by email type."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Api-Key","scopes":[],"type":"apiKey","in":"header","paramName":"X-API-KEY"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"account_id","in":"path","schemaId":"schema_13","required":true}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1feedback~1work_emails~1/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmailFeedbackRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/EmailFeedbackRequest"},"multipart/form-data":{"schemaId":"components/schemas/EmailFeedbackRequest"}},"schemaId":"components/schemas/EmailFeedbackRequest","pointer":"/paths/~1api~1{account_id}~1datastorage~1feedback~1work_emails~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/{account_id}/datastorage/feedback/work_emails/","servers":[{"url":"https://api-v2.forager.ai"}],"parameters":{"path":[{"name":"account_id","in":"path","required":true,"schemaId":"schema_13"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Api-Key","type":"apiKey","name":"X-API-KEY","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EmailFeedbackRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/EmailFeedbackRequest"},"multipart/form-data":{"schemaId":"components/schemas/EmailFeedbackRequest"}},"responseCodes":["201","400","403","429"],"pointer":"/api/{account_id}/datastorage/feedback/work_emails/","href":"feedback/datastorage_feedback_work_emails_create","openApiOperationId":"datastorage_feedback_work_emails_create","summary":"Submit work-email verification feedback"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.forager.ai"}],"schemaId":"components/schemas/EmailFeedbackRequest","mediaTypes":["application/json","application/x-www-form-urlencoded","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EmailFeedbackRequest"},"application/x-www-form-urlencoded":{"schemaId":"components/schemas/EmailFeedbackRequest"},"multipart/form-data":{"schemaId":"components/schemas/EmailFeedbackRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmailFeedbackResponse"}},"schemaId":"components/schemas/EmailFeedbackResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation failed. The body contained an invalid contact value (e.g. a phone number that cannot be parsed as E.164, or a malformed email address), an unrecognised "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contact_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value, or a missing required field."},"children":[]}]}]}]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication failed. The request was missing a valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-API-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, the key was for a different account, or the API key user is inactive."},"children":[]}]}]}]},{"code":"429","description":"Rate limit exceeded. Feedback endpoints share a per-account budget of 60 requests per minute."}],"pointer":"/paths/~1api~1{account_id}~1datastorage~1feedback~1work_emails~1/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/EmailFeedbackResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmailFeedbackResponse"}}},{"code":"400"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/feedback/datastorage_feedback_work_emails_create"}],"panels":[]}]},"httpPath":"/api/{account_id}/datastorage/feedback/work_emails/"}],"content":{"contentType":"group","meta":{"name":"Feedback"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Feedback","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report verification feedback for contact data (phone numbers, personal emails, work emails) returned by Forager person lookups. Use these endpoints to submit whether a contact value is valid/invalid and whether it belongs to the matched person — every submission is stored as a new row and is used to improve the accuracy of future lookups."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/{account_id}/datastorage/feedback/personal_emails/","summary":"Submit personal-email verification feedback","prefix":{"name":"post","color":"post"},"badges":[],"link":"/feedback/datastorage_feedback_personal_emails_create","deprecated":false},{"title":"/api/{account_id}/datastorage/feedback/phone_numbers/","summary":"Submit phone-number verification feedback","prefix":{"name":"post","color":"post"},"badges":[],"link":"/feedback/datastorage_feedback_phone_numbers_create","deprecated":false},{"title":"/api/{account_id}/datastorage/feedback/work_emails/","summary":"Submit work-email verification feedback","prefix":{"name":"post","color":"post"},"badges":[],"link":"/feedback/datastorage_feedback_work_emails_create","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/APIKey":{"id":"components/schemas/APIKey","kind":"json-schema","title":"APIKey","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declares JSON representation of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UserAPIKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" model instances."},"children":[]}]}]}],"properties":{"prefix":{"type":"string","readOnly":true},"created":{"type":"string","format":"date-time","readOnly":true},"name":{"type":"string","description":"A free-form name for the API key. Need not be unique. 50 characters max.","maxLength":50}},"required":["created","prefix"]}},"components/schemas/Account":{"id":"components/schemas/Account","kind":"json-schema","title":"Account","data":{"type":"object","description":"Account serializer.","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"subscription":{"allOf":[{"$ref":"#/components/schemas/Subscription"}],"readOnly":true}},"required":["id","name","subscription"]}},"components/schemas/BillingCycleEnum":{"id":"components/schemas/BillingCycleEnum","kind":"json-schema","title":"BillingCycleEnum","data":{"enum":["month","year"],"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Month"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"year"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Year"},"children":[]}]}]}]}]}},"components/schemas/CreditsBalanceChangeLog":{"id":"components/schemas/CreditsBalanceChangeLog","kind":"json-schema","title":"CreditsBalanceChangeLog","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declares JSON representation of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditsBalanceChangeLog"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" model instances."},"children":[]}]}]}],"properties":{"id":{"type":"integer","readOnly":true},"change_type":{"type":"string"},"change_sum":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,2})?$","title":"Credits sum"},"change_description":{"type":"string","description":"Credits balance change description.","readOnly":true},"date_created":{"type":"string","format":"date-time","readOnly":true}},"required":["change_description","change_sum","change_type","date_created","id"]}},"components/schemas/EmailFeedbackRequest":{"id":"components/schemas/EmailFeedbackRequest","kind":"json-schema","title":"EmailFeedbackRequest","data":{"type":"object","description":"Request serializer for personal/work email verification feedback.","properties":{"is_correct_person":{"type":"boolean","nullable":true},"name":{"type":"string","nullable":true,"maxLength":255},"person_id":{"type":"integer","nullable":true},"email":{"type":"string","format":"email","writeOnly":true},"contact_status":{"$ref":"#/components/schemas/EmailFeedbackRequestContactStatusEnum"}},"required":["contact_status","email"]}},"components/schemas/EmailFeedbackRequestContactStatusEnum":{"id":"components/schemas/EmailFeedbackRequestContactStatusEnum","kind":"json-schema","title":"EmailFeedbackRequestContactStatusEnum","data":{"enum":["valid","invalid"],"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"valid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Valid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Invalid"},"children":[]}]}]}]}]}},"components/schemas/EmailFeedbackResponse":{"id":"components/schemas/EmailFeedbackResponse","kind":"json-schema","title":"EmailFeedbackResponse","data":{"type":"object","description":"Response serializer for created personal- and work-email feedback rows.","properties":{"id":{"type":"integer","readOnly":true},"email":{"type":"string","readOnly":true},"contact_status":{"type":"string","readOnly":true},"is_correct_person":{"type":"boolean","readOnly":true,"nullable":true},"name":{"type":"string","readOnly":true,"nullable":true},"person_id":{"type":"integer","readOnly":true,"nullable":true},"date_created":{"type":"string","format":"date-time","readOnly":true}},"required":["contact_status","date_created","email","id","is_correct_person","name","person_id"]}},"components/schemas/ErrorCodeEnum":{"id":"components/schemas/ErrorCodeEnum","kind":"json-schema","title":"ErrorCodeEnum","data":{"enum":["person_not_found","no_current_employer","input_unresolved","provider_error","expired","internal_error"],"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"person_not_found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - No person matched the LinkedIn identifier"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"no_current_employer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The person has no current employer on record"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"input_unresolved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Submitted input could not be resolved"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"provider_error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Provider error"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Expired before completion"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"internal_error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Internal error"},"children":[]}]}]}]}]}},"components/schemas/FundingTypesEnum":{"id":"components/schemas/FundingTypesEnum","kind":"json-schema","title":"FundingTypesEnum","data":{"enum":["angel","convertible_note","corporate_round","debt_financing","equity_crowdfunding","grant","initial_coin_offering","non_equity_assistance","post_ipo_debt","post_ipo_equity","post_ipo_secondary","pre_seed","private_equity","product_crowdfunding","secondary_market","seed","series_a","series_b","series_c","series_d","series_e","series_f","series_g","series_h","series_i","series_j","series_unknown","undisclosed"],"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"angel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Angel"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"convertible_note"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Convertible Note"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"corporate_round"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Corporate Round"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"debt_financing"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Debt Financing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"equity_crowdfunding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Equity Crowdfunding"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Grant"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initial_coin_offering"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Initial coin offering (ICO)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"non_equity_assistance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Non-Equity Assistance"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"post_ipo_debt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Post-IPO Debt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"post_ipo_equity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Post-IPO Equity"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"post_ipo_secondary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Post-IPO Secondary"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pre_seed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Pre-Seed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"private_equity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Private Equity"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_crowdfunding"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Product Crowdfunding"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"secondary_market"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Secondary Market"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"seed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Seed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"series_a"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Series A"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"series_b"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Series B"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"series_c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Series C"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"series_d"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Series D"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"series_e"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Series E"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"series_f"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Series F"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"series_g"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Series G"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"series_h"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Series H"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"series_i"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Series I"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"series_j"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Series J"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"series_unknown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Venture - Series Unknown"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"undisclosed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Undisclosed"},"children":[]}]}]}]}]}},"components/schemas/InnerLocation":{"id":"components/schemas/InnerLocation","kind":"json-schema","title":"InnerLocation","data":{"type":"object","description":"Serializer for the InnerLocation model.","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"osm_locations":{"type":"array","items":{"$ref":"#/components/schemas/OSMLocation"},"readOnly":true}},"required":["id","name","osm_locations"]}},"components/schemas/JobInnerLocation":{"id":"components/schemas/JobInnerLocation","kind":"json-schema","title":"JobInnerLocation","data":{"type":"object","description":"Serializer for the InnerLocation model for Jobs search API.","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"osm_locations":{"type":"array","items":{"$ref":"#/components/schemas/JobOSMLocation"},"readOnly":true}},"required":["id","name","osm_locations"]}},"components/schemas/JobOSMLocation":{"id":"components/schemas/JobOSMLocation","kind":"json-schema","title":"JobOSMLocation","data":{"type":"object","description":"Serializer for the OSMLocation model for Jobs search API.","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"place_type":{"type":"string","title":"Type","maxLength":255}},"required":["id","name","place_type"]}},"components/schemas/JobPostEventSearch":{"id":"components/schemas/JobPostEventSearch","kind":"json-schema","title":"JobPostEventSearch","data":{"type":"object","description":"JobPostEvent search request serializer.","properties":{"page":{"type":"integer"},"job_source":{"$ref":"#/components/schemas/JobSourceEnum"},"date_featured_start":{"type":"string","format":"date"},"date_featured_end":{"type":"string","format":"date"},"organization_ids":{"type":"array","items":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get a list of IDs use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#v1_organization_lookup"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organizations lookup endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"title":{"type":"string","description":"This field supports a boolean text search query."},"description":{"type":"string","description":"This field supports a boolean text search query."},"is_remote":{"type":"boolean","nullable":true},"is_active":{"type":"boolean","default":true},"locations":{"type":"array","items":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get a list of IDs use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#v1_location_lookup"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locations lookup endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"locations_exclude":{"type":"array","items":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get a list of IDs use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#v1_location_lookup"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locations lookup endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/JobPostEventSearchResponse":{"id":"components/schemas/JobPostEventSearchResponse","kind":"json-schema","title":"JobPostEventSearchResponse","data":{"type":"object","description":"OrganizationJobPostEvent search response serializer.","properties":{"search_results":{"type":"array","items":{"$ref":"#/components/schemas/JobPostEventSearchResult"},"readOnly":true},"total_search_results":{"type":"integer","minimum":0}},"required":["search_results","total_search_results"]}},"components/schemas/JobPostEventSearchResult":{"id":"components/schemas/JobPostEventSearchResult","kind":"json-schema","title":"JobPostEventSearchResult","data":{"type":"object","description":"Serializer for the OrganizationJobPostEvent model for Jobs search API.","properties":{"id":{"type":"integer","readOnly":true},"source":{"allOf":[{"$ref":"#/components/schemas/Source089Enum"}],"readOnly":true},"date_featured":{"type":"string","format":"date"},"organization":{"allOf":[{"$ref":"#/components/schemas/ShortOrganization"}],"readOnly":true},"source_id":{"type":"string","maxLength":65},"url":{"type":"string","format":"uri","maxLength":510},"title":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true},"is_remote":{"type":"boolean","title":"Is remote?"},"location":{"allOf":[{"$ref":"#/components/schemas/JobInnerLocation"}],"readOnly":true},"is_active":{"type":"boolean","title":"Is active?"}},"required":["date_featured","id","is_active","is_remote","location","organization","source","source_id","title","url"]}},"components/schemas/JobPostEventSearchTotalsResponse":{"id":"components/schemas/JobPostEventSearchTotalsResponse","kind":"json-schema","title":"JobPostEventSearchTotalsResponse","data":{"type":"object","description":"OrganizationJobPostEvent search totals response serializer.","properties":{"total_search_results":{"type":"integer","minimum":0}},"required":["total_search_results"]}},"components/schemas/JobSourceEnum":{"id":"components/schemas/JobSourceEnum","kind":"json-schema","title":"JobSourceEnum","data":{"enum":["indeed","linkedin","angellist"],"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"indeed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Indeed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - LinkedIn"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"angellist"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - AngelList"},"children":[]}]}]}]}]}},"components/schemas/LinkedinIndustry":{"id":"components/schemas/LinkedinIndustry","kind":"json-schema","title":"LinkedinIndustry","data":{"type":"object","description":"Serializer for the LinkedinIndustry document.","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255}},"required":["id","name"]}},"components/schemas/NullEnum":{"id":"components/schemas/NullEnum","kind":"json-schema","title":"NullEnum","data":{"enum":[null]}},"components/schemas/OSMLocation":{"id":"components/schemas/OSMLocation","kind":"json-schema","title":"OSMLocation","data":{"type":"object","description":"Serializer for the OSMLocation model.","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"place_type":{"type":"string","title":"Type","maxLength":255}},"required":["id","name","place_type"]}},"components/schemas/OrganizationAddress":{"id":"components/schemas/OrganizationAddress","kind":"json-schema","title":"OrganizationAddress","data":{"type":"object","description":"Serializer for the OrganizationAddress model.","properties":{"street_number":{"type":"string","nullable":true,"maxLength":255},"street_name":{"type":"string","nullable":true,"maxLength":255},"city":{"type":"string","nullable":true,"maxLength":255},"state":{"type":"string","nullable":true,"title":"State/County","maxLength":255},"postcode":{"type":"string","nullable":true,"title":"Post/Zip-code","maxLength":64},"country":{"type":"string","maxLength":255},"summary":{"type":"string"}},"required":["country","summary"]}},"components/schemas/OrganizationFinanceInfo":{"id":"components/schemas/OrganizationFinanceInfo","kind":"json-schema","title":"OrganizationFinanceInfo","data":{"type":"object","description":"Serializer for the OrganizationFinanceInfo model.","properties":{"revenue":{"type":"integer","maximum":9223372036854776000,"minimum":0,"format":"int64","nullable":true}}}},"components/schemas/OrganizationFundingEvent":{"id":"components/schemas/OrganizationFundingEvent","kind":"json-schema","title":"OrganizationFundingEvent","data":{"type":"object","description":"Serializer for the OrganizationFundingEvent model.","properties":{"id":{"type":"integer","readOnly":true},"source":{"allOf":[{"$ref":"#/components/schemas/OrganizationFundingEventSourceEnum"}],"readOnly":true},"date_featured":{"type":"string","format":"date"},"organization_id":{"type":"integer","readOnly":true},"funding_type":{"type":"string","maxLength":255},"funding_total":{"type":"integer","maximum":9223372036854776000,"minimum":0,"format":"int64"}},"required":["date_featured","funding_total","funding_type","id","organization_id","source"]}},"components/schemas/OrganizationFundingEventSourceEnum":{"id":"components/schemas/OrganizationFundingEventSourceEnum","kind":"json-schema","title":"OrganizationFundingEventSourceEnum","data":{"enum":["crunchbase"],"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"crunchbase"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Crunchbase"},"children":[]}]}]}]}]}},"components/schemas/OrganizationJobPostEvent":{"id":"components/schemas/OrganizationJobPostEvent","kind":"json-schema","title":"OrganizationJobPostEvent","data":{"type":"object","description":"Serializer for the OrganizationJobPostEvent model.","properties":{"id":{"type":"integer","readOnly":true},"source":{"allOf":[{"$ref":"#/components/schemas/Source089Enum"}],"readOnly":true},"date_featured":{"type":"string","format":"date"},"organization_id":{"type":"integer","readOnly":true},"source_id":{"type":"string","maxLength":65},"url":{"type":"string","format":"uri","maxLength":510},"title":{"type":"string","maxLength":255},"is_remote":{"type":"boolean","title":"Is remote?"},"is_active":{"type":"boolean","title":"Is active?"}},"required":["date_featured","id","is_active","is_remote","organization_id","source","source_id","title","url"]}},"components/schemas/OrganizationKeyword":{"id":"components/schemas/OrganizationKeyword","kind":"json-schema","title":"OrganizationKeyword","data":{"type":"object","description":"Serializer for the OrganizationKeyword model.","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255}},"required":["id","name"]}},"components/schemas/OrganizationLinkedinInfo":{"id":"components/schemas/OrganizationLinkedinInfo","kind":"json-schema","title":"OrganizationLinkedinInfo","data":{"type":"object","description":"Serializer for the OrganizationLinkedinInfo model.","properties":{"public_identifier":{"type":"string","nullable":true,"maxLength":255},"industry":{"allOf":[{"$ref":"#/components/schemas/LinkedinIndustry"}],"readOnly":true},"public_profile_url":{"type":"string","nullable":true,"description":"Get LinkedIn public profile URL.","readOnly":true}},"required":["industry","public_profile_url"]}},"components/schemas/OrganizationPersonRoleSearch":{"id":"components/schemas/OrganizationPersonRoleSearch","kind":"json-schema","title":"OrganizationPersonRoleSearch","data":{"type":"object","description":"OrganizationPersonRole search request serializer.","properties":{"page":{"type":"integer"},"role_title":{"type":"string","description":"This field supports a boolean text search query."},"role_description":{"type":"string","description":"This field supports a boolean text search query."},"role_is_current":{"type":"boolean","default":true},"role_position_start_date":{"type":"string","format":"date"},"role_position_end_date":{"type":"string","format":"date"},"role_years_on_position_start":{"type":"integer"},"role_years_on_position_end":{"type":"integer"},"person_name":{"type":"string","description":"This field supports a boolean text search query."},"person_headline":{"type":"string","description":"This field supports a boolean text search query."},"person_description":{"type":"string","description":"This field supports a boolean text search query."},"person_skills":{"type":"array","items":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get a list of IDs use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#v1_person_skill_lookup"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Person skills lookup endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"person_locations":{"type":"array","items":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get a list of IDs use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#v1_location_lookup"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locations lookup endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"person_industries":{"type":"array","items":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get a list of IDs use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#v1_industry_lookup"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Industries lookup endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"person_industries_exclude":{"type":"array","items":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get a list of IDs use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#v1_industry_lookup"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Industries lookup endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"person_linkedin_public_identifiers":{"type":"array","items":{"type":"string"},"description":"LinkedIn person \"Public identifier/Slug/ID\" - \"linkedin.com/in/!slug!/\"."},"organizations":{"type":"array","items":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get a list of IDs use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#v1_organization_lookup"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organizations lookup endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"organizations_bulk_domain":{"type":"string"},"organization_domains":{"type":"array","items":{"type":"string","description":"This field supports a boolean text search query."}},"organization_description":{"type":"string","description":"This field supports a boolean text search query."},"organization_locations":{"type":"array","items":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get a list of IDs use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#v1_location_lookup"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locations lookup endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"organization_industries":{"type":"array","items":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get a list of IDs use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#v1_industry_lookup"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Industries lookup endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"organization_industries_exclude":{"type":"array","items":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get a list of IDs use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#v1_industry_lookup"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Industries lookup endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"organization_keywords":{"type":"array","items":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get a list of IDs use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#v1_organization_keyword_lookup"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organization keywords lookup endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"organization_web_technologies":{"type":"array","items":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get a list of IDs use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#v1_web_technology_lookup"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Web technologies lookup endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"organization_founded_date_start":{"type":"string","format":"date"},"organization_founded_date_end":{"type":"string","format":"date"},"organization_employees_start":{"type":"integer"},"organization_employees_end":{"type":"integer"},"organization_revenue_start":{"type":"integer"},"organization_revenue_end":{"type":"integer"},"organization_domain_rank_start":{"type":"integer"},"organization_domain_rank_end":{"type":"integer"},"organization_linkedin_public_identifiers":{"type":"array","items":{"type":"string"},"description":"LinkedIn organization \"Public identifier/Slug/ID\" - \"linkedin.com/company/!slug!/\"."},"funding_types":{"type":"array","items":{"$ref":"#/components/schemas/FundingTypesEnum"}},"funding_total_start":{"type":"integer"},"funding_total_end":{"type":"integer"},"funding_event_date_featured_start":{"type":"string","format":"date"},"funding_event_date_featured_end":{"type":"string","format":"date"},"job_post_title":{"type":"string","description":"This field supports a boolean text search query."},"job_post_description":{"type":"string","description":"This field supports a boolean text search query."},"job_post_is_remote":{"type":"boolean","nullable":true},"job_post_is_active":{"type":"boolean","nullable":true},"job_post_date_featured_start":{"type":"string","format":"date"},"job_post_date_featured_end":{"type":"string","format":"date"},"job_post_locations":{"type":"array","items":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get a list of IDs use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#v1_location_lookup"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locations lookup endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"job_post_locations_exclude":{"type":"array","items":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get a list of IDs use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#v1_location_lookup"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locations lookup endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"simple_event_source":{"$ref":"#/components/schemas/SimpleEventSourceEnum"},"simple_event_reason":{"$ref":"#/components/schemas/SimpleEventReasonEnum"},"simple_event_date_featured_start":{"type":"string","format":"date"},"simple_event_date_featured_end":{"type":"string","format":"date"}}}},"components/schemas/OrganizationPersonRoleSearchResult":{"id":"components/schemas/OrganizationPersonRoleSearchResult","kind":"json-schema","title":"OrganizationPersonRoleSearchResult","data":{"type":"object","description":"Serializer for OrganizationPersonRole search results.","properties":{"id":{"type":"integer","readOnly":true},"role_title":{"type":"string","nullable":true,"maxLength":255},"start_date":{"type":"string","format":"date","nullable":true},"end_date":{"type":"string","format":"date","nullable":true},"duration":{"type":"string","nullable":true,"title":"Role duration","maxLength":255},"description":{"type":"string","nullable":true},"is_current":{"type":"boolean","title":"Is current?"},"organization":{"allOf":[{"$ref":"#/components/schemas/OrganizationSearchResult"}],"readOnly":true},"person":{"allOf":[{"$ref":"#/components/schemas/PersonChild"}],"readOnly":true},"date_updated":{"type":"string","format":"date-time","readOnly":true}},"required":["date_updated","id","is_current","organization","person"]}},"components/schemas/OrganizationSearchRequest":{"id":"components/schemas/OrganizationSearchRequest","kind":"json-schema","title":"OrganizationSearchRequest","data":{"type":"object","description":"Organization search request serializer.","properties":{"page":{"type":"integer"},"organization_ids":{"type":"array","items":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get a list of IDs use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#v1_organization_lookup"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organizations lookup endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"description":{"type":"string"},"locations":{"type":"array","items":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get a list of IDs use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#v1_location_lookup"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locations lookup endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"industries":{"type":"array","items":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get a list of IDs use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#v1_industry_lookup"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Industries lookup endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"industries_exclude":{"type":"array","items":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get a list of IDs use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#v1_industry_lookup"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Industries lookup endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"keywords":{"type":"array","items":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get a list of IDs use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#v1_organization_keyword_lookup"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organization keywords lookup endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"employees_start":{"type":"integer"},"employees_end":{"type":"integer"},"founded_date_start":{"type":"string","format":"date"},"founded_date_end":{"type":"string","format":"date"},"revenue_start":{"type":"integer"},"revenue_end":{"type":"integer"},"domains":{"type":"array","items":{"type":"string"}},"domain_rank_start":{"type":"integer"},"domain_rank_end":{"type":"integer"},"domain_traffic_start":{"type":"integer"},"domain_traffic_end":{"type":"integer"},"web_technologies":{"type":"array","items":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get a list of IDs use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#v1_organization_keyword_lookup"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organization keywords lookup endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"linkedin_public_identifiers":{"type":"array","items":{"type":"string"},"description":"LinkedIn organization \"Public identifier/Slug/ID\" - \"linkedin.com/company/!slug!/\"."},"funding_types":{"type":"array","items":{"$ref":"#/components/schemas/FundingTypesEnum"}},"funding_total_start":{"type":"integer"},"funding_total_end":{"type":"integer"},"funding_event_date_featured_start":{"type":"string","format":"date"},"funding_event_date_featured_end":{"type":"string","format":"date"},"job_post_title":{"type":"string","description":"This field supports a boolean text search query."},"job_post_description":{"type":"string","description":"This field supports a boolean text search query."},"job_post_is_remote":{"type":"boolean","nullable":true},"job_post_is_active":{"type":"boolean","nullable":true},"job_post_date_featured_start":{"type":"string","format":"date"},"job_post_date_featured_end":{"type":"string","format":"date"},"job_post_locations":{"type":"array","items":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get a list of IDs use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#v1_location_lookup"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locations lookup endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"job_post_locations_exclude":{"type":"array","items":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get a list of IDs use "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"#v1_location_lookup"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Locations lookup endpoint"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"simple_event_source":{"$ref":"#/components/schemas/SimpleEventSourceEnum"},"simple_event_reason":{"$ref":"#/components/schemas/SimpleEventReasonEnum"},"simple_event_date_featured_start":{"type":"string","format":"date"},"simple_event_date_featured_end":{"type":"string","format":"date"}}}},"components/schemas/OrganizationSearchResponse":{"id":"components/schemas/OrganizationSearchResponse","kind":"json-schema","title":"OrganizationSearchResponse","data":{"type":"object","description":"Organization search response serializer.","properties":{"search_results":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationSearchResult"},"readOnly":true},"total_search_results":{"type":"integer","minimum":0}},"required":["search_results","total_search_results"]}},"components/schemas/OrganizationSearchResult":{"id":"components/schemas/OrganizationSearchResult","kind":"json-schema","title":"OrganizationSearchResult","data":{"type":"object","description":"Organization search result(With prefetch events) serializer.","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"legal_name":{"type":"string","maxLength":255},"website":{"type":"string","format":"uri","nullable":true,"maxLength":16384},"domain":{"type":"string","format":"uri","nullable":true,"maxLength":200},"domain_rank":{"type":"integer","nullable":true,"description":"Domain rank.","readOnly":true},"logo":{"type":"string","format":"uri","nullable":true,"maxLength":510},"description":{"type":"string","nullable":true},"founded_date":{"type":"string","format":"date","nullable":true},"operating_status":{"type":"string","nullable":true,"maxLength":255},"employees_range":{"type":"string","nullable":true,"maxLength":255},"employees_amount":{"type":"integer","maximum":2147483647,"minimum":0,"nullable":true},"keywords":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationKeyword"},"readOnly":true},"location":{"allOf":[{"$ref":"#/components/schemas/InnerLocation"}],"readOnly":true},"finance_info":{"allOf":[{"$ref":"#/components/schemas/OrganizationFinanceInfo"}],"readOnly":true},"linkedin_info":{"allOf":[{"$ref":"#/components/schemas/OrganizationLinkedinInfo"}],"readOnly":true},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationAddress"},"readOnly":true},"date_updated":{"type":"string","format":"date-time","readOnly":true},"found_simple_events":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationSimpleEvent"},"description":"Events will be available in case any event field would be used for the search. In results will be available 30 most recent matches."},"found_funding_events":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationFundingEvent"},"description":"Events will be available in case any event field would be used for the search. In results will be available 30 most recent matches."},"found_job_post_events":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationJobPostEvent"},"description":"Events will be available in case any event field would be used for the search. In results will be available 30 most recent matches."}},"required":["addresses","date_updated","domain_rank","finance_info","found_funding_events","found_job_post_events","found_simple_events","id","keywords","legal_name","linkedin_info","location","name"]}},"components/schemas/OrganizationSearchTotalsResponse":{"id":"components/schemas/OrganizationSearchTotalsResponse","kind":"json-schema","title":"OrganizationSearchTotalsResponse","data":{"type":"object","description":"Organization search totals response serializer.","properties":{"total_search_results":{"type":"integer","minimum":0}},"required":["total_search_results"]}},"components/schemas/OrganizationSimpleEvent":{"id":"components/schemas/OrganizationSimpleEvent","kind":"json-schema","title":"OrganizationSimpleEvent","data":{"type":"object","description":"Serializer for the OrganizationSimpleEvent model.","properties":{"id":{"type":"integer","readOnly":true},"source":{"allOf":[{"$ref":"#/components/schemas/SourceA7bEnum"}],"readOnly":true},"date_featured":{"type":"string","format":"date"},"organization_id":{"type":"integer","readOnly":true},"reason":{"$ref":"#/components/schemas/ReasonEnum"},"url":{"type":"string","format":"uri","maxLength":255}},"required":["date_featured","id","organization_id","reason","source","url"]}},"components/schemas/PaginatedCreditsBalanceChangeLogList":{"id":"components/schemas/PaginatedCreditsBalanceChangeLogList","kind":"json-schema","title":"PaginatedCreditsBalanceChangeLogList","data":{"type":"object","properties":{"count":{"type":"integer","example":15},"next":{"type":"integer","nullable":true,"example":2},"previous":{"type":"integer","nullable":true,"example":null},"results":{"type":"array","items":{"$ref":"#/components/schemas/CreditsBalanceChangeLog"}}}}},"components/schemas/PersonCertification":{"id":"components/schemas/PersonCertification","kind":"json-schema","title":"PersonCertification","data":{"type":"object","description":"Serializer for the PersonCertification model.","properties":{"id":{"type":"integer","readOnly":true},"organization_id":{"type":"integer","nullable":true,"readOnly":true},"name":{"type":"string","maxLength":510},"certificate_id":{"type":"string","nullable":true,"maxLength":255},"url":{"type":"string","format":"uri","nullable":true,"maxLength":16384},"authority":{"type":"string","nullable":true,"maxLength":255}},"required":["id","name","organization_id"]}},"components/schemas/PersonChild":{"id":"components/schemas/PersonChild","kind":"json-schema","title":"PersonChild","data":{"type":"object","description":"Child serializer for the Person model.","properties":{"id":{"type":"integer","readOnly":true},"full_name":{"type":"string","maxLength":255},"first_name":{"type":"string","maxLength":255},"last_name":{"type":"string","nullable":true,"maxLength":255},"photo":{"type":"string","format":"uri","nullable":true,"maxLength":255},"gender":{"type":"string","nullable":true,"maxLength":255},"headline":{"type":"string","nullable":true,"maxLength":255},"description":{"type":"string","nullable":true},"skills":{"type":"array","items":{"$ref":"#/components/schemas/PersonSkill"},"readOnly":true},"location":{"allOf":[{"$ref":"#/components/schemas/InnerLocation"}],"readOnly":true},"linkedin_info":{"allOf":[{"$ref":"#/components/schemas/PersonLinkedinInfo"}],"readOnly":true},"date_updated":{"type":"string","format":"date-time","readOnly":true}},"required":["date_updated","first_name","full_name","id","linkedin_info","location","skills"]}},"components/schemas/PersonCourse":{"id":"components/schemas/PersonCourse","kind":"json-schema","title":"PersonCourse","data":{"type":"object","description":"Serializer for the PersonCourse model.","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":1515},"number":{"type":"string","nullable":true,"maxLength":255},"associated_role_id":{"type":"integer","nullable":true,"readOnly":true},"associated_education_id":{"type":"integer","nullable":true,"readOnly":true}},"required":["associated_education_id","associated_role_id","id","name"]}},"components/schemas/PersonDetail":{"id":"components/schemas/PersonDetail","kind":"json-schema","title":"PersonDetail","data":{"type":"object","description":"Person details serializer.","properties":{"id":{"type":"integer","readOnly":true},"full_name":{"type":"string","maxLength":255},"first_name":{"type":"string","maxLength":255},"last_name":{"type":"string","nullable":true,"maxLength":255},"photo":{"type":"string","format":"uri","nullable":true,"maxLength":255},"gender":{"type":"string","nullable":true,"maxLength":255},"headline":{"type":"string","nullable":true,"maxLength":255},"description":{"type":"string","nullable":true},"skills":{"type":"array","items":{"$ref":"#/components/schemas/PersonSkill"},"readOnly":true},"location":{"allOf":[{"$ref":"#/components/schemas/InnerLocation"}],"readOnly":true},"linkedin_info":{"allOf":[{"$ref":"#/components/schemas/PersonLinkedinInfo"}],"readOnly":true},"roles":{"type":"array","items":{"$ref":"#/components/schemas/PersonRoleChild"}},"educations":{"type":"array","items":{"$ref":"#/components/schemas/PersonEducation"}},"certifications":{"type":"array","items":{"$ref":"#/components/schemas/PersonCertification"},"readOnly":true},"courses":{"type":"array","items":{"$ref":"#/components/schemas/PersonCourse"},"readOnly":true},"honors":{"type":"array","items":{"$ref":"#/components/schemas/PersonHonor"},"readOnly":true},"languages":{"type":"array","items":{"$ref":"#/components/schemas/PersonLanguage"},"readOnly":true},"organizations":{"type":"array","items":{"$ref":"#/components/schemas/PersonOrganization"},"readOnly":true},"patents":{"type":"array","items":{"$ref":"#/components/schemas/PersonPatent"},"readOnly":true},"publications":{"type":"array","items":{"$ref":"#/components/schemas/PersonPublication"},"readOnly":true},"test_scores":{"type":"array","items":{"$ref":"#/components/schemas/PersonTestScore"},"readOnly":true},"projects":{"type":"array","items":{"$ref":"#/components/schemas/PersonProject"},"readOnly":true},"volunteering":{"type":"array","items":{"$ref":"#/components/schemas/PersonVolunteering"},"readOnly":true}},"required":["certifications","courses","educations","first_name","full_name","honors","id","languages","linkedin_info","location","organizations","patents","projects","publications","roles","skills","test_scores","volunteering"]}},"components/schemas/PersonEducation":{"id":"components/schemas/PersonEducation","kind":"json-schema","title":"PersonEducation","data":{"type":"object","description":"Serializer for the PersonEducation model.","properties":{"id":{"type":"integer","readOnly":true},"school_name":{"type":"string","maxLength":255},"organization":{"allOf":[{"$ref":"#/components/schemas/ShortOrganization"}],"readOnly":true},"description":{"type":"string","nullable":true},"grade":{"type":"string","nullable":true,"maxLength":255},"degree":{"type":"string","nullable":true,"maxLength":255},"activities":{"type":"string","nullable":true,"maxLength":255},"field_of_study":{"type":"string","nullable":true,"maxLength":255},"start_date":{"type":"string","format":"date","nullable":true},"end_date":{"type":"string","format":"date","nullable":true}},"required":["id","organization","school_name"]}},"components/schemas/PersonEmailDetail":{"id":"components/schemas/PersonEmailDetail","kind":"json-schema","title":"PersonEmailDetail","data":{"type":"object","description":"Person details email serializer, implemented for documentation.","properties":{"email":{"type":"string","format":"email","readOnly":true},"email_type":{"type":"string","readOnly":true},"validation_status":{"allOf":[{"$ref":"#/components/schemas/ValidationStatusEnum"}],"readOnly":true}},"required":["email","email_type","validation_status"]}},"components/schemas/PersonHonor":{"id":"components/schemas/PersonHonor","kind":"json-schema","title":"PersonHonor","data":{"type":"object","description":"Serializer for the PersonHonor model.","properties":{"id":{"type":"integer","readOnly":true},"title":{"type":"string","maxLength":510},"description":{"type":"string","nullable":true},"issuer":{"type":"string","nullable":true},"issued_on":{"type":"string","format":"date","nullable":true},"associated_role_id":{"type":"integer","nullable":true,"readOnly":true},"associated_education_id":{"type":"integer","nullable":true,"readOnly":true}},"required":["associated_education_id","associated_role_id","id","title"]}},"components/schemas/PersonInfoRequest":{"id":"components/schemas/PersonInfoRequest","kind":"json-schema","title":"PersonInfoRequest","data":{"type":"object","description":"Person info request serializer.","properties":{"person_id":{"type":"integer"},"linkedin_public_identifier":{"type":"string","description":"LinkedIn organization \"Public identifier/Slug/ID\" - \"linkedin.com/in/!slug!/\"."}}}},"components/schemas/PersonLanguage":{"id":"components/schemas/PersonLanguage","kind":"json-schema","title":"PersonLanguage","data":{"type":"object","description":"Serializer for the PersonLanguage model.","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"proficiency":{"type":"string","nullable":true,"maxLength":255}},"required":["id","name"]}},"components/schemas/PersonLinkedinInfo":{"id":"components/schemas/PersonLinkedinInfo","kind":"json-schema","title":"PersonLinkedinInfo","data":{"type":"object","description":"Serializer for the PersonLinkedinInfo model.","properties":{"public_identifier":{"type":"string","nullable":true,"maxLength":255},"industry":{"allOf":[{"$ref":"#/components/schemas/LinkedinIndustry"}],"readOnly":true},"public_profile_url":{"type":"string","description":"Get LinkedIn public profile URL.","readOnly":true}},"required":["industry","public_profile_url"]}},"components/schemas/PersonOrganization":{"id":"components/schemas/PersonOrganization","kind":"json-schema","title":"PersonOrganization","data":{"type":"object","description":"Serializer for the PersonOrganization model.","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","title":"Title","maxLength":510},"description":{"type":"string","nullable":true},"role_title":{"type":"string","nullable":true,"maxLength":1515},"associated_role_id":{"type":"integer","nullable":true,"readOnly":true},"associated_education_id":{"type":"integer","nullable":true,"readOnly":true}},"required":["associated_education_id","associated_role_id","id","name"]}},"components/schemas/PersonPatent":{"id":"components/schemas/PersonPatent","kind":"json-schema","title":"PersonPatent","data":{"type":"object","description":"Serializer for the PersonPatent model.","properties":{"id":{"type":"integer","readOnly":true},"title":{"type":"string","maxLength":510},"description":{"type":"string","nullable":true},"patent_number":{"type":"string","nullable":true,"maxLength":125},"application_number":{"type":"string","nullable":true,"maxLength":255},"is_pending":{"type":"boolean"},"url":{"type":"string","format":"uri","nullable":true,"maxLength":16384},"issued_on":{"type":"string","format":"date","nullable":true},"filled_on":{"type":"string","format":"date","nullable":true},"linkedin_inventors_ids":{"type":"array","items":{"type":"integer"},"description":"Get list of ids of persons who authored this patent.","readOnly":true},"non_linkedin_inventors":{"type":"array","items":{"type":"string","maxLength":255}}},"required":["id","is_pending","linkedin_inventors_ids","title"]}},"components/schemas/PersonPhoneDetail":{"id":"components/schemas/PersonPhoneDetail","kind":"json-schema","title":"PersonPhoneDetail","data":{"type":"object","description":"Person details phone number serializer, implemented for documentation.","properties":{"phone_number":{"type":"string","readOnly":true}},"required":["phone_number"]}},"components/schemas/PersonProject":{"id":"components/schemas/PersonProject","kind":"json-schema","title":"PersonProject","data":{"type":"object","description":"Serializer for the PersonProject model.","properties":{"id":{"type":"integer","readOnly":true},"title":{"type":"string","maxLength":510},"url":{"type":"string","format":"uri","nullable":true,"maxLength":16384},"description":{"type":"string","nullable":true},"start_date":{"type":"string","format":"date","nullable":true},"end_date":{"type":"string","format":"date","nullable":true},"associated_role_id":{"type":"integer","nullable":true,"readOnly":true},"associated_education_id":{"type":"integer","nullable":true,"readOnly":true},"linkedin_contributors_ids":{"type":"array","items":{"type":"integer"},"description":"Get list of ids of persons who contributed to this project.","readOnly":true},"non_linkedin_contributors":{"type":"array","items":{"type":"string","maxLength":255}}},"required":["associated_education_id","associated_role_id","id","linkedin_contributors_ids","title"]}},"components/schemas/PersonPublication":{"id":"components/schemas/PersonPublication","kind":"json-schema","title":"PersonPublication","data":{"type":"object","description":"Serializer for the PersonPublication model.","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":510},"description":{"type":"string","nullable":true},"url":{"type":"string","format":"uri","nullable":true,"maxLength":16384},"publisher":{"type":"string","nullable":true,"maxLength":510},"published_in":{"type":"string","format":"date","nullable":true},"linkedin_authors_ids":{"type":"array","items":{"type":"integer"},"description":"Get list of ids of persons who authored this publication.","readOnly":true},"non_linkedin_authors":{"type":"array","items":{"type":"string","maxLength":255}}},"required":["id","linkedin_authors_ids","name"]}},"components/schemas/PersonReverseSearchByEmail":{"id":"components/schemas/PersonReverseSearchByEmail","kind":"json-schema","title":"PersonReverseSearchByEmail","data":{"type":"object","description":"Person reverse search by email request serializer.","properties":{"email":{"type":"string","format":"email","description":"The personal email address of the person being searched."}},"required":["email"]}},"components/schemas/PersonReverseSearchByPhoneNumber":{"id":"components/schemas/PersonReverseSearchByPhoneNumber","kind":"json-schema","title":"PersonReverseSearchByPhoneNumber","data":{"type":"object","description":"Person reverse search by phone number request serializer.","properties":{"phone_number":{"type":"string"}},"required":["phone_number"]}},"components/schemas/PersonRoleChild":{"id":"components/schemas/PersonRoleChild","kind":"json-schema","title":"PersonRoleChild","data":{"type":"object","description":"Child serializer for the OrganizationPersonRole model.","properties":{"id":{"type":"integer","readOnly":true},"role_title":{"type":"string","nullable":true,"maxLength":255},"start_date":{"type":"string","format":"date","nullable":true},"end_date":{"type":"string","format":"date","nullable":true},"duration":{"type":"string","nullable":true,"title":"Role duration","maxLength":255},"description":{"type":"string","nullable":true},"is_current":{"type":"boolean","title":"Is current?"},"organization":{"allOf":[{"$ref":"#/components/schemas/ShortOrganization"}],"readOnly":true},"organization_name":{"type":"string","nullable":true,"maxLength":255}},"required":["id","is_current","organization"]}},"components/schemas/PersonRoleSearchResponse":{"id":"components/schemas/PersonRoleSearchResponse","kind":"json-schema","title":"PersonRoleSearchResponse","data":{"type":"object","description":"OrganizationPersonRole search response serializer.","properties":{"search_results":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationPersonRoleSearchResult"},"readOnly":true},"total_search_results":{"type":"integer","minimum":0}},"required":["search_results","total_search_results"]}},"components/schemas/PersonRoleSearchTotalsResponse":{"id":"components/schemas/PersonRoleSearchTotalsResponse","kind":"json-schema","title":"PersonRoleSearchTotalsResponse","data":{"type":"object","description":"OrganizationPersonRole search totals response serializer.","properties":{"total_search_results":{"type":"integer","minimum":0},"total_persons":{"type":"integer","minimum":0},"total_organizations":{"type":"integer","minimum":0}},"required":["total_organizations","total_persons","total_search_results"]}},"components/schemas/PersonSkill":{"id":"components/schemas/PersonSkill","kind":"json-schema","title":"PersonSkill","data":{"type":"object","description":"Serializer for the PersonSkill model.","properties":{"name":{"type":"string","maxLength":255}},"required":["name"]}},"components/schemas/PersonTestScore":{"id":"components/schemas/PersonTestScore","kind":"json-schema","title":"PersonTestScore","data":{"type":"object","description":"Serializer for the PersonTestScore model.","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":510},"description":{"type":"string","nullable":true},"score":{"type":"string","nullable":true,"maxLength":65},"date_on":{"type":"string","format":"date","nullable":true},"associated_role_id":{"type":"integer","nullable":true,"readOnly":true},"associated_education_id":{"type":"integer","nullable":true,"readOnly":true}},"required":["associated_education_id","associated_role_id","id","name"]}},"components/schemas/PersonVolunteering":{"id":"components/schemas/PersonVolunteering","kind":"json-schema","title":"PersonVolunteering","data":{"type":"object","description":"Serializer for the PersonVolunteering model.","properties":{"id":{"type":"integer","readOnly":true},"title":{"type":"string","title":"Name","maxLength":255},"description":{"type":"string","nullable":true},"cause":{"type":"string","nullable":true,"maxLength":255},"organization_name":{"type":"string","maxLength":255},"organization_id":{"type":"integer","nullable":true,"readOnly":true},"start_date":{"type":"string","format":"date","nullable":true},"end_date":{"type":"string","format":"date","nullable":true}},"required":["id","organization_id","organization_name","title"]}},"components/schemas/PhoneFeedbackRequest":{"id":"components/schemas/PhoneFeedbackRequest","kind":"json-schema","title":"PhoneFeedbackRequest","data":{"type":"object","description":"Request serializer for phone-number verification feedback.","properties":{"is_correct_person":{"type":"boolean","nullable":true},"name":{"type":"string","nullable":true,"maxLength":255},"person_id":{"type":"integer","nullable":true},"phone_number":{"type":"string","writeOnly":true},"contact_status":{"$ref":"#/components/schemas/PhoneFeedbackRequestContactStatusEnum"}},"required":["contact_status","phone_number"]}},"components/schemas/PhoneFeedbackRequestContactStatusEnum":{"id":"components/schemas/PhoneFeedbackRequestContactStatusEnum","kind":"json-schema","title":"PhoneFeedbackRequestContactStatusEnum","data":{"enum":["connected","disconnected"],"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"connected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Connected"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disconnected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Disconnected"},"children":[]}]}]}]}]}},"components/schemas/PhoneFeedbackResponse":{"id":"components/schemas/PhoneFeedbackResponse","kind":"json-schema","title":"PhoneFeedbackResponse","data":{"type":"object","description":"Response serializer for created phone feedback rows.","properties":{"id":{"type":"integer","readOnly":true},"phone_number":{"type":"string","readOnly":true},"contact_status":{"type":"string","readOnly":true},"is_correct_person":{"type":"boolean","readOnly":true,"nullable":true},"name":{"type":"string","readOnly":true,"nullable":true},"person_id":{"type":"integer","readOnly":true,"nullable":true},"date_created":{"type":"string","format":"date-time","readOnly":true}},"required":["contact_status","date_created","id","is_correct_person","name","person_id","phone_number"]}},"components/schemas/ReasonEnum":{"id":"components/schemas/ReasonEnum","kind":"json-schema","title":"ReasonEnum","data":{"enum":["report_released","promoted_on_site"],"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report_released"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Report released"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoted_on_site"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Promoted on site"},"children":[]}]}]}]}]}},"components/schemas/ShortOrganization":{"id":"components/schemas/ShortOrganization","kind":"json-schema","title":"ShortOrganization","data":{"type":"object","description":"Short serializer for the Organization model.","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"domain":{"type":"string","format":"uri","nullable":true,"maxLength":200},"linkedin_info":{"allOf":[{"$ref":"#/components/schemas/OrganizationLinkedinInfo"}],"readOnly":true}},"required":["id","linkedin_info","name"]}},"components/schemas/SimpleEventReasonEnum":{"id":"components/schemas/SimpleEventReasonEnum","kind":"json-schema","title":"SimpleEventReasonEnum","data":{"enum":["report_released","promoted_on_site"],"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report_released"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Report released"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"promoted_on_site"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Promoted on site"},"children":[]}]}]}]}]}},"components/schemas/SimpleEventSourceEnum":{"id":"components/schemas/SimpleEventSourceEnum","kind":"json-schema","title":"SimpleEventSourceEnum","data":{"enum":["product_hunt","form_c_sec_gov","form_d_sec_gov"],"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_hunt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Product Hunt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form_c_sec_gov"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Form C sec.gov"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form_d_sec_gov"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Form D sec.gov"},"children":[]}]}]}]}]}},"components/schemas/Source089Enum":{"id":"components/schemas/Source089Enum","kind":"json-schema","title":"Source089Enum","data":{"enum":["indeed","linkedin","angellist"],"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"indeed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Indeed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - LinkedIn"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"angellist"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - AngelList"},"children":[]}]}]}]}]}},"components/schemas/SourceA7bEnum":{"id":"components/schemas/SourceA7bEnum","kind":"json-schema","title":"SourceA7bEnum","data":{"enum":["product_hunt","form_c_sec_gov","form_d_sec_gov"],"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"product_hunt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Product Hunt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form_c_sec_gov"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Form C sec.gov"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"form_d_sec_gov"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Form D sec.gov"},"children":[]}]}]}]}]}},"components/schemas/Status564Enum":{"id":"components/schemas/Status564Enum","kind":"json-schema","title":"Status564Enum","data":{"enum":["queued","running","awaiting_provider","completed","failed"],"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"queued"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Queued"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"running"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Running"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"awaiting_provider"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Awaiting provider"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Completed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Failed"},"children":[]}]}]}]}]}},"components/schemas/StripeSubscriptionPrice":{"id":"components/schemas/StripeSubscriptionPrice","kind":"json-schema","title":"StripeSubscriptionPrice","data":{"type":"object","description":"Stripe subscription price serializer.","properties":{"id":{"type":"integer","readOnly":true},"plan_price_usd":{"type":"string","format":"decimal","pattern":"^-?\\d{0,8}(?:\\.\\d{0,2})?$","title":"Plan price (USD)"},"min_credits":{"type":"integer","maximum":2147483647,"minimum":0},"billing_cycle":{"$ref":"#/components/schemas/BillingCycleEnum"}},"required":["id"]}},"components/schemas/Subscription":{"id":"components/schemas/Subscription","kind":"json-schema","title":"Subscription","data":{"type":"object","description":"Subscription serializer.","properties":{"id":{"type":"integer","readOnly":true},"is_active":{"type":"boolean","title":"Is active?"},"credits_balance":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,2})?$","readOnly":true},"subscription_tier":{"allOf":[{"$ref":"#/components/schemas/SubscriptionTier"}],"readOnly":true},"stripe_subscription_id":{"type":"string","nullable":true,"maxLength":65},"stripe_subscription_price":{"allOf":[{"$ref":"#/components/schemas/StripeSubscriptionPrice"}],"readOnly":true}},"required":["credits_balance","id","stripe_subscription_price","subscription_tier"]}},"components/schemas/SubscriptionTier":{"id":"components/schemas/SubscriptionTier","kind":"json-schema","title":"SubscriptionTier","data":{"type":"object","description":"Subscription tier serializer.","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":35},"person_details_lookup":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,2})?$"},"person_work_email_lookup":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,2})?$"},"person_personal_email_lookup":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,2})?$"},"person_phone_number_lookup":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,2})?$"},"person_reverse_email_search":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,2})?$"},"person_reverse_phone_number_search":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,2})?$"},"person_role_details_lookup":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,2})?$"},"person_role_search_api_call":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,2})?$"},"job_search_api_call":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,2})?$"},"organization_search_api_call":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,2})?$"},"organization_technologies_lookup":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,2})?$"},"features":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionTierFeature"},"readOnly":true},"stripe_subscription_prices":{"type":"array","items":{"$ref":"#/components/schemas/StripeSubscriptionPrice"},"readOnly":true}},"required":["features","id","name","stripe_subscription_prices"]}},"components/schemas/SubscriptionTierFeature":{"id":"components/schemas/SubscriptionTierFeature","kind":"json-schema","title":"SubscriptionTierFeature","data":{"type":"object","description":"Subscription tier feature serializer.","properties":{"description":{"type":"string","maxLength":255}},"required":["description"]}},"components/schemas/TotalCreditsSpent":{"id":"components/schemas/TotalCreditsSpent","kind":"json-schema","title":"TotalCreditsSpent","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Declares JSON representation of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CreditsBalanceChangeLogsView.total_credits_spent()"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action response."},"children":[]}]}]}],"properties":{"total_credits_spent":{"type":"string","format":"decimal","pattern":"^-?\\d{0,10}(?:\\.\\d{0,2})?$"}},"required":["total_credits_spent"]}},"components/schemas/User":{"id":"components/schemas/User","kind":"json-schema","title":"User","data":{"type":"object","description":"Account user serializer.","properties":{"id":{"type":"integer","readOnly":true},"username":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only."},"children":[]}]}]}],"pattern":"^[\\w.@+-]+$","maxLength":150},"email":{"type":"string","format":"email","title":"Email address","maxLength":254},"first_name":{"type":"string","maxLength":150},"last_name":{"type":"string","maxLength":150},"accounts":{"type":"array","items":{"$ref":"#/components/schemas/Account"},"readOnly":true}},"required":["accounts","email","id","username"]}},"components/schemas/ValidationStatusEnum":{"id":"components/schemas/ValidationStatusEnum","kind":"json-schema","title":"ValidationStatusEnum","data":{"enum":["valid","risky","invalid","unknown"],"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"valid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Valid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"risky"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Risky"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Invalid"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unknown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Unknown"},"children":[]}]}]}]}]}},"components/schemas/WebSite":{"id":"components/schemas/WebSite","kind":"json-schema","title":"WebSite","data":{"type":"object","description":"WebSite serializer.","properties":{"id":{"type":"integer","readOnly":true},"domain":{"type":"string","format":"uri","maxLength":200},"tranco_rank":{"type":"integer","maximum":2147483647,"minimum":0,"nullable":true,"description":"The Tranco three month average traffic rank"},"similarweb_rank":{"type":"integer","maximum":2147483647,"minimum":0,"nullable":true},"similarweb_traffic":{"type":"integer","maximum":9223372036854776000,"minimum":0,"format":"int64","nullable":true},"website_technologies":{"type":"array","items":{"$ref":"#/components/schemas/WebSiteTechnology"},"readOnly":true}},"required":["domain","id","website_technologies"]}},"components/schemas/WebSiteLookupRequest":{"id":"components/schemas/WebSiteLookupRequest","kind":"json-schema","title":"WebSiteLookupRequest","data":{"type":"object","description":"WebSite lookup API request serializer.","properties":{"domain":{"type":"string"},"organization_id":{"type":"integer"},"organization_linkedin_public_identifier":{"type":"string"}}}},"components/schemas/WebSiteTechnology":{"id":"components/schemas/WebSiteTechnology","kind":"json-schema","title":"WebSiteTechnology","data":{"type":"object","description":"WebSiteTechnology serializer.","properties":{"web_technology_id":{"type":"integer","readOnly":true},"is_active":{"type":"boolean","title":"Is active?"},"name":{"type":"string","description":"Get WebTechnology name.","readOnly":true}},"required":["name","web_technology_id"]}},"components/schemas/WorkEmailBatch":{"id":"components/schemas/WorkEmailBatch","kind":"json-schema","title":"WorkEmailBatch","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A batch and, once it is finished, everything it found."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One endpoint rather than two: polling a batch and reading its results are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"done together."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" stays empty until the batch is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so it is never a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"partial answer that looks like a whole one, and comes back "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in submitted"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so it lines up with the array that was sent."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resolved_from_cache"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are recorded on the batch but not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returned. How much of a batch we served without paying a vendor is our"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"business, and a bare count of rejected rows is not actionable now that each"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one is a result in its own right, carrying its own "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"batch_id":{"type":"string","format":"uuid","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/WorkEmailBatchStatusEnum"}],"readOnly":true},"item_count":{"type":"integer","description":"How many rows this batch holds.","readOnly":true},"date_created":{"type":"string","format":"date-time","readOnly":true},"date_completed":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/WorkEmailBatchItem"},"readOnly":true}},"required":["batch_id","date_completed","date_created","item_count","results","status"]}},"components/schemas/WorkEmailBatchItem":{"id":"components/schemas/WorkEmailBatchItem","kind":"json-schema","title":"WorkEmailBatchItem","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A batch result: a job plus the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"index"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" it held in the submitted array."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"index"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to the batch shape only - a single submit has no array to be"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an index into - so it is added here rather than on the base job serializer the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"single poll uses."},"children":[]}]}]}],"properties":{"submitted_index":{"type":"integer","readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zero-based position of this row in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email_lookups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array you submitted, so results can be matched back to your input order."},"children":[]}]}]}]},"job_id":{"type":"string","format":"uuid","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/Status564Enum"}],"readOnly":true},"emails":{"type":"array","items":{"type":"string"},"minLength":2,"maxLength":2,"description":"Every confirmed address for this person, shortest first, each with its verdict.","readOnly":true},"error_code":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ErrorCodeEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"person_id":{"type":"integer","readOnly":true,"nullable":true},"submitted_lookup":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echo the row exactly as it was sent."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nested rather than four top-level fields, so \"what you sent\" is never"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"confused with \"what we searched\", and so the top level keeps its rule"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that an absent value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - here a blank string is the honest echo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Spelled out key by key rather than dumped from the stored model, so a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"new column on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubmittedFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes a deliberate addition here"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instead of appearing in the response unasked."},"children":[]}]}]}],"properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"domain":{"type":"string"},"linkedin_public_identifier":{"type":"string"}},"required":["domain","first_name","last_name","linkedin_public_identifier"],"readOnly":true},"date_created":{"type":"string","format":"date-time","readOnly":true},"date_completed":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"result":{"type":"string","readOnly":true}},"required":["date_completed","date_created","emails","error_code","job_id","person_id","result","status","submitted_index","submitted_lookup"]}},"components/schemas/WorkEmailBatchStatusEnum":{"id":"components/schemas/WorkEmailBatchStatusEnum","kind":"json-schema","title":"WorkEmailBatchStatusEnum","data":{"enum":["queued","running","completed","failed"],"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"queued"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Queued"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"running"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Running"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"completed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Completed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Failed"},"children":[]}]}]}]}]}},"components/schemas/WorkEmailBatchSubmitted":{"id":"components/schemas/WorkEmailBatchSubmitted","kind":"json-schema","title":"WorkEmailBatchSubmitted","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"202"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body of a bulk submit: the batch, where to poll it, and the webhook echo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A serializer of its own rather than the batch poll serializer, so the 202 can"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"carry "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status_check_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and echo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webhook_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" without either leaking onto the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"poll response, which must never return the caller's secret-bearing URL."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is empty at submit and documented here only for shape."},"children":[]}]}]}],"properties":{"batch_id":{"type":"string","format":"uuid","readOnly":true},"status":{"type":"string","readOnly":true},"item_count":{"type":"integer","readOnly":true},"date_created":{"type":"string","format":"date-time","readOnly":true},"date_completed":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"status_check_url":{"type":"string","readOnly":true},"webhook_url":{"type":"string","readOnly":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/WorkEmailBatchItem"},"readOnly":true}},"required":["batch_id","date_completed","date_created","item_count","results","status","status_check_url","webhook_url"]}},"components/schemas/WorkEmailBulkRequest":{"id":"components/schemas/WorkEmailBulkRequest","kind":"json-schema","title":"WorkEmailBulkRequest","data":{"type":"object","description":"A batch of work email lookups, with an optional batch-scoped result webhook.","properties":{"email_lookups":{"type":"array","items":{"$ref":"#/components/schemas/WorkEmailLookupRequest"},"minItems":1},"webhook_url":{"type":"string","default":"","description":"Optional https URL we POST the results to when the batch completes, so you need not poll. Put any secret used to authenticate the callback in the URL query string; it is never returned by the poll endpoints or written to logs. Omit to poll only.","maxLength":2048}},"required":["email_lookups"]}},"components/schemas/WorkEmailLookupJob":{"id":"components/schemas/WorkEmailLookupJob","kind":"json-schema","title":"WorkEmailLookupJob","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The envelope every lookup result is returned in, single or bulk."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Narrower than the model: the vendor, the verification count and the miss"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reason are recorded but never returned, since they expose how the waterfall"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is built and would make swapping a provider a breaking change."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is how far a lookup got; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"result"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is what it concluded, and is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on a row that never ran."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"emails"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not a column on the job - it comes from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PersonWorkEmail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rows"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sharing its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lookup_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", read from a map in the serializer context so a batch"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"costs one cross-database query rather than one per row. Each entry carries its"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"own "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"validation_status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", since a person's addresses can be verified"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"separately."},"children":[]}]}]}],"properties":{"job_id":{"type":"string","format":"uuid","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/Status564Enum"}],"readOnly":true},"emails":{"type":"array","items":{"type":"string"},"minLength":2,"maxLength":2,"description":"Every confirmed address for this person, shortest first, each with its verdict.","readOnly":true},"error_code":{"readOnly":true,"nullable":true,"oneOf":[{"$ref":"#/components/schemas/ErrorCodeEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"person_id":{"type":"integer","readOnly":true,"nullable":true},"submitted_lookup":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echo the row exactly as it was sent."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nested rather than four top-level fields, so \"what you sent\" is never"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"confused with \"what we searched\", and so the top level keeps its rule"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that an absent value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - here a blank string is the honest echo."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Spelled out key by key rather than dumped from the stored model, so a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"new column on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SubmittedFields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes a deliberate addition here"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"instead of appearing in the response unasked."},"children":[]}]}]}],"properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"domain":{"type":"string"},"linkedin_public_identifier":{"type":"string"}},"required":["domain","first_name","last_name","linkedin_public_identifier"],"readOnly":true},"date_created":{"type":"string","format":"date-time","readOnly":true},"date_completed":{"type":"string","format":"date-time","readOnly":true,"nullable":true},"result":{"type":"string","readOnly":true}},"required":["date_completed","date_created","emails","error_code","job_id","person_id","result","status","submitted_lookup"]}},"components/schemas/WorkEmailLookupRequest":{"id":"components/schemas/WorkEmailLookupRequest","kind":"json-schema","title":"WorkEmailLookupRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One work email lookup request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" decides how the person is identified:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a domain, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are both required;"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" one, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linkedin_public_identifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required, and the name"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the employer domain are taken from the record it resolves."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A domain and an identifier together is refused: they can disagree about"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which company to search, and the answer would be unattributable."},"children":[]}]}]}],"properties":{"first_name":{"type":"string","default":""},"last_name":{"type":"string","default":""},"domain":{"type":"string","default":"","description":"Company domain, e.g. \"acme.com\". A full URL is accepted and reduced to its domain."},"linkedin_public_identifier":{"type":"string","default":"","description":"LinkedIn person \"Public identifier/Slug\" - \"linkedin.com/in/!slug!/\"."}}}},"components/schemas/WorkEmailLookupSubmitRequest":{"id":"components/schemas/WorkEmailLookupSubmitRequest","kind":"json-schema","title":"WorkEmailLookupSubmitRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The single-submit body: one lookup, plus an optional result webhook."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Kept apart from the bulk child "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WorkEmailLookupRequestSerializer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"webhook_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sits beside the lookup on a single submit but never appears on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"each row of a bulk request, where the target is batch-scoped instead."},"children":[]}]}]}],"properties":{"first_name":{"type":"string","default":""},"last_name":{"type":"string","default":""},"domain":{"type":"string","default":"","description":"Company domain, e.g. \"acme.com\". A full URL is accepted and reduced to its domain."},"linkedin_public_identifier":{"type":"string","default":"","description":"LinkedIn person \"Public identifier/Slug\" - \"linkedin.com/in/!slug!/\"."},"webhook_url":{"type":"string","default":"","description":"Optional https URL we POST the results to when the batch completes, so you need not poll. Put any secret used to authenticate the callback in the URL query string; it is never returned by the poll endpoints or written to logs. Omit to poll only.","maxLength":2048}}}},"components/schemas/WorkEmailLookupSubmitted":{"id":"components/schemas/WorkEmailLookupSubmitted","kind":"json-schema","title":"WorkEmailLookupSubmitted","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"202"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body of a single submit."},"children":[]}]}]}],"properties":{"job_id":{"type":"string","format":"uuid","readOnly":true},"status":{"type":"string","readOnly":true},"status_check_url":{"type":"string","readOnly":true},"webhook_url":{"type":"string","readOnly":true}},"required":["job_id","status","status_check_url","webhook_url"]}},"schema_13":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/PersonPhoneDetail"}},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/PersonEmailDetail"}},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/APIKey"}},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"string"},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Object primary key."},"text":{"type":"string","description":"Industry name."}}}},"pagination":{"type":"object","properties":{"more":{"type":"boolean","description":"If True then the next page is available."}}}}},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Object primary key."},"text":{"type":"string","description":"Organization name - Organization domain."}}}},"pagination":{"type":"object","properties":{"more":{"type":"boolean","description":"If True then the next page is available."}}}}},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Object primary key."},"text":{"type":"string","description":"Organization keywords name."}}}},"pagination":{"type":"object","properties":{"more":{"type":"boolean","description":"If True then the next page is available."}}}}},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Object primary key."},"text":{"type":"string","description":"Location name (Location place type)."}}}},"pagination":{"type":"object","properties":{"more":{"type":"boolean","description":"If True then the next page is available."}}}}},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Object primary key."},"text":{"type":"string","description":"Person skill name."}}}},"pagination":{"type":"object","properties":{"more":{"type":"boolean","description":"If True then the next page is available."}}}}},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Object primary key."},"text":{"type":"string","description":"Web technology name."}}}},"pagination":{"type":"object","properties":{"more":{"type":"boolean","description":"If True then the next page is available."}}}}},"id":"schema_25"}},"exampleStore":{},"securitySchemeStore":{"Api-Key":{"id":"Api-Key","type":"apiKey","in":"header","paramName":"X-API-KEY"}},"servers":[{"url":"https://api-v2.forager.ai"}],"specType":"openapi"},"options":{"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi.json?download"},{"url":"/_bundle/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Forager public API","description":"Forager public API endpoints documentation"}},"baseSlug":"/openapi","routesMapping":{}}