2B Local API

2B Local API documentation.

auth

apple > create

POST /api/v1/auth/apple/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`access_token` required	OAuth access token

email > change > create

POST /api/v1/auth/email/change/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`email` required	New email address

facebook > create

POST /api/v1/auth/facebook/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`access_token` required	OAuth access token

google > create

POST /api/v1/auth/google/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`access_token` required	OAuth access token

POST /api/v1/auth/login/

Check the credentials and return the REST Token if the credentials are valid and authenticated. Calls Django Auth login method to register User ID in Django session framework Accept the following POST parameters: email, password Return the REST Framework Token Object's key.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`email` required	Email address
`password` required	Password

logout > list

GET /api/v1/auth/logout/

Calls Django logout method and delete the Token object assigned to the current User object. Accepts/Returns nothing.

logout > create

POST /api/v1/auth/logout/

Calls Django logout method and delete the Token object assigned to the current User object. Accepts/Returns nothing.

password > change > create

POST /api/v1/auth/password/change/

Changes current user's password. Accepts the following POST parameters: old_password, new_password Returns the success/fail message.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`old_password` required	Current password
`new_password` required	New password

password > reset > create

POST /api/v1/auth/password/reset/

Calls Django Auth PasswordResetForm save method. Accepts the following POST parameters: email Returns the success/fail message.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`email` required	Email address

password > set > create

POST /api/v1/auth/password/set/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`password` required	New password

register > create

POST /api/v1/auth/register/

Generic user registration.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`email` required	Email address
`password` required	Current password

user > read

GET /api/v1/auth/user/

verify-email > create

POST /api/v1/auth/verify-email/

Verify email if valid one time password given.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`key` required	4 digits key

verify-email > resend > create

POST /api/v1/auth/verify-email/resend/

Resend email verification letter.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`email` required	Email address

blocks

list

GET /api/v1/blocks/

Get all users blocked by the current user.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

block > create

POST /api/v1/blocks/{id}/block/

Block or unblock a user with a custom queryset.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

block > delete

DELETE /api/v1/blocks/{id}/block/

Block or unblock a user with a custom queryset.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

connection-requests

list

GET /api/v1/connection-requests/

Get all new connection request for current user.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`cursor`	The pagination cursor value.

accept

PATCH /api/v1/connection-requests/{id}/accept/

Accept a connection request.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

decline

PATCH /api/v1/connection-requests/{id}/decline/

Decline a connection request.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

explore

list

GET /api/v1/explore/

Get random explore posts list

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

events

GET /api/v1/explore/events/

friends_events

GET /api/v1/explore/friends-events/

local_events

GET /api/v1/explore/local-events/

files

avatars > create

POST /api/v1/files/avatars/

Upload avatar.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`image` required

post-pictures > create

POST /api/v1/files/post-pictures/

Upload post picture.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`image` required

post-pictures > delete

DELETE /api/v1/files/post-pictures/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

guest

explore > list

GET /api/v1/guest/explore/

Get random explore public posts list

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

explore > events

GET /api/v1/guest/explore/events/

explore > read

GET /api/v1/guest/explore/{id}/

Find a public post

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

explore > comments > list

GET /api/v1/guest/explore/{post_pk}/comments/

Get comments list of a public post

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`post_pk` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

invitation

email > create

POST /api/v1/invitation/email/

local-life

post > list

GET /api/v1/local-life/post/

Get locallife posts list

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.
`ordering`	Which field to use when ordering the results.

post > read

GET /api/v1/local-life/post/{id}/

Get a certain locallife post.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`ordering`	Which field to use when ordering the results.

locations

countries > list

GET /api/v1/locations/countries/

List of all available countries.

messenger

list

GET /api/v1/messenger/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`cursor`	The pagination cursor value.

create

POST /api/v1/messenger/

If Conversation with this participants already exist, get one from DB and return 200 status code instead 201 :param request: :param args: :param kwargs: :return:

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`opponent` required

POST /api/v1/messenger/share/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`message` required
`recipients` required

read

GET /api/v1/messenger/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

delete

DELETE /api/v1/messenger/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

centrifugo > auth > create

POST /api/v1/messenger/centrifugo/auth/

