None

Fields:

  • phone: CharField R
  • address: CharField R
  • city: CharField R
  • town: CharField R

Fields:

  • user_id: SerializerMethodField
  • username: CharField R
  • password: CharField R
  • email: EmailField R
  • name: CharField R
  • bio: CharField
  • phone: CharField
  • gender: ChoiceField
  • secret: SerializerMethodField
  • token: SerializerMethodField

Fields:

  • username: CharField R
  • password: CharField R

Fields:

  • email: EmailField R

API endpoint that allows to view user's devices

Fields:

  • device_id: SerializerMethodField
  • device_token: CharField R
  • device_name: CharField R
  • device_client_id: CharField R
  • device_type: ChoiceField

API endpoint that allows to View, Update and Delete device

Fields:

  • device_id: SerializerMethodField
  • device_token: CharField R
  • device_name: CharField R
  • device_client_id: CharField R
  • device_type: ChoiceField

API endpoint that allows to send message to a device

Fields:

  • title: CharField R
  • body: CharField R

Fields:

  • username: CharField R
  • password: CharField R

This endpoint will generate an upload url so that client can directly upload the file to s3.

params filename: string(len=30 with exntesion name as much as posible)

sample POST {"filename":"hello.png","content_type":"image/jpeg"}

Fields:

  • filename: CharField R
  • content_type: CharField

Allows to view notifications

Fields:

  • notification_id: SerializerMethodField
  • parent_reference_id: IntegerField
  • reference_id: IntegerField R
  • notification_type: ChoiceField
  • modified_at: SerializerMethodField
  • involved_users_count: SerializerMethodField
  • involved_users: SerializerMethodField

Allows to view notifications

Fields:

  • notification_id: SerializerMethodField
  • parent_reference_id: IntegerField
  • reference_id: IntegerField R
  • notification_type: ChoiceField
  • modified_at: SerializerMethodField
  • involved_users_count: SerializerMethodField
  • involved_users: SerializerMethodField

For getting feeds

Fields:

  • story_id: SerializerMethodField
  • caption: CharField
  • attachment_type: ChoiceField
  • attachment_url: SerializerMethodField
  • number_of_comments: IntegerField
  • number_of_hits: IntegerField
  • created_by_user: SerializerMethodField
  • attachment_key: CharField
  • comments: SerializerMethodField
  • hits: SerializerMethodField
  • created_at: SerializerMethodField

Allows user to view user's info via username

No fields.

For getting user relationships

param:

  • user_ids, a comma separated user_id

  • out_status : -1, 0, 1, 2, 3 (for me, nothing, following, blocked, pending)

  • in_status : -1, 0, 1, x, 3 (for me, nothing, follower, , pending,))

No fields.

For getting diffirent users with their email, or phone numbee

params: (commad separated values)

?emails=me1@me.con,hello@he.com ?phones=123432,4343,4343,

Fields:

  • user_id: SerializerMethodField
  • username: CharField
  • name: CharField
  • profile_photo: SerializerMethodField
  • private: BooleanField

API endpoint for searching usernames

params:

?q=uname

Fields:

  • user_id: SerializerMethodField
  • username: CharField
  • name: CharField
  • profile_photo: SerializerMethodField
  • private: BooleanField

Allows to view the user's stories.

Fields:

  • story_id: SerializerMethodField
  • caption: CharField
  • attachment_type: ChoiceField
  • attachment_url: SerializerMethodField
  • number_of_comments: IntegerField
  • number_of_hits: IntegerField
  • created_by_user: SerializerMethodField
  • attachment_key: CharField
  • comments: SerializerMethodField
  • hits: SerializerMethodField
  • created_at: SerializerMethodField

Allows the user to view, update or delete his own account or just view other account.

FYI - For getting User's own information,

Please use the /me endpoint instead because that is optimize for getting own information.

Fields:

  • user_id: SerializerMethodField
  • username: CharField
  • name: CharField R
  • email: EmailField R
  • bio: CharField
  • phone: CharField
  • gender: ChoiceField
  • number_of_followers: SerializerMethodField
  • number_of_following: SerializerMethodField
  • number_of_posts: SerializerMethodField
  • cover_photo_key: CharField
  • cover_photo: SerializerMethodField
  • profile_photo_key: CharField
  • profile_photo: SerializerMethodField
  • private: BooleanField
  • location: UserLocationSerializer
    • name: CharField R
    • latitude: FloatField R
    • longitude: FloatField R

Allow user to report other user

Fields:

  • report_type: ChoiceField

For getting followers

No fields.

For getting following/unfollowing user

No fields.

For getting followers

Fields:

  • user_id: SerializerMethodField
  • username: CharField
  • name: CharField
  • profile_photo: SerializerMethodField
  • private: BooleanField

Allows the user to view, update or delete his own profile.

Fields:

  • user_id: SerializerMethodField
  • username: CharField
  • name: CharField R
  • email: EmailField R
  • bio: CharField
  • phone: CharField
  • gender: ChoiceField
  • number_of_followers: SerializerMethodField
  • number_of_following: SerializerMethodField
  • number_of_posts: SerializerMethodField
  • cover_photo_key: CharField
  • cover_photo: SerializerMethodField
  • profile_photo_key: CharField
  • profile_photo: SerializerMethodField
  • private: BooleanField
  • location: UserLocationSerializer
    • name: CharField R
    • latitude: FloatField R
    • longitude: FloatField R

