# Organizations ## Find organizations Find organizations matching a set of filters. This is the API equivalent of the organization search on [sumble.com](https://sumble.com). ### Credit cost Credit cost depends on whether you pass `include_entity_details: true`: * **Without `include_entity_details`** (or set to `false`): 5 credits per row returned. * **With `include_entity_details: true`**: results include technology counts per organization. The cost is 5 credits per filter term (technologies, job functions, or projects) per organization, with a minimum of 5 credits per organization. When filtering by technology categories, each technology in the category counts as a separate filter term — a category with 3 technologies costs 15 credits per organization. ## POST /v6/organizations/find > Find organizations ```json {"openapi":"3.1.0","info":{"title":"Sumble API","version":"v6"},"servers":[{"url":"https://api.sumble.com"}],"security":[{"api_token":[]}],"components":{"securitySchemes":{"api_token":{"type":"http","scheme":"bearer"}},"schemas":{"FindOrganizationsRequest":{"properties":{"filters":{"anyOf":[{"$ref":"#/components/schemas/app__schemas__paid_api__enrich__FindOrganizationsRequest__Filters"},{"$ref":"#/components/schemas/Query"}],"title":"Filters","description":"Filters to apply to the people search. Can be either a Filters object or a Query object."},"order_by_column":{"anyOf":[{"type":"string","enum":["industry","employee_count","employee_count_int","first_activity_time","last_activity_time","jobs_count","teams_count","people_count","jobs_count_growth_6mo","cloud_spend_estimate_millions_usd","account_score"]},{"type":"null"}],"title":"Order By Column","description":"Column to order by"},"order_by_direction":{"anyOf":[{"type":"string","enum":["ASC","DESC"]},{"type":"null"}],"title":"Order By Direction","description":"Direction to order by"},"include_entity_details":{"type":"boolean","title":"Include Entity Details","description":"Whether to include entity-specific data (matching_entities) in the response","default":false},"limit":{"type":"integer","maximum":200,"minimum":1,"title":"Limit","description":"Maximum number of results to return","default":10},"offset":{"type":"integer","maximum":10000,"minimum":0,"title":"Offset","description":"Number of results to skip","default":0}},"type":"object","required":["filters"],"title":"FindOrganizationsRequest"},"app__schemas__paid_api__enrich__FindOrganizationsRequest__Filters":{"properties":{"technologies":{"items":{"type":"string"},"type":"array","title":"Technologies","description":"Technologies to search for","default":[]},"technology_categories":{"items":{"type":"string"},"type":"array","title":"Technology Categories","description":"Technology categories to search for","default":[]},"since":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Since","description":"Only consider data since this date. Format: YYYY-MM-DD"}},"type":"object","title":"Filters"},"Query":{"properties":{"query":{"type":"string","title":"Query"}},"type":"object","required":["query"],"title":"Query"},"FindOrganizationsResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"credits_used":{"type":"integer","title":"Credits Used"},"credits_remaining":{"type":"integer","title":"Credits Remaining"},"organizations":{"items":{"$ref":"#/components/schemas/Item"},"type":"array","title":"Organizations"},"source_data_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Source Data Url"},"total":{"type":"integer","title":"Total"}},"type":"object","required":["id","credits_used","credits_remaining","organizations","source_data_url","total"],"title":"FindOrganizationsResponse"},"Item":{"properties":{"id":{"type":"integer","title":"Id"},"parent_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Parent Id"},"name":{"type":"string","title":"Name"},"url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Url"},"industry":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Industry"},"total_employees":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Employees"},"matching_people_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Matching People Count"},"matching_team_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Matching Team Count"},"matching_job_post_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Matching Job Post Count"},"headquarters_country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Headquarters Country"},"headquarters_state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Headquarters State"},"domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Domain"},"linkedin_organization_url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Linkedin Organization Url"},"account_score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Account Score"},"account_score_fit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Score Fit"},"matching_tags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Matching Tags"},"matching_entities":{"anyOf":[{"items":{"$ref":"#/components/schemas/Entity"},"type":"array"},{"type":"null"}],"title":"Matching Entities"},"funding_last_round_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Funding Last Round Type"},"funding_last_round_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Funding Last Round Date"},"funding_total_raised":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Funding Total Raised"},"funding_sources":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Funding Sources"}},"type":"object","required":["id","parent_id","name","url","industry","total_employees","matching_people_count","matching_team_count","matching_job_post_count","headquarters_country","headquarters_state","domain","linkedin_organization_url","funding_last_round_type","funding_last_round_date","funding_total_raised","funding_sources"],"title":"Item"},"Entity":{"properties":{"type":{"type":"string","title":"Type"},"term":{"type":"string","title":"Term"},"job_post_count":{"type":"integer","title":"Job Post Count"},"people_count":{"type":"integer","title":"People Count"},"team_count":{"type":"integer","title":"Team Count"},"job_post_used_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Job Post Used Count"},"team_count_used":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Team Count Used"}},"type":"object","required":["type","term","job_post_count","people_count","team_count","job_post_used_count","team_count_used"],"title":"Entity"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/v6/organizations/find":{"post":{"tags":["organizations"],"summary":"Find organizations","operationId":"find_organizations__api_version__organizations_find_post","parameters":[{"name":"require_mcp","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Require Mcp"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindOrganizationsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindOrganizationsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}} ``` *** ## Enrich an organization Enrich an organization with technology data. Provide a domain or organization slug, plus optional technology filters, and get back which of those technologies appear in the organization's job posts and team activity. When providing technology categories, all individual technologies in those categories will be used. ### Credit cost Each technology found costs 5 credits. If you filter by 10 technologies and 3 are found, that costs 15 credits. ## POST /v6/organizations/enrich > Enrich an organization with technology data ```json {"openapi":"3.1.0","info":{"title":"Sumble API","version":"v6"},"servers":[{"url":"https://api.sumble.com"}],"security":[{"api_token":[]}],"components":{"securitySchemes":{"api_token":{"type":"http","scheme":"bearer"}},"schemas":{"EnrichRequest":{"properties":{"organization":{"anyOf":[{"$ref":"#/components/schemas/OrganizationByDomain"},{"$ref":"#/components/schemas/OrganizationById"},{"$ref":"#/components/schemas/OrganizationBySlug"},{"$ref":"#/components/schemas/OrganizationByLinkedinUrl"}],"title":"Organization","description":"Organization to enrich"},"filters":{"anyOf":[{"$ref":"#/components/schemas/app__schemas__paid_api__enrich__EnrichRequest__Filters"},{"$ref":"#/components/schemas/Query"}],"title":"Filters","description":"Filters to apply to the people search. Can be either a Filters object or a Query object."}},"type":"object","required":["organization","filters"],"title":"EnrichRequest"},"OrganizationByDomain":{"properties":{"domain":{"type":"string","title":"Domain","description":"Company web domain"}},"type":"object","required":["domain"],"title":"OrganizationByDomain"},"OrganizationById":{"properties":{"id":{"type":"integer","title":"Id","description":"Organization Id on Sumble"}},"type":"object","required":["id"],"title":"OrganizationById"},"OrganizationBySlug":{"properties":{"slug":{"type":"string","title":"Slug","description":"Organization Slug on Sumble"}},"type":"object","required":["slug"],"title":"OrganizationBySlug"},"OrganizationByLinkedinUrl":{"properties":{"linkedin_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Linkedin Url","description":"Organization LinkedIn URL"}},"type":"object","required":["linkedin_url"],"title":"OrganizationByLinkedinUrl"},"app__schemas__paid_api__enrich__EnrichRequest__Filters":{"properties":{"technologies":{"items":{"type":"string"},"type":"array","title":"Technologies","description":"Technologies to search for","default":[]},"technology_categories":{"items":{"type":"string"},"type":"array","title":"Technology Categories","description":"Technology categories to search for","default":[]},"since":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Since","description":"Only consider data since this date. Format: YYYY-MM-DD"}},"type":"object","title":"Filters"},"Query":{"properties":{"query":{"type":"string","title":"Query"}},"type":"object","required":["query"],"title":"Query"},"EnrichResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"credits_used":{"type":"integer","title":"Credits Used"},"credits_remaining":{"type":"integer","title":"Credits Remaining"},"organization":{"$ref":"#/components/schemas/MatchedOrganization"},"technologies_found":{"type":"string","title":"Technologies Found"},"technologies_count":{"type":"integer","title":"Technologies Count"},"source_data_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Source Data Url"},"technologies":{"items":{"$ref":"#/components/schemas/EnrichResponseTechnology"},"type":"array","title":"Technologies"}},"type":"object","required":["id","credits_used","credits_remaining","organization","technologies_found","technologies_count","source_data_url","technologies"],"title":"EnrichResponse"},"MatchedOrganization":{"properties":{"id":{"type":"integer","title":"Id"},"slug":{"type":"string","title":"Slug"},"name":{"type":"string","title":"Name"},"domain":{"type":"string","title":"Domain"}},"type":"object","required":["id","slug","name","domain"],"title":"MatchedOrganization"},"EnrichResponseTechnology":{"properties":{"name":{"type":"string","title":"Name"},"last_job_post":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Job Post"},"jobs_count":{"type":"integer","title":"Jobs Count"},"jobs_data_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Jobs Data Url"},"people_count":{"type":"integer","title":"People Count"},"people_data_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"People Data Url"},"teams_count":{"type":"integer","title":"Teams Count"},"teams_data_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Teams Data Url"}},"type":"object","required":["name","last_job_post","jobs_count","jobs_data_url","people_count","people_data_url","teams_count","teams_data_url"],"title":"EnrichResponseTechnology"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/v6/organizations/enrich":{"post":{"tags":["organizations"],"summary":"Enrich an organization with technology data","operationId":"enrich_organization__api_version__organizations_enrich_post","parameters":[{"name":"require_mcp","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Require Mcp"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrichRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnrichResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}} ``` *** ## Retrieve an intelligence brief Retrieve an AI-generated intelligence brief for an organization. The brief summarizes the account angle, relevant contacts, technology signals, teams, and recent changes, and includes a link to view the same brief in Sumble. Intelligence briefs are generated asynchronously. If the brief is still being prepared, the API returns HTTP `202` with a `Retry-After` header. Retry the same URL after that interval to get the completed brief. ### Credit cost Completed intelligence briefs cost 50 credits. HTTP `202` pending responses do not consume credits. ## GET /v6/organizations/{organization\_id}/intelligence-brief > Retrieve the intelligence brief for an organization ```json {"openapi":"3.1.0","info":{"title":"Sumble API","version":"v6"},"servers":[{"url":"https://api.sumble.com"}],"security":[{"api_token":[]}],"components":{"securitySchemes":{"api_token":{"type":"http","scheme":"bearer"}},"schemas":{"IntelligenceBriefResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"credits_used":{"type":"integer","title":"Credits Used"},"credits_remaining":{"type":"integer","title":"Credits Remaining"},"organization_id":{"type":"integer","title":"Organization Id"},"organization_slug":{"type":"string","title":"Organization Slug"},"title":{"type":"string","title":"Title"},"body":{"type":"string","title":"Body"},"sumble_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Sumble Url"}},"type":"object","required":["id","credits_used","credits_remaining","organization_id","organization_slug","title","body","sumble_url"],"title":"IntelligenceBriefResponse"},"IntelligenceBriefPendingResponse":{"properties":{"status":{"type":"string","title":"Status","description":"Always 'pending' for 202 responses","default":"pending"},"organization_id":{"type":"integer","title":"Organization Id"},"organization_slug":{"type":"string","title":"Organization Slug"},"message":{"type":"string","title":"Message"}},"type":"object","required":["organization_id","organization_slug","message"],"title":"IntelligenceBriefPendingResponse","description":"Returned with HTTP 202 when the brief is being generated.\n\nThe caller should retry the same URL after the `Retry-After` header. No\ncredits are consumed for 202 responses."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/v6/organizations/{organization_id}/intelligence-brief":{"get":{"tags":["organizations"],"summary":"Retrieve the intelligence brief for an organization","operationId":"get_intelligence_brief__api_version__organizations__organization_id__intelligence_brief_get","parameters":[{"name":"organization_id","in":"path","required":true,"schema":{"type":"integer","title":"Organization Id"}},{"name":"require_mcp","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Require Mcp"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/IntelligenceBriefResponse"},{"$ref":"#/components/schemas/IntelligenceBriefPendingResponse"}],"title":"Response Get Intelligence Brief Api Version Organizations Organization Id Intelligence Brief Get"}}}},"202":{"description":"The brief is being generated. Retry the same URL after the `Retry-After` header. No credits are consumed.","headers":{"Retry-After":{"description":"Suggested seconds to wait before retrying the same URL","schema":{"type":"integer"}}},"content":{"application/json":{}}},"422":{"description":"The organization/domain does not have enough data to generate an intelligence brief. No credits are consumed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}} ``` *** ## Match organizations Submit a list of up to 1,000 organizations and get back which ones Sumble can identify. For each organization you provide a name, URL, and/or location — at least a name or URL is required. Sumble's entity resolution engine matches your input against its database and returns the matched organization details. This is useful for syncing a CRM export or target-account list with Sumble's data before running enrichment or search queries. ### Credit cost 1 credit per matched organization. Unmatched organizations are returned in the response but do not consume credits. ## POST /v6/organizations/match > Match a list of organizations ```json {"openapi":"3.1.0","info":{"title":"Sumble API","version":"v6"},"servers":[{"url":"https://api.sumble.com"}],"security":[{"api_token":[]}],"components":{"securitySchemes":{"api_token":{"type":"http","scheme":"bearer"}},"schemas":{"MatchOrganizationsRequest":{"properties":{"organizations":{"items":{"$ref":"#/components/schemas/MatchOrganizationInput"},"type":"array","maxItems":1000,"minItems":1,"title":"Organizations","description":"List of organizations to match"}},"type":"object","required":["organizations"],"title":"MatchOrganizationsRequest"},"MatchOrganizationInput":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Organization name"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","description":"Organization website URL or domain"},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location","description":"Organization location (country name or code)"},"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id","description":"Organization Id on Sumble. When set, the row identifies a Sumble org directly and bypasses matching; name/url/location are not required."},"slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Slug","description":"Organization slug on Sumble. When set, the row identifies a Sumble org directly and bypasses matching; name/url/location are not required."}},"type":"object","title":"MatchOrganizationInput"},"MatchOrganizationsResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"credits_used":{"type":"integer","title":"Credits Used"},"credits_remaining":{"type":"integer","title":"Credits Remaining"},"results":{"items":{"$ref":"#/components/schemas/MatchResult"},"type":"array","title":"Results"},"matched_count":{"type":"integer","title":"Matched Count"},"total":{"type":"integer","title":"Total"}},"type":"object","required":["id","credits_used","credits_remaining","results","matched_count","total"],"title":"MatchOrganizationsResponse"},"MatchResult":{"properties":{"input":{"$ref":"#/components/schemas/MatchOrganizationInput"},"match":{"anyOf":[{"$ref":"#/components/schemas/MatchedOrganization"},{"type":"null"}]}},"type":"object","required":["input"],"title":"MatchResult"},"MatchedOrganization":{"properties":{"id":{"type":"integer","title":"Id"},"slug":{"type":"string","title":"Slug"},"name":{"type":"string","title":"Name"},"domain":{"type":"string","title":"Domain"}},"type":"object","required":["id","slug","name","domain"],"title":"MatchedOrganization"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/v6/organizations/match":{"post":{"tags":["organizations"],"summary":"Match a list of organizations","operationId":"match_organizations_endpoint__api_version__organizations_match_post","parameters":[{"name":"require_mcp","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Require Mcp"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatchOrganizationsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatchOrganizationsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.sumble.com/api/organizations.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.