messages > list

GET /api/v1/messenger/{conversation_pk}/messages/

Mark all new messages in conversation as read :param request: :param args: :param kwargs: :return:

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`conversation_pk` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`cursor`	The pagination cursor value.

messages > create

POST /api/v1/messenger/{conversation_pk}/messages/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`conversation_pk` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`text`	Message text
`type`	Message type
`object_id`

messages > update

PUT /api/v1/messenger/{conversation_pk}/messages/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`conversation_pk` required
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`status` required

messages > partial_update

PATCH /api/v1/messenger/{conversation_pk}/messages/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`conversation_pk` required
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`status`

news

post > list

GET /api/v1/news/post/

Get news posts list

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.
`ordering`	Which field to use when ordering the results.

post > read

GET /api/v1/news/post/{id}/

Get a certain news post.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`ordering`	Which field to use when ordering the results.

notifications

list

GET /api/v1/notifications/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`cursor`	The pagination cursor value.

checks

GET /api/v1/notifications/checks/

comments

GET /api/v1/notifications/comments/

likes

GET /api/v1/notifications/likes/

new

GET /api/v1/notifications/new/

device > fcm > list

GET /api/v1/notifications/device/fcm/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

device > fcm > create

POST /api/v1/notifications/device/fcm/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`id`
`name`
`registration_id` required
`device_id`	ANDROID_ID / TelephonyManager.getDeviceId() (e.g: 0x01)
`active`	Inactive devices will not be sent notifications
`cloud_message_type`	You should choose FCM or GCM
`application_id`	Opaque application identity, should be filled in for multiple key/certificate access

device > fcm > read

