API Endpoints

Complete API endpoint documentation for ZÈYA API.

Base URLs

Production: https://api.zeya.app/api/v1/
Staging: https://staging-api.zeya.app/api/v1/
Local: http://localhost:8000/api/v1/

Authentication

Most endpoints require JWT authentication. Include the token in the Authorization header:

Authorization: Bearer {your-jwt-token}

Response Format

Success Response

{
  "success": true,
  "data": { ... },
  "message": "Operation successful"
}

Error Response

{
  "success": false,
  "error": "Error message",
  "code": "ERROR_CODE",
  "errors": { ... } // For validation errors
}

Paginated Response

{
  "success": true,
  "data": [ ... ],
  "pagination": {
    "current_page": 1,
    "total_pages": 5,
    "total_items": 100,
    "per_page": 20,
    "has_next": true,
    "has_prev": false
  }
}

Public Endpoints

Authentication (/api/v1/)

Method	Endpoint	Description	Auth Required
POST	/login	Login user	No
POST	/alternate-login	Alternate login method	No
POST	/alternate-login-apple	Apple Sign-In	No
POST	/register	Register new user	No
GET	/logout	Logout user	Yes
GET	/refresh	Refresh JWT token	Yes
GET	/check-token	Validate token	Yes
POST	/password-reset-otp-sent	Request password reset OTP	No
POST	/validate-otp	Validate OTP	No
POST	/submit-reset-password	Reset password	No

Onboarding (/api/v1/onboarding/)

Method	Endpoint	Description	Auth Required
POST	/send-verification-code	Send phone verification code	No
POST	/verify-code	Verify phone code	No
POST	/resend-verification-code	Resend verification code	No
POST	/register-basic-info	Register basic user info	No
POST	/send-login-otp	Send login OTP	No
POST	/verify-login-otp	Verify login OTP	No
GET	/is-complete	Check onboarding status	No
POST	/location	Save user location	Yes
POST	/categories	Save categories	Yes
POST	/hashtags	Save hashtags	Yes
POST	/preferences	Save preferences	Yes
POST	/swap-reasons	Save swap reasons	Yes
POST	/groups	Save groups	Yes
GET	/status	Get onboarding status	Yes
GET	/groups-suggestions	Get suggested groups	Yes
GET	/style-tags	Get style tags	Yes

Authenticated Endpoints

Products (/api/v1/)

Method	Endpoint	Description
GET	/get-category	Get all categories
GET	/products	Get user's products
POST	/add-product	Create new product
POST	/update-product/{id}	Update product
DELETE	/product/{id}	Delete product
GET	/swap-products	Get products for swapping
GET	/product-details	Get product details
GET	/nearby-products	Get nearby products
GET	/trending-products	Get trending products
GET	/dashboard-summary	Get user dashboard summary
POST	/product-reports	Report a product

User Bookmarks (/api/v1/user-bookmark-item)

Method	Endpoint	Description
POST	/	Create bookmark
GET	/	Get all bookmarks
GET	/{id}	Get bookmark details
DELETE	/	Delete bookmark
PATCH	/	Toggle bookmark

User Likes (/api/v1/user-like-item)

Method	Endpoint	Description
POST	/	Like a product
POST	/user-dislike-item	Dislike a product
GET	/	Get liked items
GET	/{id}	Get like details
DELETE	/	Remove like
GET	/user-like-recived	Get received likes
GET	/user-like-recived/{id}	Get received like details

Swap Transactions (/api/v1/swap-transaction)

Method	Endpoint	Description
POST	/add-swap-transaction	Create swap request
GET	/accept-swap-transaction	Accept swap request
GET	/	Get user swap transactions
GET	/{id}/details	Get transaction details
GET	/{id}/complete	Complete transaction
GET	/{id}/unmatch	Unmatch transaction
GET	/review	Get pending reviews
POST	/review	Submit review
GET	/{id}/unihop	Get transaction for unihop

Chat (/api/v1/user-chat)

Method	Endpoint	Description
GET	/	Get all chats
POST	/user-chat-create	Create new chat
PATCH	/pin	Pin/unpin chat
DELETE	/{id}	Delete chat
GET	/{transaction_id}/message	Get chat messages
POST	/{transaction_id}/message	Send message
POST	/{transaction_id}/media	Upload media
POST	/{transaction_id}/message/{id}/status	Update message status
GET	/restore	Restore deleted chat

Groups (/api/v1/groups)

