Jump to

• Request
• Response
• Examples

Get list of companies/contacts that match criteria

post

/api/v4/search

This shows search results for companies/contacts that only contain those attributes for which a value exists.

Versions Supported:

v4

Full List of Company Attributes: Company Attributes
Full List of Contact Attributes: Contact Attributes

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml; charset=UTF-8
• application/json; charset=UTF-8

Request Body - application/json; charset=UTF-8 ()

The SearchRequest entity holding the search request

Example XML:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<searchRequest>
	<facetLimit>10</facetLimit>
	<filterFields>
		<name>info.organization_name</name>
		<operator>EQ</operator>
		<value>oracle</value>
	</filterFields>
	<filterFields>
		<name>location.country</name>
		<operator>EQ</operator>
		<value>USA</value>
	</filterFields>
	<filterFields>
		<name>company.ees_total</name>
		<operator>GT</operator>
		<value>100</value>
	</filterFields>
	<filterFields>
		<name>company.sales_volume</name>
		<operator>LTE</operator>
		<value>150000000</value>
	</filterFields>
	<limit>10</limit>
	<objectType>Companies</objectType>
	<offset>0</offset>
	<orderByDirection>DESC</orderByDirection>
	<rangeFilters>
		<name>company.ees_total</name>
		<range>
			<from>2</from>
			<to>1000000</to>
		</range>
	</rangeFilters>
	<defaultFilters>
		<filterName>Defunct</filterName>		
	</defaultFilters>
	<returnAll>false</returnAll>
	<returnFacets>location</returnFacets>
	<returnFacets>company.maj_ind_cg</returnFacets>
	<returnFields>location.country</returnFields>
	<returnFields>location.city</returnFields>
	<returnFields>company.maj_ind_cg</returnFields>
</searchRequest>

Example JSON:

{
	"facetLimit":"10",
	"filterFields":[{
		"name":"info.organization_name",
		"operator":"EQ",
		"value":"oracle"
		},
		{
		"name":"location.country",
		"operator":"EQ",
		"value":"USA"
		},
		{
	 	"name":"company.ees_total",
		"operator":"GT",
	 	"value":"100"           
	},
	{
	 	"name":"company.sales_volume",
		"operator":"LTE",
	 	"value":"150000000"           
	}],
	"limit":"10",
	"objectType":"Companies",
	"offset":"0",
	"orderByDirection":"DESC",
	"rangeFilters":{
		"name":"company.ees_total",
		"range":{
			"from":"2",
			"to":"1000000"
			}
	},
 		"defaultFilters" : [{
 		    "filterName" : "Defunct"
 		 }],
	"returnAll":"false",
	"returnFacets":["location","company.maj_ind_cg"],
	"returnFields":["location.country","location.city","company.maj_ind_cg"]
}
 

Root Schema : schema

Type: object

Show Source

• advancedSearch(optional): object AdvancedSearchFilters
• defaultFilters(optional): array defaultFilters
• exportCount(optional): boolean
• facetLimit(optional): integer(int32)
• filterFields(optional): array filterFields
• filterQuery(optional): string
• limit(optional): integer(int32)
• mapName(optional): string
• objectType(optional): string
  Allowed Values: [ "Companies", "People" ]
• offset(optional): integer(int32)
• orderBy(optional): string
• orderByDir(optional): string
• orderByDirection(optional): string
  Allowed Values: [ "ASC", "DESC" ]
• query(optional): string
• radialFilter(optional): object RadialFilter
• rangeFilters(optional): array rangeFilters
• returnAll(optional): boolean
• returnFacetFields(optional): array returnFacetFields
• returnFacets(optional): array returnFacets
• returnFields(optional): array returnFields
• selectedFacets(optional): array selectedFacets