For getting user's blocked list

Fields:

  • user_id: SerializerMethodField
  • username: CharField
  • name: CharField
  • profile_photo: SerializerMethodField
  • private: BooleanField

This endpoint will allow a user to change his password

params current_password: string(len=30 with exntesion name as much as posible)

if new_password: string(len=30 with exntesion name as much as posible)

sample POST {"current_password":"passwordhello","new_password":"passwordhello1234"}

Fields:

  • current_password: CharField R
  • new_password: CharField R
  • confirm_password: CharField R

No fields.

Allows the user update his/her own basic settings.

Fields:

  • locale: CharField

Allows the user update his/her own notification settings.

Fields:

  • id: IntegerField
  • new_follower: ChoiceField
  • new_hit: ChoiceField
  • new_comment: ChoiceField
  • mentioned_in_story: ChoiceField
  • mentioned_in_comment: ChoiceField
  • accepted_follow_request: ChoiceField

Allows the user to add, view, update or delete his own location.

Fields:

  • name: CharField R
  • latitude: FloatField R
  • longitude: FloatField R

Allows the user to add, view, update or delete his own profile photo.

Fields:

  • s3_obj_key: CharField R

Allows the user to add, view, update or delete his own cover photo.

Fields:

  • s3_obj_key: CharField R

For getting pending requests

Fields:

  • user_id: SerializerMethodField
  • username: CharField
  • name: CharField
  • profile_photo: SerializerMethodField
  • private: BooleanField

For rejecting or accepting follow request

No fields.

Allows users to view the list of stories or create a new one.

Fields:

  • story_id: SerializerMethodField
  • caption: CharField
  • attachment_type: ChoiceField
  • attachment_url: SerializerMethodField
  • number_of_comments: IntegerField
  • number_of_hits: IntegerField
  • created_by_user: SerializerMethodField
  • attachment_key: CharField
  • comments: SerializerMethodField
  • hits: SerializerMethodField
  • created_at: SerializerMethodField

Allows users to search any caption.

Fields:

  • story_id: SerializerMethodField
  • caption: CharField
  • attachment_type: ChoiceField
  • attachment_url: SerializerMethodField
  • number_of_comments: IntegerField
  • number_of_hits: IntegerField
  • created_by_user: SerializerMethodField
  • attachment_key: CharField
  • comments: SerializerMethodField
  • hits: SerializerMethodField
  • created_at: SerializerMethodField

Allows users view the top stories

Fields:

  • story_id: SerializerMethodField
  • caption: CharField
  • attachment_type: ChoiceField
  • attachment_url: SerializerMethodField
  • number_of_comments: IntegerField
  • number_of_hits: IntegerField
  • created_by_user: SerializerMethodField
  • attachment_key: CharField
  • comments: SerializerMethodField
  • hits: SerializerMethodField
  • created_at: SerializerMethodField

llows to view the user's stories.

Fields:

  • story_id: SerializerMethodField
  • caption: CharField
  • attachment_type: ChoiceField
  • attachment_url: SerializerMethodField
  • number_of_comments: IntegerField
  • number_of_hits: IntegerField
  • created_by_user: SerializerMethodField
  • attachment_key: CharField
  • comments: SerializerMethodField
  • hits: SerializerMethodField
  • created_at: SerializerMethodField

Allow user to view, update and delete story detail

Fields:

  • story_id: SerializerMethodField
  • caption: CharField
  • created_at: SerializerMethodField

Fields:

  • id: IntegerField
  • allow_push_notifications: BooleanField

Allows users to create/view all comments within specified story

Fields:

  • comment_id: SerializerMethodField
  • text: CharField R
  • created_by_user: SerializerMethodField
  • story_id: SerializerMethodField
  • created_at: SerializerMethodField

Allow user to report story

Fields:

  • report_type: ChoiceField

Allow the user to view, update or delete his own comment

Fields:

  • comment_id: SerializerMethodField
  • text: CharField R
  • created_by_user: SerializerMethodField
  • story_id: SerializerMethodField
  • created_at: SerializerMethodField

Allow user to report comment

Fields:

  • report_type: ChoiceField

For getting and posting actions(dislike) in every story

Fields:

  • hit_id: SerializerMethodField
  • hit_type: ChoiceField
  • created_by_user: SerializerMethodField
  • story_id: SerializerMethodField
  • created_at: SerializerMethodField

Allows the user to view, update or delete his dislike for specified story

Fields:

  • hit_id: SerializerMethodField
  • hit_type: ChoiceField
  • created_by_user: SerializerMethodField
  • story_id: SerializerMethodField
  • created_at: SerializerMethodField

llows to view the user's stories.

Fields:

  • story_id: SerializerMethodField
  • caption: CharField
  • attachment_type: ChoiceField
  • attachment_url: SerializerMethodField
  • number_of_comments: IntegerField
  • number_of_hits: IntegerField
  • created_by_user: SerializerMethodField
  • attachment_key: CharField
  • comments: SerializerMethodField
  • hits: SerializerMethodField
  • created_at: SerializerMethodField

API endpoint that will generate a token for authenticating firebase. This token will expire within 1 hour. So please use it before it expire.

No fields.