Method	Endpoint	Description
GET	/	Get all groups
GET	/my-groups	Get user's groups
POST	/	Create group
POST	/{id}	Update group
DELETE	/{id}	Delete group
GET	/{id}/details	Get group details
GET	/{uid}/info	Get group info by UID
GET	/{id}/members	Get group members
GET	/{id}/members/images	Get member images
GET	/{id}/leave	Leave group
GET	/{id}/invite	Get invite link
POST	/{id}/invite	Create invite
POST	/group/accept-invite	Accept invite
POST	/group-join	Join group from app
GET	/{id}/requests	Get join requests
POST	/{id}/requests	Request to join
POST	/{id}/requests/{req_id}/action	Approve/reject request
GET	/my-groups-requests	Get user's requests
GET	/{id}/products	Get group products
POST	/{id}/products	Add product to group
DELETE	/{id}/products/{prod_id}	Remove product from group
GET	/{id}/products/{prod_id}/exclusive	Toggle exclusive
GET	/{id}/products/{prod_id}/pin	Pin product
GET	/preview-groups	Preview groups
GET	/preview-groups-data	Preview group data
PATCH	/{id}/featured	Update featured status

Users (/api/v1/)

Method	Endpoint	Description
GET	/user-profile	Get current user profile
GET	/profile/{id}	Get user profile by ID
GET	/email-availability	Check email availability
POST	/check-username	Check username availability
PATCH	/update-phone	Update phone number
POST	/validate-phone	Validate phone number
POST	/user-address	Save user address
DELETE	/delete-user	Delete user account
POST	/user-update	Update user profile
POST	/user-update-password	Update password
POST	/user-update-image	Update profile image
GET	/user-rating	Get user rating
GET	/users	Get users list

Addresses (/api/v1/addresses)

Method	Endpoint	Description
GET	/	Get all addresses
GET	/{id}	Get address details
POST	/	Create address
PUT	/{id}	Update address
DELETE	/{id}	Delete address
PATCH	/{id}/default	Set default address

Notifications (/api/v1/)

Method	Endpoint	Description
GET	/user-sessions	Save user session
POST	/save-device-token	Save device token
GET	/unopen-notification	Get unread notifications
PATCH	/read-notification	Mark all as read
GET	/user-notification	Get user notifications
GET	/notification/{id}/read	Mark notification as read

Subscriptions (/api/v1/)

Method	Endpoint	Description
GET	/subscription-plans	Get subscription plans
GET	/user-subscription	Get user subscriptions
GET	/user-subscription/history	Get subscription history

Referrals (/api/v1/referral)

Method	Endpoint	Description
GET	/	Get referral info
POST	/update	Update referral code
POST	/track-share	Track share
POST	/track-download	Track download
POST	/source-platform	Update source platform
GET	/user-referral	Get users with referrals
GET	/referred-users-list	Get referred users

Version Control (/api/v1/)

Method	Endpoint	Description
POST	/check-version	Check app version
GET	/version-details	Get version details

Advertisements (/api/v1/)

Method	Endpoint	Description
GET	/fetch-ads	Get advertisements
POST	/ads-activity	Track ad activity
GET	/fetch-batch-ads	Get batch advertisements
POST	/advertisement-report	Report advertisement
GET	/advertisement-report	Get reports
PATCH	/advertisement-report	Update report status

Admin Endpoints (/api/admin/v1/)

All admin endpoints require auth.admin middleware.

Authentication

Method	Endpoint	Description
POST	/login	Admin login
GET	/logout	Admin logout
GET	/refresh	Refresh token
GET	/check-token	Validate token

Users

Method	Endpoint	Description
GET	/users	List users
GET	/users/{id}/ips	Get user IPs
GET	/user-profile	Get user profile
PATCH	/user-update	Update user
POST	/user-edit	Edit user
GET	/user-count	Get user count
POST	/user-blacklist	Blacklist user
POST	/user-unblacklist	Unblacklist user
GET	/users-export	Export users

Products

Method	Endpoint	Description
GET	/products	List products
PATCH	/product-update	Update product
GET	/product-count	Get product count
POST	/add-demo-product	Create demo product
POST	/admin/create-product	Create product
POST	/admin/update-product	Update product
DELETE	/product/{id}	Delete product

Groups

Method	Endpoint	Description
GET	/groups	List groups
GET	/groups/{id}/details	Get group details
GET	/groups/{id}/members	Get members
GET	/groups/{id}/products	Get group products

Reports

Method	Endpoint	Description
GET	/report/transaction	Transaction report
GET	/report/transaction/all	All transactions
GET	/report/transaction/{id}	Transaction details
GET	/report/subscription	Subscription report
GET	/report/user/{id}	User detail report
GET	/report/reported-product/all	All reported products
GET	/report/reported-product/{id}	Report details
PATCH	/report/report-status-update	Update report status

Analytics & Insights

See Features for detailed analytics endpoints.

Service API (/api/service/)

Authentication

Method	Endpoint	Description
POST	/create-service-token	Create service token

Protected Endpoints (auth:service)

Method	Endpoint	Description
GET	/verify-product/{id}	Get product for verification
POST	/mark-product-verified/{id}	Mark as verified
POST	/classify-product/{id}	Classify product
POST	/log-processing-step	Log processing step
GET	/processing-stats	Get processing stats

Related Documentation

• Setup & Installation
• Development Guide
• Features