Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Retrieve a user’s details using a HTTP GET request.

Resource URL

https://xxxxx<instance_name>.fuseuniversal.com/api/v4v5.40/manage/users/

Request

Request header parameters

Authorisation is required.

...

Info

Settings and profile options will vary depending on the requirement.

Response

Security-sensitive fields may not be returned in the response.

Info

Please refer to the Response codes guide for more information.

Example request #1

Retrieve a user’s details using their Fuse user ID.

Request URL example

https://xxxxx<instance_name>.fuseuniversal.com/api/v4v5.40/manage/users/11486988?auth_token=<valid_auth_token>

...

Example request #2

Retrieve multiple user's details using their Fuse user IDs.

Request URL example

https://xxxxx<instance_name>.fuseuniversal.com/api/v4v5.40/manage/users?auth_token=<valid_auth_token>&id=11486988,11488425

...

Example request #3

Retrieve a user’s details using their registered e-mail.

Request URL example

https://xxxxx<instance_name>.fuseuniversal.com/api/v4v5.40/manage/users?auth_token=<valid_auth_token>&email=test.user@fuseuniversal.com

...

Example request #4

Retrieve a user’s details using any profile field name (case-sensitive).

Request URL example

https://xxxxx<instance_name>.fuseuniversal.com/api/v4v5.40/manage/users?given_name=testuser&auth_token=<valid_auth_token>

...

Example request #5

Retrieve custom options - custom user profile fields (drop-downs).

Request URL example

https://xxxxx<instance_name>.fuseuniversal.com/api/v4v5.40/custom_options?auth_token=<valid_auth_token>

...

...

Example request #6

Retrieve company user roles.

Request URL example

https://xxxxx.fuseuniversal.com/api/v4v5.40/roles?auth_token=<valid_auth_token>

...