Api Documentation

Admin::Auth

In order to access the ActiveAdmin panel and other admin tools like Sidekiq, you must have a cookie based session. This is setup by passing your JWT to this endpoint.

• create admin session

Apis::V4::AcceptedCommunityChallenge

• create an accepted community challenge
• get all accepted community challenges
• update an accepted community challenge

Apis::V4::Auth

• Login with Facebook
• Login with Facebook Access Token
• Login with Facebook Access Token as a phone number only user
• Login with Google
• Login with Okta
• Login with TheKey
• Login with client token
• promote anonymous login to verified with TheKey

Apis::V4::BulkPeopleChanges

• change list of people based on filters
• changes two people

Apis::V4::BulkTransfers

• transfer people
• transfer people based on filters
• transfer people without leaving a copy

Apis::V4::Challenge

• can set focus
• can set focused on creation
• create a challenge
• defaults focus to false
• delete a challenge
• get filtered challenges
• get personal challenges
• get user's challenges
• update a challenge

Apis::V4::Challenges::Reminders

• creating a reminder
• deleting a reminder
• it has a 401 status
• updating/replacing a reminder
• when there is a reminder set for a challenge
• when there is no reminder set for a challenge

Apis::V4::CommunityChallenge

• create a community challenge
• get a community challenges
• get all community challenges
• get all community challenges, sorted by active first, then created_at
• update a community challenge

Apis::V4::ContactAssignments

• delete a valid contact assignment
• delete invalid contact assignment
• get one assignment
• post a new assignment
• update an assignment

Apis::V4::EmailAddresses

• delete a valid email address
• delete invalid email address

Apis::V4::FilterStats

• get organization people filter stats

Apis::V4::GlobalCelebrationItems

• get all celebration items

Apis::V4::GlobalCelebrationItems::Like

• create global celebration like
• delete global celebration like

Apis::V4::Impersonations

• Impersonate a user
• Stop impersonating a user

Apis::V4::Interaction

• delete an existing interaction
• invalid attributes
• post a new interaction
• update an existing interaction
• update initiators as relationship
• update unknown interaction
• with invalid organiztion will fail

Apis::V4::Organization

• archive inactive leaders at organization
• create a new organization
• delete a organization
• get organization
• get user's organizations
• update an existing organization

Apis::V4::OrganizationalPermissions

• create a new organizational_permission

Apis::V4::Organizations::CelebrationItems

• get organization's celebration items

Apis::V4::Organizations::CelebrationItems::Comments

• create organization celebration comment
• create organization celebration comment
• delete organization celebration comment
• get organization celebration comments
• get organization celebration item comment

Apis::V4::Organizations::CelebrationItems::Like

• create organization celebration like
• delete organization celebration like

Apis::V4::Organizations::CommentReportsController

• create a comment report
• get a comment report
• get all comment reports
• update a comment report

Apis::V4::Organizations::CommunityCode

• generate a code for an organization

Apis::V4::Organizations::CommunityOwner

• transfer ownership of an organization

Apis::V4::Organizations::CommunityUrl

• generate a url for an organization

Apis::V4::Organizations::FindByCode

• find an organization by community code

Apis::V4::Organizations::FindByUrl

• find an organization by community url

Apis::V4::PathwayStages

• get pathway stages

Apis::V4::People

• get non-organization person
• get people list
• get person record with email_addresses and interactions
• get person record with notes
• get person record without includes
• get user's details
• post a new person
• post a person that will be automatically merged
• post new person with invalid includes
• send multiple challenges as included
• send note as included
• update an existing person
• with expired token

Apis::V4::PeopleSearch

• search people by archived
• search people by email address
• search people by gender
• search people by permission level
• search people by phone number
• search people by unassigned
• search people in all of my organizations
• search people in specific organizations
• search with specific fields

Apis::V4::PersonFeed

• list user's journey items with a person

Apis::V4::PersonNotes

• create a new note for a person
• creates a new note for a person without explicit author ID
• returns 401 for incorrect user id
• returns 401 for incorrect user id
• updates a note for a person without explicit author ID
• updates a person note

Apis::V4::PhoneNumbers

• delete a valid phone number
• delete invalid phone number

Apis::V4::PushNotification::DeviceToken

• delete a push notification device token
• get user's push notification device token
• list user's push notification device tokens
• post a new push notification device token
• update an existing push notification device token

Apis::V4::Reports

• get global community users report
• get global impact report
• get my impact report
• get organization days report
• get organization interactions report
• get people interactions report

Apis::V4::StepSuggestions

• get challenge suggestions

Apis::V4::UnreadItem

• delete all unread by organization
• delete all unread items by celebration item

Apis::V4::User

• update my user model

Apis::V4::UserRememberTokens

• get user remember token

Apis::V4::UserRememberTokens::Merge

• merge