Prerequisites
You should have
- an user-account enabled for api access & PIM access
- an api-client
- at least one person-record stored in your Hublify CRM
Getting a person list
Simply provide the fields you want to have returned.
Info: In the following example an optional limit-parameter is given too, to avoid too big results returned.
Request URL
https://{your hublify url}/api/eos_10/data_getList
Request parameter
{
"dataset": "person",
"fields": [
"personid",
"firstname",
"lastname"
],
"sql": {
"limit": {
"max": 3
}
}
}
Response
{
"data": [
{ ... }, ... // The requested fields
],
"status": true
}
Searching
Hublify has a powerful built-in multi-field-search.
Getting a single person
To get data for a single product, simply filter for a unique field. Usually this is the field: pcode.
Request URL
https://{your hublify url}/api/eos_10/data_get
Request parameter
{
"dataset": "person",
"fields": [
"firstname",
"lastname"
],
"filter": {
"personid": "K000123"
}
}
Response
{
"data": {
"...": "...", // The requested fields
...
},
"status": true
}