{
    "properties":{
        "advancedSearch":{
            "$ref":"#/components/schemas/AdvancedSearchFilters"
        },
        "defaultFilters":{
            "items":{
            },
            "type":"array"
        },
        "exportCount":{
            "type":"boolean"
        },
        "facetLimit":{
            "format":"int32",
            "type":"integer"
        },
        "filterFields":{
            "items":{
                "$ref":"#/components/schemas/FilterInfo"
            },
            "type":"array"
        },
        "filterQuery":{
            "type":"string"
        },
        "limit":{
            "format":"int32",
            "type":"integer"
        },
        "mapName":{
            "type":"string"
        },
        "objectType":{
            "$ref":"#/components/schemas/ObjectType"
        },
        "offset":{
            "format":"int32",
            "type":"integer"
        },
        "orderBy":{
            "type":"string"
        },
        "orderByDir":{
            "type":"string"
        },
        "orderByDirection":{
            "$ref":"#/components/schemas/OrderBy"
        },
        "query":{
            "type":"string"
        },
        "radialFilter":{
            "$ref":"#/components/schemas/RadialFilter"
        },
        "rangeFilters":{
            "items":{
                "$ref":"#/components/schemas/RangeFilterInfo"
            },
            "type":"array"
        },
        "returnAll":{
            "type":"boolean"
        },
        "returnFacetFields":{
            "items":{
                "$ref":"#/components/schemas/FacetFieldInfo"
            },
            "type":"array"
        },
        "returnFacets":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "returnFields":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "selectedFacets":{
            "items":{
                "$ref":"#/components/schemas/FilterInfo"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : AdvancedSearchFilters

Type: object

Show Source

• advancedFilterQuery(optional): string
• advancedFilters(optional): array advancedFilters

{
    "properties":{
        "advancedFilterQuery":{
            "type":"string"
        },
        "advancedFilters":{
            "items":{
                "$ref":"#/components/schemas/AdvancedSearchFilterSet"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : defaultFilters

Type: array

Show Source

• Array of:

{
    "items":{
    },
    "type":"array"
}

Nested Schema : filterFields

Type: array

Show Source

• Array of: object FilterInfo

{
    "items":{
        "$ref":"#/components/schemas/FilterInfo"
    },
    "type":"array"
}

Nested Schema : RadialFilter

Type: object

Show Source

• countryName(optional): string
• isNotNullFlag(optional): boolean
• name(optional): string
• notNullFlag(optional): boolean
• operator(optional): string
  Allowed Values: [ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
• radius(optional): string
• unit(optional): string
  Allowed Values: [ "km", "mi" ]
• value(optional): string

{
    "properties":{
        "isNotNullFlag":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "operator":{
            "$ref":"#/components/schemas/OPERATOR"
        },
        "value":{
            "type":"string"
        },
        "notNullFlag":{
            "type":"boolean"
        },
        "countryName":{
            "type":"string"
        },
        "radius":{
            "type":"string"
        },
        "unit":{
            "$ref":"#/components/schemas/UNIT"
        }
    },
    "type":"object"
}

Nested Schema : rangeFilters

Type: array

Show Source

• Array of: object RangeFilterInfo

{
    "items":{
        "$ref":"#/components/schemas/RangeFilterInfo"
    },
    "type":"array"
}

Nested Schema : returnFacetFields

Type: array

Show Source

• Array of: object FacetFieldInfo

{
    "items":{
        "$ref":"#/components/schemas/FacetFieldInfo"
    },
    "type":"array"
}

Nested Schema : returnFacets

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : returnFields

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : selectedFacets

Type: array

Show Source

• Array of: object FilterInfo

{
    "items":{
        "$ref":"#/components/schemas/FilterInfo"
    },
    "type":"array"
}

Nested Schema : advancedFilters

Type: array

Show Source

• Array of: object AdvancedSearchFilterSet

{
    "items":{
        "$ref":"#/components/schemas/AdvancedSearchFilterSet"
    },
    "type":"array"
}

Nested Schema : AdvancedSearchFilterSet

Type: object

Show Source

• filterFields(optional): array filterFields
• filterSetId(optional): string
• match(optional): string
  Allowed Values: [ "ALL", "ANY" ]
• rangeFilters(optional): array rangeFilters

{
    "properties":{
        "filterFields":{
            "items":{
                "$ref":"#/components/schemas/FilterInfo"
            },
            "type":"array"
        },
        "filterSetId":{
            "type":"string"
        },
        "match":{
            "$ref":"#/components/schemas/Match"
        },
        "rangeFilters":{
            "items":{
                "$ref":"#/components/schemas/RangeFilterInfo"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : filterFields

Type: array

Show Source

• Array of: object FilterInfo

{
    "items":{
        "$ref":"#/components/schemas/FilterInfo"
    },
    "type":"array"
}

Nested Schema : rangeFilters

Type: array

Show Source

• Array of: object RangeFilterInfo

{
    "items":{
        "$ref":"#/components/schemas/RangeFilterInfo"
    },
    "type":"array"
}

Nested Schema : FilterInfo

Type: object

Show Source

• isNotNullFlag(optional): boolean
• name(optional): string
• notNullFlag(optional): boolean
• operator(optional): string
  Allowed Values: [ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
• value(optional): string

{
    "properties":{
        "isNotNullFlag":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "operator":{
            "$ref":"#/components/schemas/OPERATOR"
        },
        "value":{
            "type":"string"
        },
        "notNullFlag":{
            "type":"boolean"
        }
    },
    "type":"object"
}

Nested Schema : RangeFilterInfo

Type: object

Show Source

• isNotNullFlag(optional): boolean
• name(optional): string
• notNullFlag(optional): boolean
• operator(optional): string
  Allowed Values: [ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
• range(optional): object Range
• value(optional): string

{
    "properties":{
        "isNotNullFlag":{
            "type":"boolean"
        },
        "operator":{
            "$ref":"#/components/schemas/OPERATOR"
        },
        "value":{
            "type":"string"
        },
        "notNullFlag":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "range":{
            "$ref":"#/components/schemas/Range"
        }
    },
    "type":"object"
}

Nested Schema : Range

Type: object

Show Source

• from(optional): string
• to(optional): string

{
    "properties":{
        "from":{
            "type":"string"
        },
        "to":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : FacetFieldInfo

Type: object

Show Source

• limit(optional): integer(int32)
• minCount(optional): integer(int32)
• name(optional): string
• offset(optional): integer(int32)
• sortBy(optional): string
  Allowed Values: [ "count", "index" ]

{
    "properties":{
        "limit":{
            "format":"int32",
            "type":"integer"
        },
        "minCount":{
            "format":"int32",
            "type":"integer"
        },
        "name":{
            "type":"string"
        },
        "offset":{
            "format":"int32",
            "type":"integer"
        },
        "sortBy":{
            "$ref":"#/components/schemas/SortBy"
        }
    },
    "type":"object"
}

Request Body - application/xml; charset=UTF-8 ()

The SearchRequest entity holding the search request

Example XML:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<searchRequest>
	<facetLimit>10</facetLimit>
	<filterFields>
		<name>info.organization_name</name>
		<operator>EQ</operator>
		<value>oracle</value>
	</filterFields>
	<filterFields>
		<name>location.country</name>
		<operator>EQ</operator>
		<value>USA</value>
	</filterFields>
	<filterFields>
		<name>company.ees_total</name>
		<operator>GT</operator>
		<value>100</value>
	</filterFields>
	<filterFields>
		<name>company.sales_volume</name>
		<operator>LTE</operator>
		<value>150000000</value>
	</filterFields>
	<limit>10</limit>
	<objectType>Companies</objectType>
	<offset>0</offset>
	<orderByDirection>DESC</orderByDirection>
	<rangeFilters>
		<name>company.ees_total</name>
		<range>
			<from>2</from>
			<to>1000000</to>
		</range>
	</rangeFilters>
	<defaultFilters>
		<filterName>Defunct</filterName>		
	</defaultFilters>
	<returnAll>false</returnAll>
	<returnFacets>location</returnFacets>
	<returnFacets>company.maj_ind_cg</returnFacets>
	<returnFields>location.country</returnFields>
	<returnFields>location.city</returnFields>
	<returnFields>company.maj_ind_cg</returnFields>
</searchRequest>

Example JSON:

{
	"facetLimit":"10",
	"filterFields":[{
		"name":"info.organization_name",
		"operator":"EQ",
		"value":"oracle"
		},
		{
		"name":"location.country",
		"operator":"EQ",
		"value":"USA"
		},
		{
	 	"name":"company.ees_total",
		"operator":"GT",
	 	"value":"100"           
	},
	{
	 	"name":"company.sales_volume",
		"operator":"LTE",
	 	"value":"150000000"           
	}],
	"limit":"10",
	"objectType":"Companies",
	"offset":"0",
	"orderByDirection":"DESC",
	"rangeFilters":{
		"name":"company.ees_total",
		"range":{
			"from":"2",
			"to":"1000000"
			}
	},
 		"defaultFilters" : [{
 		    "filterName" : "Defunct"
 		 }],
	"returnAll":"false",
	"returnFacets":["location","company.maj_ind_cg"],
	"returnFields":["location.country","location.city","company.maj_ind_cg"]
}
 

Root Schema : schema

Type: object

Show Source

• advancedSearch(optional): object AdvancedSearchFilters
• defaultFilters(optional): array defaultFilters
• exportCount(optional): boolean
• facetLimit(optional): integer(int32)
• filterFields(optional): array filterFields
• filterQuery(optional): string
• limit(optional): integer(int32)
• mapName(optional): string
• objectType(optional): string
  Allowed Values: [ "Companies", "People" ]
• offset(optional): integer(int32)
• orderBy(optional): string
• orderByDir(optional): string
• orderByDirection(optional): string
  Allowed Values: [ "ASC", "DESC" ]
• query(optional): string
• radialFilter(optional): object RadialFilter
• rangeFilters(optional): array rangeFilters
• returnAll(optional): boolean
• returnFacetFields(optional): array returnFacetFields
• returnFacets(optional): array returnFacets
• returnFields(optional): array returnFields
• selectedFacets(optional): array selectedFacets

{
    "properties":{
        "advancedSearch":{
            "$ref":"#/components/schemas/AdvancedSearchFilters"
        },
        "defaultFilters":{
            "items":{
            },
            "type":"array"
        },
        "exportCount":{
            "type":"boolean"
        },
        "facetLimit":{
            "format":"int32",
            "type":"integer"
        },
        "filterFields":{
            "items":{
                "$ref":"#/components/schemas/FilterInfo"
            },
            "type":"array"
        },
        "filterQuery":{
            "type":"string"
        },
        "limit":{
            "format":"int32",
            "type":"integer"
        },
        "mapName":{
            "type":"string"
        },
        "objectType":{
            "$ref":"#/components/schemas/ObjectType"
        },
        "offset":{
            "format":"int32",
            "type":"integer"
        },
        "orderBy":{
            "type":"string"
        },
        "orderByDir":{
            "type":"string"
        },
        "orderByDirection":{
            "$ref":"#/components/schemas/OrderBy"
        },
        "query":{
            "type":"string"
        },
        "radialFilter":{
            "$ref":"#/components/schemas/RadialFilter"
        },
        "rangeFilters":{
            "items":{
                "$ref":"#/components/schemas/RangeFilterInfo"
            },
            "type":"array"
        },
        "returnAll":{
            "type":"boolean"
        },
        "returnFacetFields":{
            "items":{
                "$ref":"#/components/schemas/FacetFieldInfo"
            },
            "type":"array"
        },
        "returnFacets":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "returnFields":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "selectedFacets":{
            "items":{
                "$ref":"#/components/schemas/FilterInfo"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : AdvancedSearchFilters

Type: object

Show Source

• advancedFilterQuery(optional): string
• advancedFilters(optional): array advancedFilters

{
    "properties":{
        "advancedFilterQuery":{
            "type":"string"
        },
        "advancedFilters":{
            "items":{
                "$ref":"#/components/schemas/AdvancedSearchFilterSet"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : defaultFilters

Type: array

Show Source

• Array of:

{
    "items":{
    },
    "type":"array"
}

Nested Schema : filterFields

Type: array

Show Source

• Array of: object FilterInfo

{
    "items":{
        "$ref":"#/components/schemas/FilterInfo"
    },
    "type":"array"
}

Nested Schema : RadialFilter

Type: object

Show Source

• countryName(optional): string
• isNotNullFlag(optional): boolean
• name(optional): string
• notNullFlag(optional): boolean
• operator(optional): string
  Allowed Values: [ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
• radius(optional): string
• unit(optional): string
  Allowed Values: [ "km", "mi" ]
• value(optional): string

{
    "properties":{
        "isNotNullFlag":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "operator":{
            "$ref":"#/components/schemas/OPERATOR"
        },
        "value":{
            "type":"string"
        },
        "notNullFlag":{
            "type":"boolean"
        },
        "countryName":{
            "type":"string"
        },
        "radius":{
            "type":"string"
        },
        "unit":{
            "$ref":"#/components/schemas/UNIT"
        }
    },
    "type":"object"
}

Nested Schema : rangeFilters

Type: array

Show Source

• Array of: object RangeFilterInfo

{
    "items":{
        "$ref":"#/components/schemas/RangeFilterInfo"
    },
    "type":"array"
}

Nested Schema : returnFacetFields

Type: array

Show Source

• Array of: object FacetFieldInfo

{
    "items":{
        "$ref":"#/components/schemas/FacetFieldInfo"
    },
    "type":"array"
}

Nested Schema : returnFacets

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : returnFields

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : selectedFacets

Type: array

Show Source

• Array of: object FilterInfo

{
    "items":{
        "$ref":"#/components/schemas/FilterInfo"
    },
    "type":"array"
}

Nested Schema : advancedFilters

Type: array

Show Source

• Array of: object AdvancedSearchFilterSet

{
    "items":{
        "$ref":"#/components/schemas/AdvancedSearchFilterSet"
    },
    "type":"array"
}

Nested Schema : AdvancedSearchFilterSet

Type: object

Show Source

• filterFields(optional): array filterFields
• filterSetId(optional): string
• match(optional): string
  Allowed Values: [ "ALL", "ANY" ]
• rangeFilters(optional): array rangeFilters

{
    "properties":{
        "filterFields":{
            "items":{
                "$ref":"#/components/schemas/FilterInfo"
            },
            "type":"array"
        },
        "filterSetId":{
            "type":"string"
        },
        "match":{
            "$ref":"#/components/schemas/Match"
        },
        "rangeFilters":{
            "items":{
                "$ref":"#/components/schemas/RangeFilterInfo"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : filterFields

Type: array

Show Source

• Array of: object FilterInfo

{
    "items":{
        "$ref":"#/components/schemas/FilterInfo"
    },
    "type":"array"
}

Nested Schema : rangeFilters

Type: array

Show Source

• Array of: object RangeFilterInfo

{
    "items":{
        "$ref":"#/components/schemas/RangeFilterInfo"
    },
    "type":"array"
}

Nested Schema : FilterInfo

Type: object

Show Source

• isNotNullFlag(optional): boolean
• name(optional): string
• notNullFlag(optional): boolean
• operator(optional): string
  Allowed Values: [ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
• value(optional): string

{
    "properties":{
        "isNotNullFlag":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "operator":{
            "$ref":"#/components/schemas/OPERATOR"
        },
        "value":{
            "type":"string"
        },
        "notNullFlag":{
            "type":"boolean"
        }
    },
    "type":"object"
}

Nested Schema : RangeFilterInfo

Type: object

Show Source

• isNotNullFlag(optional): boolean
• name(optional): string
• notNullFlag(optional): boolean
• operator(optional): string
  Allowed Values: [ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
• range(optional): object Range
• value(optional): string

{
    "properties":{
        "isNotNullFlag":{
            "type":"boolean"
        },
        "operator":{
            "$ref":"#/components/schemas/OPERATOR"
        },
        "value":{
            "type":"string"
        },
        "notNullFlag":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "range":{
            "$ref":"#/components/schemas/Range"
        }
    },
    "type":"object"
}

Nested Schema : Range

Type: object

Show Source

• from(optional): string
• to(optional): string

{
    "properties":{
        "from":{
            "type":"string"
        },
        "to":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : FacetFieldInfo

Type: object

Show Source

• limit(optional): integer(int32)
• minCount(optional): integer(int32)
• name(optional): string
• offset(optional): integer(int32)
• sortBy(optional): string
  Allowed Values: [ "count", "index" ]

{
    "properties":{
        "limit":{
            "format":"int32",
            "type":"integer"
        },
        "minCount":{
            "format":"int32",
            "type":"integer"
        },
        "name":{
            "type":"string"
        },
        "offset":{
            "format":"int32",
            "type":"integer"
        },
        "sortBy":{
            "$ref":"#/components/schemas/SortBy"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/xml; charset=UTF-8
• application/json; charset=UTF-8

200 Response

Success

Body ()

Root Schema : schema

Type: object

Show Source

• facets(optional): array facets
• parties(optional): array parties
• request(optional): object SearchRequest
• totalHits(optional): integer(int64)

{
    "properties":{
        "facets":{
            "items":{
                "$ref":"#/components/schemas/FacetInfo"
            },
            "type":"array"
        },
        "parties":{
            "items":{
                "type":"object"
            },
            "type":"array"
        },
        "request":{
            "$ref":"#/components/schemas/SearchRequest"
        },
        "totalHits":{
            "format":"int64",
            "type":"integer"
        }
    },
    "type":"object"
}

Nested Schema : facets

Type: array

Show Source

• Array of: object FacetInfo

{
    "items":{
        "$ref":"#/components/schemas/FacetInfo"
    },
    "type":"array"
}

Nested Schema : parties

Type: array

Show Source

• Array of: object items

{
    "items":{
        "type":"object"
    },
    "type":"array"
}

Nested Schema : SearchRequest

Type: object

Show Source

• advancedSearch(optional): object AdvancedSearchFilters
• defaultFilters(optional): array defaultFilters
• exportCount(optional): boolean
• facetLimit(optional): integer(int32)
• filterFields(optional): array filterFields
• filterQuery(optional): string
• limit(optional): integer(int32)
• mapName(optional): string
• objectType(optional): string
  Allowed Values: [ "Companies", "People" ]
• offset(optional): integer(int32)
• orderBy(optional): string
• orderByDir(optional): string
• orderByDirection(optional): string
  Allowed Values: [ "ASC", "DESC" ]
• query(optional): string
• radialFilter(optional): object RadialFilter
• rangeFilters(optional): array rangeFilters
• returnAll(optional): boolean
• returnFacetFields(optional): array returnFacetFields
• returnFacets(optional): array returnFacets
• returnFields(optional): array returnFields
• selectedFacets(optional): array selectedFacets

{
    "properties":{
        "advancedSearch":{
            "$ref":"#/components/schemas/AdvancedSearchFilters"
        },
        "defaultFilters":{
            "items":{
            },
            "type":"array"
        },
        "exportCount":{
            "type":"boolean"
        },
        "facetLimit":{
            "format":"int32",
            "type":"integer"
        },
        "filterFields":{
            "items":{
                "$ref":"#/components/schemas/FilterInfo"
            },
            "type":"array"
        },
        "filterQuery":{
            "type":"string"
        },
        "limit":{
            "format":"int32",
            "type":"integer"
        },
        "mapName":{
            "type":"string"
        },
        "objectType":{
            "$ref":"#/components/schemas/ObjectType"
        },
        "offset":{
            "format":"int32",
            "type":"integer"
        },
        "orderBy":{
            "type":"string"
        },
        "orderByDir":{
            "type":"string"
        },
        "orderByDirection":{
            "$ref":"#/components/schemas/OrderBy"
        },
        "query":{
            "type":"string"
        },
        "radialFilter":{
            "$ref":"#/components/schemas/RadialFilter"
        },
        "rangeFilters":{
            "items":{
                "$ref":"#/components/schemas/RangeFilterInfo"
            },
            "type":"array"
        },
        "returnAll":{
            "type":"boolean"
        },
        "returnFacetFields":{
            "items":{
                "$ref":"#/components/schemas/FacetFieldInfo"
            },
            "type":"array"
        },
        "returnFacets":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "returnFields":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "selectedFacets":{
            "items":{
                "$ref":"#/components/schemas/FilterInfo"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : FacetInfo

Type: object

Show Source

• attribute(optional): string
• count(optional): integer(int64)
• displayValue(optional): string
• value(optional): string

{
    "properties":{
        "attribute":{
            "type":"string"
        },
        "count":{
            "format":"int64",
            "type":"integer"
        },
        "displayValue":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : items

Type: object

Nested Schema : AdvancedSearchFilters

Type: object

Show Source

• advancedFilterQuery(optional): string
• advancedFilters(optional): array advancedFilters

{
    "properties":{
        "advancedFilterQuery":{
            "type":"string"
        },
        "advancedFilters":{
            "items":{
                "$ref":"#/components/schemas/AdvancedSearchFilterSet"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : defaultFilters

Type: array

Show Source

• Array of:

{
    "items":{
    },
    "type":"array"
}

Nested Schema : filterFields

Type: array

Show Source

• Array of: object FilterInfo

{
    "items":{
        "$ref":"#/components/schemas/FilterInfo"
    },
    "type":"array"
}

Nested Schema : RadialFilter

Type: object

Show Source

• countryName(optional): string
• isNotNullFlag(optional): boolean
• name(optional): string
• notNullFlag(optional): boolean
• operator(optional): string
  Allowed Values: [ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
• radius(optional): string
• unit(optional): string
  Allowed Values: [ "km", "mi" ]
• value(optional): string

{
    "properties":{
        "isNotNullFlag":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "operator":{
            "$ref":"#/components/schemas/OPERATOR"
        },
        "value":{
            "type":"string"
        },
        "notNullFlag":{
            "type":"boolean"
        },
        "countryName":{
            "type":"string"
        },
        "radius":{
            "type":"string"
        },
        "unit":{
            "$ref":"#/components/schemas/UNIT"
        }
    },
    "type":"object"
}

Nested Schema : rangeFilters

Type: array

Show Source

• Array of: object RangeFilterInfo

{
    "items":{
        "$ref":"#/components/schemas/RangeFilterInfo"
    },
    "type":"array"
}

Nested Schema : returnFacetFields

Type: array

Show Source

• Array of: object FacetFieldInfo

{
    "items":{
        "$ref":"#/components/schemas/FacetFieldInfo"
    },
    "type":"array"
}

Nested Schema : returnFacets

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : returnFields

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : selectedFacets

Type: array

Show Source

• Array of: object FilterInfo

{
    "items":{
        "$ref":"#/components/schemas/FilterInfo"
    },
    "type":"array"
}

Nested Schema : advancedFilters

Type: array

Show Source

• Array of: object AdvancedSearchFilterSet

{
    "items":{
        "$ref":"#/components/schemas/AdvancedSearchFilterSet"
    },
    "type":"array"
}

Nested Schema : AdvancedSearchFilterSet

Type: object

Show Source

• filterFields(optional): array filterFields
• filterSetId(optional): string
• match(optional): string
  Allowed Values: [ "ALL", "ANY" ]
• rangeFilters(optional): array rangeFilters

{
    "properties":{
        "filterFields":{
            "items":{
                "$ref":"#/components/schemas/FilterInfo"
            },
            "type":"array"
        },
        "filterSetId":{
            "type":"string"
        },
        "match":{
            "$ref":"#/components/schemas/Match"
        },
        "rangeFilters":{
            "items":{
                "$ref":"#/components/schemas/RangeFilterInfo"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : filterFields

Type: array

Show Source

• Array of: object FilterInfo

{
    "items":{
        "$ref":"#/components/schemas/FilterInfo"
    },
    "type":"array"
}

Nested Schema : rangeFilters

Type: array

Show Source

• Array of: object RangeFilterInfo

{
    "items":{
        "$ref":"#/components/schemas/RangeFilterInfo"
    },
    "type":"array"
}

Nested Schema : FilterInfo

Type: object

Show Source

• isNotNullFlag(optional): boolean
• name(optional): string
• notNullFlag(optional): boolean
• operator(optional): string
  Allowed Values: [ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
• value(optional): string

{
    "properties":{
        "isNotNullFlag":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "operator":{
            "$ref":"#/components/schemas/OPERATOR"
        },
        "value":{
            "type":"string"
        },
        "notNullFlag":{
            "type":"boolean"
        }
    },
    "type":"object"
}

Nested Schema : RangeFilterInfo

Type: object

Show Source

• isNotNullFlag(optional): boolean
• name(optional): string
• notNullFlag(optional): boolean
• operator(optional): string
  Allowed Values: [ "BW", "CO", "DOESNOTEXIST", "EQ", "EW", "EXISTS", "GT", "GTE", "IN", "LT", "LTE", "NOTBW", "NOTCO", "NOTEQ", "NOTIN", "NOTNULL", "NULL", "SW" ]
• range(optional): object Range
• value(optional): string

{
    "properties":{
        "isNotNullFlag":{
            "type":"boolean"
        },
        "operator":{
            "$ref":"#/components/schemas/OPERATOR"
        },
        "value":{
            "type":"string"
        },
        "notNullFlag":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "range":{
            "$ref":"#/components/schemas/Range"
        }
    },
    "type":"object"
}

Nested Schema : Range

Type: object

Show Source

• from(optional): string
• to(optional): string

{
    "properties":{
        "from":{
            "type":"string"
        },
        "to":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : FacetFieldInfo

Type: object

Show Source

• limit(optional): integer(int32)
• minCount(optional): integer(int32)
• name(optional): string
• offset(optional): integer(int32)
• sortBy(optional): string
  Allowed Values: [ "count", "index" ]

{
    "properties":{
        "limit":{
            "format":"int32",
            "type":"integer"
        },
        "minCount":{
            "format":"int32",
            "type":"integer"
        },
        "name":{
            "type":"string"
        },
        "offset":{
            "format":"int32",
            "type":"integer"
        },
        "sortBy":{
            "$ref":"#/components/schemas/SortBy"
        }
    },
    "type":"object"
}

500 Response

An unexpected error occurred during the request.

Body ()

Root Schema : schema

Type: object

Back to Top

Examples

Example Request:

/api/v4/search

Example SearchRequest JSON Objects:

{"objectType":"Companies","query":"oracle","offset":"0","limit":"10","facetLimit":"10"}
{"objectType":"People","offset":"0","limit":"10","facetLimit":"10"}
{"objectType":"Companies","query":"oracle","offset":"0","limit":"10","facetLimit":"10","returnAll":"true"}
{"objectType":"Companies","query":"oracle","offset":"0","limit":"10","facetLimit":"10","returnFields":["location.city", "location.state"]}
{"objectType":"Companies","offset":"0","limit":"10","facetLimit":"10","returnFields":["info.organization_name","location.city", "location.state","company.sales_volume"],"filterFields":[{"name":"location.state","value":"CA"}]}
{"objectType":"People","offset":"0","limit":"10","facetLimit":"0","defaultFilters":[{"filterName":"Enterprise Companies","filterValue":"N"},{"filterName":"Medium Companies","filterValue":"Y"},{"filterName":"Small Companies","filterValue":"Y"},{"filterName":"Defunct","filterValue":"Y"},{"filterName":"Out Of Business","filterValue":"Y"}]}
{"objectType":"People","offset":"0","limit":"10","facetLimit":"0","defaultFilters":[{"filterName":"Enterprise Companies","filterValue":"N"},{"filterName":"Medium Companies","filterValue":"Y"},{"filterName":"Small Companies","filterValue":"Y"},{"filterName":"Defunct","filterValue":"Y"},{"filterName":"Out Of Business","filterValue":"Y"},{"filterName":"Delisted","filterValue":"Y"}]}
{"objectType":"Companies","offset":"0","limit":"10","facetLimit":"0","defaultFilters":[{"filterName":"Enterprise Companies","filterValue":"Y"},{"filterName":"Medium Companies","filterValue":"Y"},{"filterName":"Small Companies","filterValue":"N"},{"filterName":"Defunct","filterValue":"Y"},{"filterName":"Out Of Business","filterValue":"N"}],"rangeFilters":[{"name":"company.sales_volume","range":{"from":"1000000","to":"999999999"}}]}
{"objectType":"People","offset":"0","limit":"10","facetLimit":"5","selectedFacets":[{"name":"person.department", "value":"3" },{"name":"person.department", "value":"10" }],"returnFacetFields":[{"name":"company.status_ind","offset":0,"limit":-1,"minCount":0,"sortBy":"index"},{"name":"person.department","offset":0,"limit":5,"minCount":0,"sortBy":"count"}],"orderBy":"location.state","orderByDir":"DESC"}
{"objectType":"People","offset":"0","limit":"10","selectedFacets":[{ "name":"person.department", "value":"10" },{ "name":"location", "value":"USA" }],"returnFacetFields":[{"name":"location","offset":0,"limit":10,"minCount":0,"sortBy":"count"},{"name":"person.department","offset":0,"limit":5,"minCount":0,"sortBy":"count"},{"name":"companies"}],"orderBy":"location.country","orderByDir":"DESC","rangeFilters":[{"name":"location.postal_code","range":{"from":"30620","to":"80622"}}],"defaultFilters":[{"filterName":"Enterprise Companies","filterValue":"N"}]}
{"objectType":"Companies","limit":"0","offset":"0","selectedFacets":[{ "name":"location", "value":"USA" },{"name":"company.primary_naics_cd","value":"11"}],"returnFacetFields":[{"name":"company.primary_naics_cd","offset":0,"limit":10,"minCount":0,"sortBy":"index"}],"rangeFilters":[{"name":"location.postal_code","range":{"from":"30000","to":"80622"}}]}

Example Responses:

 {
 "parties 
 	type=person":[
 {"Id":"Some Id", "Name":"Some Name","Title":"Some Title","Email":"Some Email",...(MORE)}, 
 {"Id":"Some Id", "Name":"Some Name","Title":"Some Title","Email":"Some Email",...(MORE)}]
}
 
 {
 "parties 
 type:company":[
 {" Id":"Some Id", "Name":"Some Company","DUNSNumber":"123456",...(MORE)}
 {" Id":"Some Id", "Name":"Some Company","DUNSNumber":"123456",...(MORE)}] 
 "facets":[
 {"attribute":"some attribute", "value":"value for attribute", "count":"some count"}]
}
 

Back to Top