---
updatedAt: 2026-05-28T18:14:00.000Z
agentTools:
  projectIndex: https://data.crunchbase.com/llms.txt
---

# Search OrgSimilarity Entities

Can perform more complex filtering based on the query defined in the request body

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Predictions & Insights Package",
    "description": "Crunchbase Enterprise API - Predictions and Insights",
    "termsOfService": "https://data.crunchbase.com/docs/terms",
    "contact": {
      "email": "partnerships@crunchbase.com"
    },
    "version": "1.1.0"
  },
  "externalDocs": {
    "description": "API Reference doc",
    "url": "https://data.crunchbase.com/docs"
  },
  "servers": [
    {
      "url": "https://api.crunchbase.com/v4"
    }
  ],
  "security": [
    {
      "ApiKeyAuthHeader": []
    }
  ],
  "tags": [
    {
      "name": "Search"
    }
  ],
  "paths": {
    "/data/searches/org_similarities": {
      "post": {
        "tags": [
          "Search"
        ],
        "summary": "Search OrgSimilarity Entities",
        "description": "Can perform more complex filtering based on the query defined in the request body",
        "operationId": "searchOrgSimilarities",
        "requestBody": {
          "description": "Search Query Parameters",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/OrgSimilarityEntitySearch"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "$ref": "#/components/responses/OrgSimilaritySearchResults"
          },
          "400": {
            "$ref": "#/components/responses/GenericBadRequestError"
          },
          "404": {
            "$ref": "#/components/responses/GenericNotFoundError"
          },
          "500": {
            "$ref": "#/components/responses/GenericInternalServerError"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "OrgSimilarityFieldId": {
        "type": "string",
        "description": "OrgSimilarity field ids",
        "enum": [
          "additional_reasons",
          "category_group_overlap",
          "category_overlap",
          "created_at",
          "entity_def_id",
          "identifier",
          "location_overlap",
          "micro_category_overlap",
          "product_similarities",
          "score",
          "source",
          "target",
          "updated_at",
          "uuid"
        ]
      },
      "OrgSimilaritySearchPredicate": {
        "type": "object",
        "description": "Predicate for OrgSimilarity search",
        "allOf": [
          {
            "$ref": "#/components/schemas/Predicate"
          }
        ],
        "properties": {
          "field_id": {
            "type": "string",
            "description": "* additional_reasons - Additional Reasons. Operators: blank, includes, includes_all, not_includes, not_includes_all.\n* category_group_overlap - Shared Industry Groups. Operators: blank, includes, includes_all, not_includes, not_includes_all.\n* category_overlap - Shared Industries. Operators: blank, includes, includes_all, not_includes, not_includes_all.\n* created_at - Created At. Operators: between, blank, eq, gte, lte.\n* entity_def_id - Entity. Operators: blank, eq, includes, not_eq, not_includes.\n* identifier - Organization Similarity. Operators: blank, contains, eq, includes, not_contains, not_eq, not_includes, starts.\n* location_overlap - Location Overlap. Operators: blank, includes, includes_all, not_includes, not_includes_all.\n* micro_category_overlap - Shared Micro-Industries. Operators: blank, includes, includes_all, not_includes, not_includes_all.\n* product_similarities - Product Similarities. Operators: blank, includes, includes_all, not_includes, not_includes_all.\n* score - Similarity Score. Operators: between, blank, eq, gt, gte, lt, lte, not_eq.\n* source - Similar Organization Source. Operators: blank, contains, eq, includes, not_contains, not_eq, not_includes, starts.\n* target - Similar Organization Target. Operators: blank, contains, eq, includes, not_contains, not_eq, not_includes, starts.\n* updated_at - Updated At. Operators: between, blank, eq, gte, lte.\n* uuid - ID. Operators: blank, eq, includes, not_eq, not_includes.",
            "enum": [
              "additional_reasons",
              "category_group_overlap",
              "category_overlap",
              "created_at",
              "entity_def_id",
              "identifier",
              "location_overlap",
              "micro_category_overlap",
              "product_similarities",
              "score",
              "source",
              "target",
              "updated_at",
              "uuid"
            ],
            "x-enumDescriptions": {
              "additional_reasons": "Additional Reasons. Operators: blank, includes, includes_all, not_includes, not_includes_all.",
              "category_group_overlap": "Shared Industry Groups. Operators: blank, includes, includes_all, not_includes, not_includes_all.",
              "category_overlap": "Shared Industries. Operators: blank, includes, includes_all, not_includes, not_includes_all.",
              "created_at": "Created At. Operators: between, blank, eq, gte, lte.",
              "entity_def_id": "Entity. Operators: blank, eq, includes, not_eq, not_includes.",
              "identifier": "Organization Similarity. Operators: blank, contains, eq, includes, not_contains, not_eq, not_includes, starts.",
              "location_overlap": "Location Overlap. Operators: blank, includes, includes_all, not_includes, not_includes_all.",
              "micro_category_overlap": "Shared Micro-Industries. Operators: blank, includes, includes_all, not_includes, not_includes_all.",
              "product_similarities": "Product Similarities. Operators: blank, includes, includes_all, not_includes, not_includes_all.",
              "score": "Similarity Score. Operators: between, blank, eq, gt, gte, lt, lte, not_eq.",
              "source": "Similar Organization Source. Operators: blank, contains, eq, includes, not_contains, not_eq, not_includes, starts.",
              "target": "Similar Organization Target. Operators: blank, contains, eq, includes, not_contains, not_eq, not_includes, starts.",
              "updated_at": "Updated At. Operators: between, blank, eq, gte, lte.",
              "uuid": "ID. Operators: blank, eq, includes, not_eq, not_includes."
            }
          }
        }
      },
      "OrgSimilarityEntitySearch": {
        "type": "object",
        "description": "EntitySearch for OrgSimilarity search",
        "allOf": [
          {
            "$ref": "#/components/schemas/EntitySearch"
          },
          {
            "type": "object",
            "required": [
              "field_ids"
            ],
            "properties": {
              "field_ids": {
                "type": "array",
                "description": "The list of field_ids to include in the result",
                "items": {
                  "$ref": "#/components/schemas/OrgSimilarityFieldId"
                }
              },
              "query": {
                "type": "array",
                "description": "Search query to perform on the designated entity",
                "items": {
                  "$ref": "#/components/schemas/OrgSimilaritySearchPredicate"
                }
              }
            }
          }
        ]
      },
      "EntityIdentifier": {
        "type": "object",
        "description": "Every entity in the system has a unique identifier that contains all necessary properties to represent it.",
        "required": [
          "entity_def_id",
          "uuid"
        ],
        "properties": {
          "entity_def_id": {
            "type": "string",
            "enum": [
              "acquisition",
              "acquisition_prediction",
              "address",
              "award",
              "category",
              "category_group",
              "market_insight",
              "market_insight_reason",
              "closure_prediction",
              "current_valuation_comparable",
              "current_valuation_estimate",
              "degree",
              "diversity_spotlight",
              "event",
              "event_appearance",
              "fund",
              "funding_prediction",
              "funding_round",
              "growth_event",
              "growth_insight",
              "growth_prediction",
              "investment",
              "investor_insight",
              "investor_match",
              "ipo",
              "ipo_prediction",
              "job",
              "key_employee_change",
              "layoff",
              "layoff_prediction",
              "legal_proceeding",
              "location",
              "micro_category",
              "remain_private_prediction",
              "organization",
              "org_similarity",
              "product_similarity",
              "ownership",
              "partnership_announcement",
              "person",
              "press_reference",
              "product",
              "product_launch",
              "research_insight"
            ]
          },
          "image_id": {
            "type": "string",
            "maxLength": 255
          },
          "permalink": {
            "type": "string",
            "maxLength": 255
          },
          "uuid": {
            "type": "string",
            "description": "Universally Unique Identifier",
            "format": "uuid"
          },
          "value": {
            "type": "string",
            "maxLength": 255
          }
        }
      },
      "EntitySearch": {
        "type": "object",
        "required": [
          "field_ids",
          "query"
        ],
        "properties": {
          "after_id": {
            "type": "string",
            "description": "Used to paginate search results to the next page. after_id should be the uuid of the last item in the current page. May not be provided simultaneously with before_id.",
            "format": "uuid"
          },
          "before_id": {
            "type": "string",
            "description": "Used to paginate search results to the previous page. before_id should be the uuid of the first item in the current page. May not be provided simultaneously with after_id.",
            "format": "uuid"
          },
          "field_ids": {
            "type": "array",
            "items": {
              "type": "string",
              "description": "Fields to include as columns in the search result entities - array of field_id strings"
            }
          },
          "limit": {
            "type": "integer",
            "description": "Number of rows to return. Default is 100, min is 1, max is 1000."
          },
          "order": {
            "type": "array",
            "description": "Order in which the search results should be returned",
            "items": {
              "$ref": "#/components/schemas/Order"
            }
          },
          "query": {
            "type": "array",
            "description": "Search query to perform on the designated entity. Specify up-to 25 predicates.",
            "items": {
              "$ref": "#/components/schemas/Predicate"
            },
            "maxItems": 25
          }
        }
      },
      "Errors": {
        "type": "object",
        "description": "Developer friendly error message",
        "properties": {
          "value": {
            "type": "string",
            "description": "stuff"
          }
        }
      },
      "LocationIdentifier": {
        "type": "object",
        "description": "Every location entity in the system has a unique identifier that contains all necessary properties to represent it.",
        "required": [
          "uuid",
          "entity_def_id"
        ],
        "properties": {
          "entity_def_id": {
            "type": "string",
            "description": "What type of entity this be"
          },
          "image_id": {
            "type": "string",
            "description": "Optionally provided location to obtain an image representing this entity"
          },
          "location_type": {
            "$ref": "#/components/schemas/LocationTypeEnum"
          },
          "permalink": {
            "type": "string",
            "description": "Optionally provided within Entity Def unique nice id of this entity"
          },
          "uuid": {
            "type": "string",
            "description": "Globally unique id of this entity",
            "format": "uuid"
          },
          "value": {
            "type": "string",
            "description": "Textual representation of this entity (i.e. its \"name\")"
          }
        }
      },
      "LocationTypeEnum": {
        "type": "string",
        "enum": [
          "city",
          "region",
          "country",
          "continent",
          "group"
        ]
      },
      "OperatorEnum": {
        "type": "string",
        "description": "Search operations for use in predicates\n* between - Between. Provide two values in \"values\"\n* blank - Is blank. Possible values in \"values\" is \"true\" or \"false\"\n* contains - Contains\n* domain_blank - Domain is blank. Possible values in \"values\" is \"true\" or \"false\"\n* domain_eq - Domain equals\n* domain_includes - Domain includes any\n* eq - Equals\n* gt - Greater than\n* gte - Greater than or equal to\n* includes - Includes any\n* includes_all - Includes all\n* lt - Less than\n* lte - Less than or equal to\n* not_contains - Does not contain\n* not_domain_eq - Domain not equal\n* not_domain_includes - Domain does not include\n* not_eq - Does not equal\n* not_includes - Does not include\n* not_includes_all - Does not include all\n* starts - Starts with",
        "enum": [
          "blank",
          "eq",
          "not_eq",
          "gt",
          "gte",
          "lt",
          "lte",
          "starts",
          "contains",
          "not_contains",
          "between",
          "includes",
          "not_includes",
          "includes_all",
          "not_includes_all",
          "domain_eq",
          "not_domain_eq",
          "domain_blank",
          "domain_includes",
          "not_domain_includes"
        ],
        "x-enumDescriptions": {
          "between": "Between. Provide two values in \"values\"",
          "blank": "Is blank. Possible values in \"values\" is \"true\" or \"false\"",
          "contains": "Contains",
          "domain_blank": "Domain is blank. Possible values in \"values\" is \"true\" or \"false\"",
          "domain_eq": "Domain equals",
          "domain_includes": "Domain includes any",
          "eq": "Equals",
          "gt": "Greater than",
          "gte": "Greater than or equal to",
          "includes": "Includes any",
          "includes_all": "Includes all",
          "lt": "Less than",
          "lte": "Less than or equal to",
          "not_contains": "Does not contain",
          "not_domain_eq": "Domain not equal",
          "not_domain_includes": "Domain does not include",
          "not_eq": "Does not equal",
          "not_includes": "Does not include",
          "not_includes_all": "Does not include all",
          "starts": "Starts with"
        }
      },
      "Order": {
        "type": "object",
        "required": [
          "field_id",
          "sort"
        ],
        "properties": {
          "field_id": {
            "type": "string",
            "description": "Name of the field to sort on"
          },
          "nulls": {
            "type": "string",
            "enum": [
              "first",
              "last"
            ]
          },
          "sort": {
            "type": "string",
            "enum": [
              "asc",
              "desc"
            ],
            "default": "asc"
          }
        }
      },
      "OrgSimilarity": {
        "type": "object",
        "required": [
          "identifier"
        ],
        "properties": {
          "additional_reasons": {
            "type": "array",
            "items": {
              "type": "string",
              "description": "* global_location_overlap - Global Location Overlap",
              "enum": [
                "global_location_overlap"
              ]
            },
            "x-cb-field-type": "enum_multi",
            "x-cb-searchable": true,
            "x-cb-search-operators": [
              "blank",
              "includes",
              "includes_all",
              "not_includes",
              "not_includes_all"
            ]
          },
          "category_group_overlap": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EntityIdentifier"
            },
            "x-cb-field-type": "identifier_multi",
            "x-cb-searchable": true,
            "x-cb-search-operators": [
              "blank",
              "includes",
              "includes_all",
              "not_includes",
              "not_includes_all"
            ]
          },
          "category_overlap": {
            "type": "array",
            "description": "Shared Industries",
            "items": {
              "$ref": "#/components/schemas/EntityIdentifier"
            },
            "x-cb-field-type": "identifier_multi",
            "x-cb-searchable": true,
            "x-cb-search-operators": [
              "blank",
              "includes",
              "includes_all",
              "not_includes",
              "not_includes_all"
            ]
          },
          "created_at": {
            "type": "string",
            "description": "Created At",
            "format": "date-time",
            "x-cb-field-type": "datetime",
            "x-cb-searchable": true,
            "x-cb-search-operators": [
              "between",
              "blank",
              "eq",
              "gte",
              "lte"
            ]
          },
          "entity_def_id": {
            "type": "string",
            "description": "* org_similarity - Organization Similarity",
            "enum": [
              "org_similarity"
            ],
            "x-enum-descriptions": [
              "Organization Similarity"
            ],
            "x-cb-field-enum-values": [
              {
                "value": "org_similarity",
                "description": "Organization Similarity"
              }
            ],
            "x-cb-field-type": "enum",
            "x-cb-searchable": true,
            "x-cb-search-operators": [
              "blank",
              "eq",
              "includes",
              "not_eq",
              "not_includes"
            ]
          },
          "identifier": {
            "type": "object",
            "description": "Organization Similarity",
            "allOf": [
              {
                "$ref": "#/components/schemas/EntityIdentifier"
              }
            ],
            "x-cb-field-type": "identifier",
            "x-cb-searchable": true,
            "x-cb-search-operators": [
              "blank",
              "contains",
              "eq",
              "includes",
              "not_contains",
              "not_eq",
              "not_includes",
              "starts"
            ]
          },
          "location_overlap": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/LocationIdentifier"
            },
            "x-cb-field-type": "identifier_multi",
            "x-cb-searchable": true,
            "x-cb-search-operators": [
              "blank",
              "includes",
              "includes_all",
              "not_includes",
              "not_includes_all"
            ]
          },
          "micro_category_overlap": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EntityIdentifier"
            },
            "x-cb-field-type": "identifier_multi",
            "x-cb-searchable": true,
            "x-cb-search-operators": [
              "blank",
              "includes",
              "includes_all",
              "not_includes",
              "not_includes_all"
            ]
          },
          "product_similarities": {
            "type": "array",
            "description": "Product Similarities",
            "items": {
              "$ref": "#/components/schemas/EntityIdentifier"
            },
            "x-cb-field-type": "identifier_multi",
            "x-cb-searchable": true,
            "x-cb-search-operators": [
              "blank",
              "includes",
              "includes_all",
              "not_includes",
              "not_includes_all"
            ]
          },
          "score": {
            "type": "number",
            "format": "double",
            "x-cb-field-type": "decimal",
            "x-cb-searchable": true,
            "x-cb-search-operators": [
              "between",
              "blank",
              "eq",
              "gt",
              "gte",
              "lt",
              "lte",
              "not_eq"
            ]
          },
          "source": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/EntityIdentifier"
              }
            ],
            "x-cb-field-type": "identifier",
            "x-cb-searchable": true,
            "x-cb-search-operators": [
              "blank",
              "contains",
              "eq",
              "includes",
              "not_contains",
              "not_eq",
              "not_includes",
              "starts"
            ]
          },
          "target": {
            "type": "object",
            "allOf": [
              {
                "$ref": "#/components/schemas/EntityIdentifier"
              }
            ],
            "x-cb-field-type": "identifier",
            "x-cb-searchable": true,
            "x-cb-search-operators": [
              "blank",
              "contains",
              "eq",
              "includes",
              "not_contains",
              "not_eq",
              "not_includes",
              "starts"
            ]
          },
          "updated_at": {
            "type": "string",
            "description": "Updated At",
            "format": "date-time",
            "x-cb-field-type": "datetime",
            "x-cb-searchable": true,
            "x-cb-search-operators": [
              "between",
              "blank",
              "eq",
              "gte",
              "lte"
            ]
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "x-cb-field-type": "uuid",
            "x-cb-searchable": true,
            "x-cb-search-operators": [
              "blank",
              "eq",
              "includes",
              "not_eq",
              "not_includes"
            ]
          }
        }
      },
      "Predicate": {
        "type": "object",
        "description": "A simple search criterion",
        "required": [
          "type",
          "field_id",
          "operator_id"
        ],
        "properties": {
          "field_id": {
            "type": "string",
            "description": "The field to operate on"
          },
          "operator_id": {
            "$ref": "#/components/schemas/OperatorEnum"
          },
          "type": {
            "type": "string",
            "description": "The type of the query (Predicate)",
            "enum": [
              "predicate"
            ],
            "default": "predicate"
          },
          "values": {
            "type": "array",
            "description": "Values array with data type matching field_id type",
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "number"
                },
                {
                  "type": "boolean"
                }
              ]
            },
            "maxItems": 200
          }
        }
      }
    },
    "responses": {
      "GenericBadRequestError": {
        "description": "Bad Request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Errors"
            }
          }
        }
      },
      "GenericNotFoundError": {
        "description": "Not Found",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Errors"
            }
          }
        }
      },
      "GenericInternalServerError": {
        "description": "Request Failed",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Errors"
            }
          }
        }
      },
      "OrgSimilaritySearchResults": {
        "description": "Results are identifiers matching the search query",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "description": "Search results include OrgSimilarity entities",
              "properties": {
                "count": {
                  "type": "integer",
                  "description": "Total number of OrgSimilarity entities"
                },
                "entities": {
                  "type": "array",
                  "description": "List of OrgSimilarity entities",
                  "items": {
                    "type": "object",
                    "properties": {
                      "properties": {
                        "$ref": "#/components/schemas/OrgSimilarity"
                      },
                      "uuid": {
                        "type": "string",
                        "description": "UUID of the entity",
                        "format": "uuid"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "securitySchemes": {
      "ApiKeyAuthHeader": {
        "type": "apiKey",
        "name": "X-cb-user-key",
        "in": "header"
      }
    }
  }
}
```