{"__v":0,"_id":"56bac73d5d0f400d00ac80e3","category":{"project":"54424ec108d2440800d6d02f","version":"5514597be74c1c2300f9b33e","_id":"56bacc465d0f400d00ac80e5","pages":[],"__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-02-10T05:36:06.325Z","from_sync":false,"order":4,"slug":"api-endpoints-for-odm","title":"API Endpoints for ODM"},"editedParams":true,"editedParams2":true,"parentDoc":null,"project":"54424ec108d2440800d6d02f","user":"5424edfd1972e21d7dae4e99","version":{"__v":5,"_id":"5514597be74c1c2300f9b33e","forked_from":"54424efc08d2440800d6d036","project":"54424ec108d2440800d6d02f","createdAt":"2015-03-26T19:09:47.065Z","releaseDate":"2015-03-26T19:09:47.065Z","categories":["5514597be74c1c2300f9b33f","5514597be74c1c2300f9b340","5514597be74c1c2300f9b341","5514597be74c1c2300f9b342","5514597be74c1c2300f9b343","56bacaf4b77e261700bc1533","56bacb1e4aa5930d00da77d6","56bacb4cb77e261700bc1535","56bacc465d0f400d00ac80e5"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-10T05:14:37.559Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"results":{"codes":[{"language":"json","code":"","name":"Success","status":200}]},"settings":"","auth":"required","params":[{"_id":"5510b00d23eca20d0038d183","ref":"","in":"query","required":false,"desc":"When provided, restricts the result set to Organizations where updated_at >= the passed value","default":"","type":"timestamp","name":"updated_since"},{"_id":"544250d408d2440800d6d041","ref":"","in":"query","required":false,"desc":"Full text search of an Organization's name, aliases (i.e. previous names or \"also known as\"), and short description","default":"","type":"string","name":"query"},{"_id":"544250d408d2440800d6d040","ref":"","in":"query","required":false,"desc":"Full text search limited to name and aliases","default":"","type":"string","name":"name"},{"_id":"544250d408d2440800d6d03f","ref":"","in":"query","required":false,"desc":"Text search of an Organization's domain_name (e.g. www.google.com)","default":"","type":"string","name":"domain_name"},{"_id":"5612bdcc5b4fb72300748595","ref":"","in":"query","required":false,"desc":"Filter by location names (comma separated, AND'd together) e.g. locations=California,San Francisco","default":"","type":"string","name":"locations"},{"_id":"5442658bae25f42200acaee7","ref":"","in":"query","required":false,"desc":"Filter by one or more types. Multiple types are separated by commas. Available types are \"company\", \"investor\", \"school\", and \"group\". Multiple organization_types are logically AND'd.","default":"","type":"string","name":"organization_types"},{"_id":"5442658bae25f42200acaee3","ref":"","in":"query","required":false,"desc":"The sort order of the collection. Options are \"created_at ASC\", \"created_at DESC\", \"updated_at ASC\", and \"updated_at DESC\"","default":"created_at DESC","type":"string","name":"sort_order"},{"_id":"5442658bae25f42200acaee4","ref":"","in":"query","required":false,"desc":"Page number of the results to retrieve.","default":"1","type":"int","name":"page"}],"url":"/odm-organizations"},"isReference":false,"order":0,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Endpoint Available to All Registered Users\",\n  \"body\": \"This endpoint returns data from the [Open Data Map](/docs/open-data-map).\"\n}\n[/block]\nThe [/odm_organizations](doc:organizations) endpoint returns a paginated list of [OrganizationSummary](doc:organizationsummary) items for every [Organization](doc:organization) in Crunchbase.\n\nThe sort_order parameter, which defaults to \"created_at DESC\" **cannot** be combined with any of the search or filter query parameters. Searching and filtering results in a \"custom\" sort order.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Searching Organizations\"\n}\n[/block]\n\nDevelopers can search the [/organizations](doc:organizations) endpoint using three mutually-exclusive freetext search options, as follows:\n\n* **query**: searches name, aliases / prior names, location, domain and short_description\n* **name**: searches name and aliases / prior names\n* **domain_name** : searches domain\n\nA query that includes more than one of these parameters will result in an error.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Filtering Organizations\"\n}\n[/block]\nIn addition, developers can filter results by three optional facets, as follows:\n\n* **organization_types**: company, investor, school, and/or group (logically AND'd)\n* **location_uuids** : one or more location [UUID](doc:uuid)s (comma-separated and logically AND'd)\n* **category_uuids** : one or more [UUID](doc:uuid)s (comma-separated and logically AND'd)\n\nA query can contain multiple facet filters. Facet filters are logically AND'd together.","excerpt":"","slug":"odm-organizations","type":"get","title":"/odm-organizations"}

get/odm-organizations


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

updated_since:
timestamp
When provided, restricts the result set to Organizations where updated_at >= the passed value
query:
string
Full text search of an Organization's name, aliases (i.e. previous names or "also known as"), and short description
name:
string
Full text search limited to name and aliases
domain_name:
string
Text search of an Organization's domain_name (e.g. www.google.com)
locations:
string
Filter by location names (comma separated, AND'd together) e.g. locations=California,San Francisco
organization_types:
string
Filter by one or more types. Multiple types are separated by commas. Available types are "company", "investor", "school", and "group". Multiple organization_types are logically AND'd.
sort_order:
stringcreated_at DESC
The sort order of the collection. Options are "created_at ASC", "created_at DESC", "updated_at ASC", and "updated_at DESC"
page:
integer1
Page number of the results to retrieve.

Documentation

[block:callout] { "type": "info", "title": "Endpoint Available to All Registered Users", "body": "This endpoint returns data from the [Open Data Map](/docs/open-data-map)." } [/block] The [/odm_organizations](doc:organizations) endpoint returns a paginated list of [OrganizationSummary](doc:organizationsummary) items for every [Organization](doc:organization) in Crunchbase. The sort_order parameter, which defaults to "created_at DESC" **cannot** be combined with any of the search or filter query parameters. Searching and filtering results in a "custom" sort order. [block:api-header] { "type": "basic", "title": "Searching Organizations" } [/block] Developers can search the [/organizations](doc:organizations) endpoint using three mutually-exclusive freetext search options, as follows: * **query**: searches name, aliases / prior names, location, domain and short_description * **name**: searches name and aliases / prior names * **domain_name** : searches domain A query that includes more than one of these parameters will result in an error. [block:api-header] { "type": "basic", "title": "Filtering Organizations" } [/block] In addition, developers can filter results by three optional facets, as follows: * **organization_types**: company, investor, school, and/or group (logically AND'd) * **location_uuids** : one or more location [UUID](doc:uuid)s (comma-separated and logically AND'd) * **category_uuids** : one or more [UUID](doc:uuid)s (comma-separated and logically AND'd) A query can contain multiple facet filters. Facet filters are logically AND'd together.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}