Find companies associated with a person
https://api.knod.es/people/:PERSON_ID/companies/:REL_TYPE
Find companies associated with a person.
Requirements
Acting Customer | Yes |
---|---|
Acting User | Yes |
HTTP Methods
If a method is not listed, it is not supported for this call
GET | Execute query |
---|
Parameters
Parameters optional unless specified
Name | Description | Required? |
---|---|---|
user_id | ID of user to query as. | Yes |
PERSON_ID | ID of person to anchor on. You can use 'me' for the ID of the person associated with the querying user. | Yes |
REL_TYPE | Optionally, return only those companies associated by the specified relationship type. For valid values, see the edges attribute of the person object. | |
num | If querying list of users, can specify the number to return. | |
page | If querying list of users, specify the page to return (1-based). | |
detailed_results | 'true' to return detailed company objects, rather than the default compact ones. | |
sort | Attribute to sort on (of company object) | |
sort_direction | desc or asc |
Response
Search Results object.