This reference covers the REST endpoints commonly used with Directorist-powered sites. It is intentionally concise and developer-friendly.<\/p>\n\n\n\n
\/wp-json\/directorist\/v1<\/code> \u2013 Base API endpoint for Directorist (returns general plugin info)postman.com<\/a>.<\/li>\n\n\n\n- POST<\/strong>
\/wp-json\/wp\/v2\/media<\/code> \u2013 Upload a media file (e.g., listing image) to WordPresspostman.com<\/a>.<\/li>\n\n\n\n- POST<\/strong>
\/wp-json\/wp\/v2\/posts<\/code> \u2013 Create a new WordPress post (e.g., for blog content). Query parameters (title, content, status) are passed in the URLpostman.com<\/a>.<\/li>\n<\/ul>\n\n\n\nUser Management<\/h2>\n\n\n\n\n- GET<\/strong>
\/wp-json\/directorist\/v1\/users\/<\/code> \u2013 Retrieve a list of users. Supports filtering via query parameters (e.g., email<\/code>, page<\/code>)postman.com<\/a>.<\/li>\n\n\n\n- POST<\/strong>
\/wp-json\/directorist\/v1\/users\/{user_id}<\/code> \u2013 Update a user\u2019s details (e.g., email) by user IDpostman.com<\/a>.<\/li>\n\n\n\n- DELETE<\/strong>
\/wp-json\/directorist\/v1\/users\/{user_id}?force=1<\/code> \u2013 Delete a user by ID. The force=1<\/code> parameter ensures permanent deletionpostman.com<\/a>.<\/li>\n\n\n\n- POST<\/strong>
\/wp-json\/directorist\/v1\/users\/?email={email}&password={password}<\/code> \u2013 Create a new user with given email and password (additional details can be provided via form data: username<\/code>, first_name<\/code>, etc.)postman.com<\/a>.<\/li>\n\n\n\n- POST<\/strong>
\/wp-json\/directorist\/v1\/users\/{user_id}\/favorites\/?id={listing_id}<\/code> \u2013 Add a listing to the user\u2019s favorites (pass the listing ID as id<\/code>)postman.com<\/a>.<\/li>\n\n\n\n- DELETE<\/strong>
\/wp-json\/directorist\/v1\/users\/{user_id}\/favorites\/{listing_id}<\/code> \u2013 Remove a listing (by listing ID) from the user\u2019s favoritespostman.com<\/a>.<\/li>\n<\/ul>\n\n\n\nAuthentication \/ Account<\/h2>\n\n\n\n\n- POST<\/strong>
\/wp-json\/directorist\/dev\/register-user?email={email}&password={password}<\/code> \u2013 Register (sign up) a new user accountpostman.com<\/a>.<\/li>\n\n\n\n- POST<\/strong>
\/wp-json\/directorist\/v1\/users\/account\/change-password?old_password={old}&new_password={new}&user_id={id}<\/code> \u2013 Change a user\u2019s password. Requires the old password, new password, and the user IDpostman.com<\/a>.<\/li>\n\n\n\n- POST<\/strong>
\/wp-json\/directorist\/v1\/users\/account\/reset-user-password?password={new}&pin={pin}&email={email}<\/code> \u2013 Reset password using a PIN. Requires the new password, the reset PIN, and the user\u2019s emailpostman.com<\/a>.<\/li>\n\n\n\n- POST<\/strong>
\/wp-json\/directorist\/v1\/users\/account\/verify-password-reset-pin?email={email}&pin={pin}<\/code> \u2013 Verify a password reset PIN sent to the user\u2019s emailpostman.com<\/a>.<\/li>\n\n\n\n- POST<\/strong>
\/wp-json\/jwt-auth\/v1\/token?username={email}&password={password}<\/code> \u2013 Authenticate a user and obtain a JWT token (pass username\/email and password)postman.com<\/a>.<\/li>\n\n\n\n- POST<\/strong>
\/wp-json\/jwt-auth\/v1\/token\/validate<\/code> \u2013 Validate an existing JWT token (token must be sent in the Authorization header)postman.com<\/a>.<\/li>\n\n\n\n- POST<\/strong>
\/wp-json\/directorist\/v1\/users\/account\/send-password-reset-pin?email={email}<\/code> \u2013 Send a password reset PIN\/link to the given email addresspostman.com<\/a>.<\/li>\n\n\n\n- POST<\/strong>
\/wp-json\/directorist\/v1\/users\/account\/get-password-reset-pin?email={email}<\/code> \u2013 Retrieve or verify the password reset PIN for the given email (used internally by the app)postman.com<\/a>.<\/li>\n<\/ul>\n\n\n\nListings<\/h2>\n\n\n\n\n- GET<\/strong>
\/wp-json\/directorist\/v1\/listings<\/code> \u2013 Retrieve listings, with many optional filters (e.g., include<\/code>, categories<\/code>, locations<\/code>, min_price<\/code>, max_price<\/code>, ratings<\/code>, radius[...]<\/code>, expired<\/code>, pending<\/code>, author<\/code>, status<\/code>, etc.)postman.com<\/a>.<\/li>\n\n\n\n- POST<\/strong>
\/wp-json\/directorist\/v1\/listings?title={title}<\/code> \u2013 Create or update a listing. The title<\/code> (and other listing fields) can be passed via query string or form datapostman.com<\/a>.<\/li>\n\n\n\n- GET<\/strong>
\/wp-json\/directorist\/v1\/listings?per_page=5&order=desc&orderby=date<\/code> \u2013 Get the newest listings (example: limit 5, sorted by date descending)postman.com<\/a>.<\/li>\n\n\n\n- GET<\/strong>
\/wp-json\/directorist\/v1\/listings?featured=true&per_page=5&order=desc&orderby=date<\/code> \u2013 Get featured listings (example: limit 5, sorted by date)postman.com<\/a>.<\/li>\n\n\n\n- GET<\/strong>
\/wp-json\/directorist\/v1\/listings\/reviews\/?listing={listing_id}<\/code> \u2013 Get reviews for a specific listing by listing IDpostman.com<\/a>.<\/li>\n<\/ul>\n\n\n\nCategories, Tags, and Locations (Terms)<\/h2>\n\n\n\n\n- GET<\/strong>
\/wp-json\/directorist\/v1\/listings\/categories?hide_empty=true<\/code> \u2013 List all listing categories (by default hide categories with no listings)postman.com<\/a>.<\/li>\n\n\n\n- GET<\/strong>
\/wp-json\/directorist\/v1\/listings\/categories?per_page=1&hide_empty=true&orderby=count&order=desc&page=2<\/code> \u2013 List popular categories (sorted by listing count)postman.com<\/a>.<\/li>\n\n\n\n- GET<\/strong>
\/wp-json\/directorist\/v1\/listings\/locations?per_page=10&hide_empty=true&orderby=count&order=desc<\/code> \u2013 List top locations (sorted by listing count, limited to 10)postman.com<\/a>.<\/li>\n\n\n\n- GET<\/strong>
\/wp-json\/directorist\/v1\/listings\/tags<\/code> \u2013 List all tags used in listingspostman.com<\/a>.<\/li>\n\n\n\n- GET<\/strong>
\/wp-json\/directorist\/v1\/listings\/locations<\/code> \u2013 List all locations used in listingspostman.com<\/a>.<\/li>\n<\/ul>\n\n\n\nFirebase Notifications (Push)<\/h2>\n\n\n\n\n- POST<\/strong>
https:\/\/firestore.googleapis.com\/v1\/projects\/{{firebase_project_name}}\/databases\/(default)\/documents\/notifications\/user_{user_id}\/notifications<\/code> \u2013 Add a notification document to Firestore for user {user_id}<\/code>. The request body is raw JSON with fields (e.g., title, body, data)postman.com<\/a>.<\/li>\n\n\n\n- GET<\/strong>
https:\/\/firestore.googleapis.com\/v1\/projects\/{{firebase_project_name}}\/databases\/(default)\/documents\/notifications<\/code> \u2013 Retrieve all notifications documents (for all users) from Firestorepostman.com<\/a>.<\/li>\n\n\n\n- POST<\/strong>
https:\/\/fcm.googleapis.com\/fcm\/send<\/code> \u2013 Send a push notification to a specific device via Firebase Cloud Messaging (FCM). The request body is raw JSON specifying target device token (to<\/code>) and notification data (title, body, etc.)postman.com<\/a>.<\/li>\n<\/ul>\n\n\n\nPayment System (WooCommerce)<\/h2>\n\n\n\n
(These endpoints use WooCommerce\u2019s REST API v3, enabled when Directorist monetization is active.)<\/em><\/p>\n\n\n\n\n- GET<\/strong>
\/wp-json\/wc\/v3\/orders<\/code> \u2013 Retrieve a list of WooCommerce orders (all orders in the store)postman.com<\/a>.<\/li>\n\n\n\n- GET<\/strong>
\/wp-json\/wc\/v3\/orders\/{order_id}<\/code> \u2013 Retrieve details of a single order by its IDpostman.com<\/a>.<\/li>\n\n\n\n- GET<\/strong>
\/wp-json\/wc\/v3\/refunds<\/code> \u2013 Retrieve a list of refunds (new in WooCommerce API v3)postman.com<\/a>.<\/li>\n\n\n\n- GET<\/strong>
\/wp-json\/wc\/v3\/refunds\/{refund_id}<\/code> \u2013 Retrieve a single refund by its IDpostman.com<\/a>.<\/li>\n\n\n\n- POST<\/strong>
\/wp-json\/wc\/v3\/orders\/{order_id}\/refunds<\/code> \u2013 Create a refund for the given order ID (pass refund details in request body)postman.com<\/a>.<\/li>\n\n\n\n- DELETE<\/strong>
\/wp-json\/wc\/v3\/orders\/{order_id}\/refunds\/{refund_id}<\/code> \u2013 Delete a specific refund by its ID for a given orderpostman.com<\/a>.<\/li>\n<\/ul>\n\n\n\n<\/p>\n","protected":false},"excerpt":{"rendered":"
This reference covers the REST endpoints commonly used with Directorist-powered sites. It is intentionally concise and developer-friendly. General \/ WordPress Endpoints User Management Authentication \/ Account Listings Categories, Tags, and Locations (Terms) Firebase Notifications (Push) Payment System (WooCommerce) (These endpoints use WooCommerce\u2019s REST API v3, enabled when Directorist monetization is active.)<\/p>\n","protected":false},"author":24585,"featured_media":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"doc_category":[699],"doc_tag":[],"class_list":["post-368693","docs","type-docs","status-publish","hentry","doc_category-developers-doc"],"year_month":"2026-03","word_count":904,"total_views":0,"reactions":{"happy":0,"normal":0,"sad":0},"author_info":{"name":"yousuf.sovware","author_nicename":"yousuf-sovware","author_url":"https:\/\/directorist.com\/author\/yousuf-sovware\/"},"doc_category_info":[{"term_name":"Developers Doc","term_url":"https:\/\/directorist.com\/docs-category\/developers-doc\/"}],"doc_tag_info":[],"_links":{"self":[{"href":"https:\/\/directorist.com\/wp-json\/wp\/v2\/docs\/368693","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/directorist.com\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/directorist.com\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/directorist.com\/wp-json\/wp\/v2\/users\/24585"}],"replies":[{"embeddable":true,"href":"https:\/\/directorist.com\/wp-json\/wp\/v2\/comments?post=368693"}],"version-history":[{"count":0,"href":"https:\/\/directorist.com\/wp-json\/wp\/v2\/docs\/368693\/revisions"}],"wp:attachment":[{"href":"https:\/\/directorist.com\/wp-json\/wp\/v2\/media?parent=368693"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/directorist.com\/wp-json\/wp\/v2\/doc_category?post=368693"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/directorist.com\/wp-json\/wp\/v2\/doc_tag?post=368693"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}