GET /api/v1/notifications/device/fcm/{registration_id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`registration_id` required

device > fcm > update

PUT /api/v1/notifications/device/fcm/{registration_id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`registration_id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`id`
`name`
`registration_id` required
`device_id`	ANDROID_ID / TelephonyManager.getDeviceId() (e.g: 0x01)
`active`	Inactive devices will not be sent notifications
`cloud_message_type`	You should choose FCM or GCM
`application_id`	Opaque application identity, should be filled in for multiple key/certificate access

device > fcm > partial_update

PATCH /api/v1/notifications/device/fcm/{registration_id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`registration_id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`id`
`name`
`registration_id`
`device_id`	ANDROID_ID / TelephonyManager.getDeviceId() (e.g: 0x01)
`active`	Inactive devices will not be sent notifications
`cloud_message_type`	You should choose FCM or GCM
`application_id`	Opaque application identity, should be filled in for multiple key/certificate access

device > fcm > delete

DELETE /api/v1/notifications/device/fcm/{registration_id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`registration_id` required

posts

feed > list

GET /api/v1/posts/feed/

Get user's feed.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`cursor`	The pagination cursor value.

feed > read

GET /api/v1/posts/feed/{id}/

Get a certain post in user's feed.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

feed > add_to_calendar

POST /api/v1/posts/feed/{id}/add_to_calendar/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`is_event`
`is_news`
`is_local_update`
`is_draft`
`city_id`	Google Place ID. Max length: 255

feed > check

POST /api/v1/posts/feed/{id}/check/

Add or delete check to a post.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`is_event`
`is_news`
`is_local_update`
`is_draft`
`city_id`	Google Place ID. Max length: 255

feed > favorite

POST /api/v1/posts/feed/{id}/favorite/

Add or or remove post from user's favorites.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`is_event`
`is_news`
`is_local_update`
`is_draft`
`city_id`	Google Place ID. Max length: 255

feed > join

POST /api/v1/posts/feed/{id}/join/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`is_event`
`is_news`
`is_local_update`
`is_draft`
`city_id`	Google Place ID. Max length: 255

feed > like

POST /api/v1/posts/feed/{id}/like/

Add or delete like to a post.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`is_event`
`is_news`
`is_local_update`
`is_draft`
`city_id`	Google Place ID. Max length: 255

feed > reminder

POST /api/v1/posts/feed/{id}/reminder/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`is_event`
`is_news`
`is_local_update`
`is_draft`
`city_id`	Google Place ID. Max length: 255

feed > checks > list

GET /api/v1/posts/feed/{post_pk}/checks/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`post_pk` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

feed > checks > create

POST /api/v1/posts/feed/{post_pk}/checks/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`post_pk` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`id` required
`username` required
`first_name` required
`avatar` required

feed > checks > delete

DELETE /api/v1/posts/feed/{post_pk}/checks/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`post_pk` required
`id` required

feed > comments > list

GET /api/v1/posts/feed/{post_pk}/comments/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`post_pk` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

feed > comments > create

POST /api/v1/posts/feed/{post_pk}/comments/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`post_pk` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`text` required	Maximum length is 1000 symbols
`user_links`

feed > comments > update

PUT /api/v1/posts/feed/{post_pk}/comments/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`post_pk` required
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`text` required	Maximum length is 1000 symbols
`user_links`

feed > comments > partial_update

PATCH /api/v1/posts/feed/{post_pk}/comments/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`post_pk` required
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`text`	Maximum length is 1000 symbols
`user_links`

feed > comments > delete

DELETE /api/v1/posts/feed/{post_pk}/comments/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`post_pk` required
`id` required

feed > comments > replies > list

GET /api/v1/posts/feed/{post_pk}/comments/{comment_pk}/replies/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`post_pk` required
`comment_pk` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

feed > comments > replies > create

POST /api/v1/posts/feed/{post_pk}/comments/{comment_pk}/replies/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`post_pk` required
`comment_pk` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`text` required	Maximum length is 1000 symbols
`user_links`

feed > comments > replies > update

PUT /api/v1/posts/feed/{post_pk}/comments/{comment_pk}/replies/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`post_pk` required
`comment_pk` required
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`text` required	Maximum length is 1000 symbols
`user_links`

feed > comments > replies > partial_update

PATCH /api/v1/posts/feed/{post_pk}/comments/{comment_pk}/replies/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`post_pk` required
`comment_pk` required
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`text`	Maximum length is 1000 symbols
`user_links`

feed > comments > replies > delete

DELETE /api/v1/posts/feed/{post_pk}/comments/{comment_pk}/replies/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`post_pk` required
`comment_pk` required
`id` required

feed > joins > list

GET /api/v1/posts/feed/{post_pk}/joins/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`post_pk` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

feed > joins > create

POST /api/v1/posts/feed/{post_pk}/joins/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`post_pk` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`id` required
`username` required
`first_name` required
`avatar` required

feed > joins > delete

DELETE /api/v1/posts/feed/{post_pk}/joins/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`post_pk` required
`id` required

my > list

GET /api/v1/posts/my/

My posts list.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

my > create

POST /api/v1/posts/my/

Create a post.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`title` required	Maximum length is 255 symbols
`description` required
`tags` required
`categories` required	Choose at least one category
`visibility`
`pictures` required
`place` required	Google Places API `place_id` value
`lat_lng`	Custom place coordinates
`is_local_tip`
`is_local_update`
`is_event`
`is_draft`
`event`
`localupdate`
`city_id`	Google Place ID. Max length: 255
`user_links`

my > precheck_is_local_tip

POST /api/v1/posts/my/precheck-is-local-tip/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`location` required
`place`

my > read

GET /api/v1/posts/my/{id}/

Get post detail.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

my > update

PUT /api/v1/posts/my/{id}/

Update post detail.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`title` required	Maximum length is 255 symbols
`description` required
`tags` required
`categories` required	Choose at least one category
`visibility`
`pictures` required
`place` required	Google Places API `place_id` value
`lat_lng`	Custom place coordinates
`is_local_tip`
`is_local_update`
`is_event`
`is_draft`
`event`
`localupdate`
`city_id`	Google Place ID. Max length: 255
`user_links`

my > partial_update

PATCH /api/v1/posts/my/{id}/

Update post detail.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`title`	Maximum length is 255 symbols
`description`
`tags`
`categories`	Choose at least one category
`visibility`
`pictures`
`place`	Google Places API `place_id` value
`lat_lng`	Custom place coordinates
`is_local_tip`
`is_local_update`
`is_event`
`is_draft`
`event`
`localupdate`
`city_id`	Google Place ID. Max length: 255
`user_links`

my > delete

DELETE /api/v1/posts/my/{id}/

Remove post.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

profile

my > read

GET /api/v1/profile/my/

my > create

POST /api/v1/profile/my/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`username` required	Maximum length is 100 symbols
`first_name` required	Maximum length is 255 symbols
`last_name` required	Maximum length is 255 symbols
`avatar`	Avatar ID
`info`	Text information
`city_special`	What makes my city special
`website`
`place` required	Google Places API `place_id` value

my > update

PUT /api/v1/profile/my/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`username` required	Maximum length is 100 symbols
`first_name` required	Maximum length is 255 symbols
`last_name` required	Maximum length is 255 symbols
`avatar`	Avatar ID
`info`	Text information
`city_special`	What makes my city special
`website`
`place` required	Google Places API `place_id` value

my > partial_update

PATCH /api/v1/profile/my/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`username`	Maximum length is 100 symbols
`first_name`	Maximum length is 255 symbols
`last_name`	Maximum length is 255 symbols
`avatar`	Avatar ID
`info`	Text information
`city_special`	What makes my city special
`website`
`place`	Google Places API `place_id` value

my > delete

DELETE /api/v1/profile/my/

my > interests > read

GET /api/v1/profile/my/interests/

my > interests > update

PATCH /api/v1/profile/my/interests/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`interests`

my > local-tips > list

GET /api/v1/profile/my/local-tips/

my > local-tips > read

GET /api/v1/profile/my/local-tips/{slug}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`slug` required

my > network > all

GET /api/v1/profile/my/network/all/

my > network > fof

GET /api/v1/profile/my/network/fof/

Get list of current user's friends of friends. Available search by username, first name and last name

my > network > followers

GET /api/v1/profile/my/network/followers/

Get list of current user's followers. Available search by username, first name and last name

my > network > following

GET /api/v1/profile/my/network/following/

Get list of users that current user followings. Available search by username, first name and last name

my > network > friends

GET /api/v1/profile/my/network/friends/

Get list of current user's friends. Available search by username, first name and last name

my > network > network

GET /api/v1/profile/my/network/network/

my > notifications > read

GET /api/v1/profile/my/notifications/

Notifications action endpoint for retrieve and update notifications :return: Profile.notifications json field

my > notifications > partial_update

PATCH /api/v1/profile/my/notifications/

Notifications action endpoint for retrieve and update notifications :return: Profile.notifications json field

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`notifications`

my > posts > list

GET /api/v1/profile/my/posts/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`category`
`city`
`city_id`
`place_id`

my > posts > checks

GET /api/v1/profile/my/posts/checks/

my > posts > events

GET /api/v1/profile/my/posts/events/

my > posts > favorites

GET /api/v1/profile/my/posts/favorites/

my > posts > join_events

GET /api/v1/profile/my/posts/join_events/

my > posts > local_tip

GET /api/v1/profile/my/posts/local_tip/

my > posts > local_tips

GET /api/v1/profile/my/posts/local_tips/

my > top-things > read

GET /api/v1/profile/my/top-things/

my > top-things > update

PATCH /api/v1/profile/my/top-things/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`top_things`

my > wishlist > list

GET /api/v1/profile/my/wishlist/

ViewSet for managing wishlists including CRUD operations and custom actions.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.
`search`	A search term.

my > wishlist > create

POST /api/v1/profile/my/wishlist/

ViewSet for managing wishlists including CRUD operations and custom actions.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name` required
`is_private`
`is_default`

my > wishlist > remove_post_from_wishlists

POST /api/v1/profile/my/wishlist/remove_post_from_wishlists/

ViewSet for managing wishlists including CRUD operations and custom actions.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name` required
`is_private`
`is_default`

my > wishlist > read

GET /api/v1/profile/my/wishlist/{id}/

ViewSet for managing wishlists including CRUD operations and custom actions.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this wishlist.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`search`	A search term.

my > wishlist > add_post

POST /api/v1/profile/my/wishlist/{id}/add_post/

ViewSet for managing wishlists including CRUD operations and custom actions.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this wishlist.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name` required
`is_private`
`is_default`

my > wishlist > partial_updates

PATCH /api/v1/profile/my/wishlist/{id}/partial_updates/

Update the name and/or privacy status of a wishlist.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this wishlist.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name`
`is_private`
`is_default`

my > wishlist > remove

DELETE /api/v1/profile/my/wishlist/{id}/remove/

Delete a wishlist.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this wishlist.

my > wishlist > remove_post

POST /api/v1/profile/my/wishlist/{id}/remove_post/

ViewSet for managing wishlists including CRUD operations and custom actions.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this wishlist.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`name` required
`is_private`
`is_default`

my > wishlist > posts > list

GET /api/v1/profile/my/wishlist/{wishlist_pk}/posts/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`wishlist_pk` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`category`
`city`
`place_id`

profiles

read

GET /api/v1/profiles/{username}/

Get public profile detail.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`username` required

connect > create

POST /api/v1/profiles/{username}/connect/

Send friendship request to profile or remove friendship.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`username` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`username` required	Maximum length is 100 symbols
`first_name` required	Maximum length is 255 symbols
`last_name` required	Maximum length is 255 symbols
`avatar` required
`info`	Text information
`city_special`	What makes my city special
`website`	URL
`interests` required
`top_things` required
`connection_status` required
`is_followed` required

connect > delete

DELETE /api/v1/profiles/{username}/connect/

Send friendship request to profile or remove friendship.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`username` required

follow > create

POST /api/v1/profiles/{username}/follow/

Follow or unfollow user.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`username` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`username` required	Maximum length is 100 symbols
`first_name` required	Maximum length is 255 symbols
`last_name` required	Maximum length is 255 symbols
`avatar` required
`info`	Text information
`city_special`	What makes my city special
`website`	URL
`interests` required
`top_things` required
`connection_status` required
`is_followed` required

follow > delete

DELETE /api/v1/profiles/{username}/follow/

Follow or unfollow user.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`username` required

local-tips > list

GET /api/v1/profiles/{profile_username}/local-tips/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`profile_username` required

local-tips > read

GET /api/v1/profiles/{profile_username}/local-tips/{slug}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`profile_username` required
`slug` required

network > all

GET /api/v1/profiles/{profile_username}/network/all/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`profile_username` required

network > fof

GET /api/v1/profiles/{profile_username}/network/fof/

Get list of user's friends of friends. Available search by username, first name and last name

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`profile_username` required

network > followers

GET /api/v1/profiles/{profile_username}/network/followers/

Get list of user's followers. Available search by username, first name and last name

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`profile_username` required

network > following

GET /api/v1/profiles/{profile_username}/network/following/

Get list of users that user followings. Available search by username, first name and last name

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`profile_username` required

network > friends

GET /api/v1/profiles/{profile_username}/network/friends/

Get list of user's friends. Available search by username, first name and last name

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`profile_username` required

network > network

GET /api/v1/profiles/{profile_username}/network/network/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`profile_username` required

posts > list

GET /api/v1/profiles/{profile_username}/posts/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`profile_username` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`category`
`city`
`city_id`
`place_id`

posts > checks

GET /api/v1/profiles/{profile_username}/posts/checks/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`profile_username` required

posts > events

GET /api/v1/profiles/{profile_username}/posts/events/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`profile_username` required

posts > favorites

GET /api/v1/profiles/{profile_username}/posts/favorites/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`profile_username` required

posts > join_events

GET /api/v1/profiles/{profile_username}/posts/join_events/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`profile_username` required

posts > local_tip

GET /api/v1/profiles/{profile_username}/posts/local_tip/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`profile_username` required

posts > local_tips

GET /api/v1/profiles/{profile_username}/posts/local_tips/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`profile_username` required

wishlist > posts > list

GET /api/v1/profiles/wishlist/{wishlist_pk}/posts/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`wishlist_pk` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`category`
`city`
`place_id`

wishlist > public > list

GET /api/v1/profiles/wishlist/{profile_username}/public/

ViewSet for managing wishlists including CRUD operations and custom actions.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`profile_username` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

wishlist > public > read

GET /api/v1/profiles/wishlist/{profile_username}/public/{id}/

ViewSet for managing wishlists including CRUD operations and custom actions.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`profile_username` required
`id` required	A unique integer value identifying this wishlist.

reports

report_post

POST /api/v1/reports/post/

Endpoint to report a post. Prevents duplicate reports.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`reported_user` required
`reason` required
`description`

report_user

POST /api/v1/reports/user/

Endpoint to report a user. Prevents duplicate reports.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`reported_user` required
`reason` required
`description`

search

cities > list

GET /api/v1/search/cities/

Find city. Available query params: search and country (2 letters)

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`search`	A search term.

cities > near_me

GET /api/v1/search/cities/near-me/

cities > read

GET /api/v1/search/cities/{place_id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`place_id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`search`	A search term.

cities > events > list

GET /api/v1/search/cities/{city_place_id}/events/

Find Event posts in certain city. Find Friends Event posts in certain city. Query Param: action (optional) = "local_events" or "friends_events"

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`city_place_id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`category`

cities > fof > list

GET /api/v1/search/cities/{city_place_id}/fof/

Find friends of friends posts in certain city.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`city_place_id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`category`

cities > friends > list

GET /api/v1/search/cities/{city_place_id}/friends/

Find friends posts in certain city.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`city_place_id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`category`

cities > local-life > list

GET /api/v1/search/cities/{city_place_id}/local-life/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`city_place_id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

cities > local-tips > list

GET /api/v1/search/cities/{city_place_id}/local-tips/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`city_place_id` required

cities > local-tips > read

GET /api/v1/search/cities/{city_place_id}/local-tips/{slug}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`city_place_id` required
`slug` required

cities > locals > list

GET /api/v1/search/cities/{city_place_id}/locals/

Find profile in certain city.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`city_place_id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`search`	Search in first_name, last_name, username.

cities > news > list

GET /api/v1/search/cities/{city_place_id}/news/

Find News posts in certain city.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`city_place_id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.

cities > posts > list

GET /api/v1/search/cities/{city_place_id}/posts/

Find posts in certain city.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`city_place_id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`category`

keywords > list

GET /api/v1/search/keywords/

Find tag.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`search`	Search in title.
`city`
`category`

keywords > suggest

GET /api/v1/search/keywords/suggest/

Suggest functionality.

locations > list

GET /api/v1/search/locations/

Find city. Available query params: search and country (2 letters)

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`search`	A search term.

locations > places

GET /api/v1/search/locations/places/

locations > read

GET /api/v1/search/locations/{place_id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`place_id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`search`	A search term.

locations > check

POST /api/v1/search/locations/{place_id}/check/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`place_id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`place_id` required

locations > posts > list

GET /api/v1/search/locations/{location_place_id}/posts/

Find posts in certain location.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`location_place_id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`category`

profiles > list

GET /api/v1/search/profiles/

Find profile.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`search`	Search in first_name, last_name, username.

GET /api/v1/search/profiles/related/

tags > list

GET /api/v1/search/tags/

Find tag.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`search`	Search in name.

tags > posts > list

GET /api/v1/search/tags/{tag_slug}/posts/

Find posts in certain city.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`tag_slug` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`page`	A page number within the paginated result set.
`city`
`category`

2B Local API

2B Local API

auth

apple > create

Request Body

email > change > create

Request Body

facebook > create

Request Body

google > create

Request Body

login > create

Request Body

logout > list

logout > create

password > change > create

Request Body

password > reset > create

Request Body

password > set > create

Request Body

register > create

Request Body

user > read

verify-email > create

Request Body

verify-email > resend > create

Request Body

blocks

list

Query Parameters

block > create

Path Parameters

block > delete

Path Parameters

connection-requests

list

Query Parameters

accept

Path Parameters

decline

Path Parameters

explore

list

Query Parameters

events

friends_events

local_events

files

avatars > create

Request Body

post-pictures > create

Request Body

post-pictures > delete

Path Parameters

guest

explore > list

Query Parameters

explore > events

explore > read

Path Parameters

explore > comments > list

Path Parameters

Query Parameters

invitation

email > create

local-life

post > list

Query Parameters

post > read

Path Parameters

Query Parameters

locations

countries > list

messenger

list

Query Parameters

create

Request Body

share