Search

Search for users, companies, posts, events or articles.

Search Users, Companies, and DCFs

This endpoint is deprecated. Please use specialized search endpoints outlined in other sections of the documentation.

An api for searching multiple entities on our platform. While this particular endpoint is convenient for finding multiple types of entities, we highly recommend using more granular search apis listed in the Users, Companies, and DCF sections.

Securityapi-key

Request

query Parameters

q required	string The search string (username, name, location, bio, etc). Example: q=consoleconnect
type required	string One or more types of object to search for: `everything` `people` `companies` `dataCenterFacilities` `directConnectPartner` Multiple `type` parameters may be provided to search for two or more object types. Example: type=everything
page required	integer The page number to get. Example: page=1
count required	integer The number of results per page to get. Example: count=12
newest	boolean Sort Users, Companies, and DCFs by newest. Example: newest=true
userId	string One or more userIds to search for Users, Companies, and DCFs by multiple `userId` parameters may be provided to search for two or more users. Example: userId=235014958511023495968818
tag	string One or more tags to search for. Example: tag=sales
startTime	string Start time for filtering events. Example: startTime=2015-10-07T22:37:51.732Z
endTime	string End time for filtering events. Example: endTime=2015-10-07T22:37:51.732Z

Responses

200

get/api/search

Response samples

application/json

{"results": [{"title": "Frederic Citizen",
"type": "user",
"description": "",
"isFollowing": false,
"isCompanyFollowing": {"corl": false
},
"data": {"id": "5552a04804972e1f16dcc0d6",
"type": "PERSON",
"name": "Stan Sample",
"avatar": null,
"headline": null,
"summary": null,
"location": null,
"username": "stan_sample",
"social": null,
"groups": null,
"updatedAt": "2015-06-22T06:02:42.075Z",
"createdAt": "2015-05-13T00:52:24.721Z"
}
}
],
"items": {"users": [{"id": "56159ebe6c11fef4510bfdc7",
"name": "Frederic Citizen",
"avatar": null,
"background": null,
"headline": "I <3 Networks",
"summary": "IP Engineer",
"location": "Mt Example, TX",
"username": "fredcit",
"social": null,
"tags": ["#baseball",
"#football"
],
"updatedAt": "2015-10-07T22:37:51.732Z",
"createdAt": "2015-10-07T22:37:50.543Z",
"companies": [{"id": "56159ebf6c11fef4510bfdcc",
"name": "ExCo LLC",
"avatar": null,
"background": null,
"headline": null,
"summary": null,
"location": null,
"username": "exco",
"followers": ["56159ebe6c11fef4510bfdc7"
],
"following": null,
"tags": [ ],
"verified": true,
"company": {"website": null,
"industry": null,
"businessType": null,
"companySize": null,
"dateFounded": null,
"markets": { },
"asns": null,
"regionalInternetRegistry": null,
"clientId": null,
"first": null,
"last": null,
"address": null,
"city": null,
"state": null,
"zip": null,
"addresses": null,
"phone": null,
"fax": null,
"email": null,
"country": null
},
"linkUserCompany": { }
}
],
"linkUserCompany": {"56159ebf6c11fef4510bfdcc": {"id": "56159ebf6c11fef4510bfdcd",
"userId": "56159ebe6c11fef4510bfdc7",
"companyId": "56159ebf6c11fef4510bfdcc",
"state": "ACTIVE",
"roles": ["ADMIN"
],
"updatedAt": "2015-10-07T22:37:51.225Z",
"createdAt": "2015-10-07T22:37:51.225Z",
"deleted": false,
"deletedAt": "1970-01-01T00:00:00.000Z",
"permissions": {"groups": {"ADMIN": {"user-moderation": true,
"company-actions": true,
"company-update": true,
"ports-edit": true,
"ports-read": true,
"connection-create": true,
"connection-modify": true,
"connection-read": true,
"connection-delete": true,
"order-query": true,
"order-create": true,
"order-modify": true,
"order-delete": true
}
}
}
}
},
"stats": {"followers": 0,
"interconnections": 0,
"posts": 1,
"events": 1,
"following": 1
},
"isFollowing": false,
"isCompanyFollowing": { }
}
],
"companies": [ ],
"dataCenterFacilities": [ ]
}
}

➔ Next to Pricing