Qodex.ai

#Igloo API Documentation

Number of APIs: 53

The Igloo API allows developers to perform I/O functions directly with the platform. For Qodex users, you can import this collection into your Qodex workspace for testing and development purposes.

Common Parameters:

  • Community key : A numeric identifier for a digital workplace. For more information on retrieving your community key, take a look at retrieving workplace details on our Customer Care site.
  • Workplace URL : The full URL of your digital workplace. Eg: https://yourWorkplace.igloodigitalworkplace.com
  • API Version : The API version being used. This value should always be 1.
  • App ID : The Igloo API key provided as part of the developer registration process. If you do not yet have an app ID, you can register to the developer program .
  • App Password : The Igloo API password provided as part of the developer registration.
  • Igloo Authentication password : The password for the account that you want to run your API calls with. This is a separate password from any SSO password, and is specific to your Igloo digital workplace. See our Customer Care article for more information: Changing your Igloo Password

  1. User Management-User Profiles-Profile Photos-Add/Update Profile Photo - Upload file to an attachment entry PATCH {{baseUrl}}/.api2/api/v1/communities/:communityKey/attachments/uploads/:attachmentKey

  2. User Management-Groups-Update Membership - Remove One User from Multiple Groups POST {{baseUrl}}/.api/api.svc/users/:userId/usergroups/delete?groupids={{$randomUUID}}, {{$randomUUID}}, {{$randomUUID}}

  3. Administration and Infrastructure-Subscriptions-Group Subscriptions - Update a group subscription POST {{baseUrl}}/.api/api.svc/groupsubscriptions/update?objectId={{$randomUUID}}&groupId={{$randomUUID}}&frequency=Daily

  4. User Management-Groups-Retrieve - List Current User's Groups GET {{baseUrl}}/.api/api.svc/account/groups

  5. User Management-Groups-Retrieve - Get Details of Specific Group GET {{baseUrl}}/.api/api.svc/usergroups/:userGroupId/view

  6. Authentication - Initiate a Session (SAML enabled workspaces) POST {{baseUrl}}/.api/api.svc/session/create

  7. User Management-Adding New Members - Create a new member POST {{baseUrl}}/.api/api.svc/users/create

  8. User Management-Adding New Members - Send a new member invitation POST {{baseUrl}}/.api/api.svc/community/invites/create?invitee_fname=&invitee_email=&message=&groups=

  9. User Management-Revoking Membership - Revoke user's site membership POST {{baseUrl}}/.api/api.svc/community/members/:userId/remove

  10. User Management-User Profiles-Get User Profiles - Get current user's profile GET {{baseUrl}}/.api/api.svc/user/viewprofile?allFields={{$randomBoolean}}