matthew | 2021-08-25 14:42:23 UTC | #1
Hi, Can you let me know if the custom profile fields are available via GET /api/v2/users ?
I can't seem to find a way to retrieve them.
thanks!
Eos_Rios | 2021-08-25 15:16:23 UTC | #2
it's only available from /api/v2/users/{userid}/profile?fl=*
Custom fields populate in an attribute named after their Section, nested under there. So if you create a Section named Food and an field named Taco the path would be Root\Food\Taco
If you want just a specific section you can do; /api/v2/users/{userid}/profile?fl=Food
And you can combine sections:
/api/v2/users/{userid}/profile?fl=Food,hr
there is no bulk option that I have found and this method is both marked deprecated and undocumented, though it's also how the actual UI is obtaining the info when you load a user's page.
tim.smith | 2021-08-25 15:52:36 UTC | #3
Eos_Rios, post:2, topic:11825
there is no bulk option that I have found and this method is both marked deprecated and undocumented, though it's also how the actual UI is obtaining the info when you load a user's page.
It is very important to take note that the fl parameter is undocumented, which means that it is not meant for external consumption; the consequence is that its behavior may change at any time or it may be removed entirely without notice. I am not aware of a legitimate way to get this information. You may request new features and share your use case at https://genesyscloud.ideas.aha.io/.
Eos_Rios | 2021-08-27 12:57:41 UTC | #4
Specifically refer to where it's already been suggested a year ago with no signs of interest or traction;
https://genesyscloud.ideas.aha.io/ideas/CLCOLL-I-451
matthew | 2021-08-27 19:16:01 UTC | #5
Thanks for the info guys, I thought I couldn't see a way from the documented API. Would be good to add custom fields into the bulk api call in future.
Matthew
system | 2021-09-26 19:16:03 UTC | #6
This topic was automatically closed 30 days after the last reply. New replies are no longer allowed.
This post was migrated from the old Developer Forum.
ref: 11825