The Property Hive API is a robust, RESTful web service designed to power real estate management applications. It provides a comprehensive set of endpoints that facilitate various operations essential to property management, user authentication, and financial tracking within the real estate industry.
\nAuthentication and User Management
\nCompany registration
\nUser login and logout
\nPassword management (including forgot and reset password functionalities)
\nProfile Management
\nCompany profile creation and updates
\nUser profile retrieval and management
\nProperty Management
\nProperty listing and information retrieval
\n(Potential future features for property creation, updating, and deletion)
\nFinancial Operations
\nInvoice generation and retrieval
\nTransaction tracking
\nThe Base Urls are:
\nhttps://api.propertyhive.com.ng/\nhttps://express-api.propertyhive.com.ng/\n\nThe current version of the API is v1, which is reflected in the endpoint URLs (e.g., /api/v1/login/).
The API uses Bearer Token authentication. After a successful login, clients receive an access token which must be included in the Authorization header of subsequent requests:
\nAuthorization: Bearer <access_token>\n\nThe API accepts and returns data in JSON format. Ensure that requests with a body have the Content-Type: application/json header set.
The API uses standard HTTP status codes to indicate the success or failure of requests. Common status codes include:
\n200 OK: Successful request
\n201 Created: Successful creation of a resource
\n400 Bad Request: Invalid input or parameters
\n401 Unauthorized: Missing or invalid authentication
\n403 Forbidden: Authenticated but lacking necessary permissions
\n404 Not Found: Requested resource doesn't exist
\n429 Too Many Requests: Rate limit exceeded
\n500 Internal Server Error: Server-side issues
\nThe API implements rate limiting to prevent abuse and ensure fair usage. Clients should handle 429 Too Many Requests responses gracefully, potentially implementing exponential backoff strategies.
\nFor endpoints that may return large datasets (e.g., listing properties or transactions), pagination details should be implemented. Clients should be prepared to handle paginated responses and navigate through result sets accordingly.
\nThe API employs HTTPS for all requests, ensuring data encryption in transit. The use of bearer tokens for authentication adds an additional layer of security, protecting against unauthorized access to sensitive operations and data.
\nAuthentication: Handles user registration, login, logout, and password management.
\nProfile Management: Allows retrieval and updates of company and user profiles.
\nProperty Management: Facilitates property-related operations.
\nFinancial Operations: Manages invoices and tracks transactions.
\nThis API provides a robust foundation for building comprehensive real estate management applications, offering essential features for user account management, property listings, and financial operations within the Property Hive ecosystem.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Property Hive API Introduction","slug":"property-hive-api-introduction"}],"owner":"34635068","collectionId":"ce2162fb-5f72-41f1-9f06-925dfe492d43","publishedId":"2sAXqzVxVn","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-10-04T15:38:31.000Z"},"item":[{"name":"Version 1","item":[{"name":"Authentication","item":[{"name":"Register Company","id":"70fa8c62-383b-49ce-87a4-c11c96ecee91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\":\"property@gmail.com\",\n \"password\":\"property2\",\n \"fname\": \" john \",\n \"lname\": \"boss\",\n \"business_name\": \" property hive \",\n \"profile_picture\": null,\n \"phone_number\": \"080123456\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.propertyhive.com.ng/api/v1/register/company/","description":"POST Register Company: Registers a new company on the platform
POST Forgot Password: Initiates the password recovery process for a company account.
POST Login Company: Authenticates the company using credentials to log in.
POST Logout: Logs out the authenticated company from the platform
POST Reset Password: Resets the password for a company account after verification.
This endpoint is used to verify an email address.
\nRequest Body
\nemail (string, required): The email address to be verified.
code (string, required): The verification code.
Response
\nStatus: 400
\nContent-Type: application/json
\nmessage (string): A message indicating the result of the verification process.
The Authentication section handles user registration, login, logout, and password management functionalities.
\nEndpoint: POST /api/v1/register/company/
This endpoint allows new companies to register on the Property Hive platform.
\nRequest Body:
\n{\n \"email\": \"propertyhive@gmail.com\",\n \"password\": \"property\",\n \"fname\": \"john\",\n \"lname\": \"boss\",\n \"business_name\": \"property hive\",\n \"profile_picture\": null,\n \"phone_number\": \"080123456\"\n}\n\nFields:
\nemail: (string, required) The company's email address.
password: (string, required) The chosen password for the account.
fname: (string, required) First name of the company representative.
lname: (string, required) Last name of the company representative.
business_name: (string, required) The official name of the company.
profile_picture: (string, nullable) URL or reference to a profile picture.
phone_number: (string, required) Contact number for the company.
Response:
\n201 Created: Registration successful
\n400 Bad Request: Invalid input data
\nNotes:
\nEnsure all required fields are provided.
\nThe email and business name should be unique in the system.
\nPassword should meet the platform's security requirements (if any).
\nEndpoint: POST /api/v1/login/
This endpoint authenticates a company and provides access tokens for subsequent API calls.
\nRequest Body:
\n{\n \"email\": \"property@gmail.com\",\n \"password\": \"property2\"\n}\n\nResponse:
\n{\n \"refresh\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\",\n \"access\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\"\n}\n\nFields:
\nrefresh: JWT refresh token for obtaining new access tokens.
access: JWT access token for authenticating API requests.
Response Codes:
\n200 OK: Successful login
\n401 Unauthorized: Invalid credentials
\nNotes:
\nThe access token should be included in the Authorization header of subsequent requests.
\nThe refresh token can be used to obtain a new access token when it expires.
\nEndpoint: POST /api/v1/log-out/
This endpoint logs out the currently authenticated user, invalidating their access token.
\nRequest Body: Empty
\nHeaders:
\nAuthorization: BearerResponse:
\n200 OK: Successful logout
\n401 Unauthorized: Invalid or missing token
\nNotes:
\nAfter logout, the access token becomes invalid and should not be used for further requests.
\nThe client should discard the stored tokens after a successful logout.
\nEndpoint: POST /api/v1/forgot-password/
This endpoint initiates the password reset process for a user who has forgotten their password.
\nRequest Body:
\n{\n \"email\": \"propertyhive@gmail.com\"\n}\n\nResponse:
\n200 OK: Password reset email sent
\n400 Bad Request: Invalid email or user not found
\n429 Too Many Requests: Rate limit exceeded
\nNotes:
\nThis endpoint is rate-limited to prevent abuse.
\nA password reset link or token will typically be sent to the provided email address.
\nEndpoint: POST /api/v1/reset-password/
This endpoint allows users to set a new password using a reset token.
\nRequest Body:
\n{\n \"token\": \"<reset_token>\",\n \"newPassword\": \"123admin\"\n}\n\nResponse:
\n200 OK: Password successfully reset
\n400 Bad Request: Invalid token or password
\n404 Not Found: Token not found or expired
\nNotes:
\nThe token is typically provided via email after initiating the forgot password process.
Ensure the new password meets any required security criteria.
\nGET Get Company Profile: Retrieves the profile details of a company
\n","urlObject":{"path":["api","v1","company-profile",""],"host":["https://api.propertyhive.com.ng/"],"query":[],"variable":[]}},"response":[],"_postman_id":"f30651d8-4a6f-4840-9165-831e9a62b201"},{"name":"Generate Company Url","id":"e2d7da2d-f8b3-4210-ba3f-ac4d2bafeeac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://api.propertyhive.com.ng//api/v1/company/generate-url/","urlObject":{"path":["api","v1","company","generate-url",""],"host":["https://api.propertyhive.com.ng/"],"query":[],"variable":[]}},"response":[],"_postman_id":"e2d7da2d-f8b3-4210-ba3f-ac4d2bafeeac"}],"id":"7ea0d7a4-1186-4202-b0dd-456cec50d4a8","description":"The Profile Management section handles operations related to company and user profiles.
\nEndpoint: PUT /api/v1/company-profile/
This endpoint allows companies to update their profile information.
\nHeaders:
\nAuthorization: BearerRequest Body:
\n{\n \"data\": {\n \"phone_number\": \"080123456\",\n \"company_address\": \"lagos\",\n \"company_logo\": null,\n \"company_banner\": null,\n \"title\": \"best in lagos\",\n \"description\": \"we are aimed at being the best\",\n \"instagram\": \"property_hive\",\n \"linkedin\": null,\n \"facebook\": null,\n \"twitter\": null\n }\n}\n\nFields:
\nAll fields are optional and represent updatable company information.
\nSocial media fields (instagram, linkedin, facebook, twitter) can be null if not applicable.
Response:
\n200 OK: Profile successfully updated
\n400 Bad Request: Invalid input data
\n401 Unauthorized: Invalid or missing token
\nNotes:
\nOnly authenticated companies can update their own profile.
\nFields not included in the request body will remain unchanged.
\nEndpoint: GET /api/v1/company-profile/
This endpoint retrieves the profile information of the authenticated company.
\nHeaders:
\nAuthorization: BearerResponse:
\n200 OK: Successfully retrieved company profile
\n401 Unauthorized: Invalid or missing token
\nNotes:
\nEndpoint: GET /api/v1/profile/
This endpoint retrieves the profile information of the authenticated user.
\nHeaders:
\nAuthorization: BearerResponse:
\n200 OK: Successfully retrieved user profile
\n401 Unauthorized: Invalid or missing token
\nNotes:
\nThis endpoint may return different information compared to the company profile endpoint.
\nIt's designed for individual user accounts within a company, if applicable.
\nGET Retrieve Properties: Retrieves a list of all available properties.
\n","urlObject":{"path":["v1","properties",""],"host":["https://express-api.propertyhive.com.ng/api"],"query":[],"variable":[]}},"response":[{"id":"4c48cfd5-1bbd-485e-87da-73edd4bf0a9a","name":"Retrieve Properties","originalRequest":{"method":"GET","header":[],"url":"https://express-api.propertyhive.com.ng/api/v1/properties/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.24.0 (Ubuntu)"},{"key":"Date","value":"Tue, 01 Oct 2024 12:00:14 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2174"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"87e-a1/IvX1T7COHaLffP0oNlOnuKUM\""}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"totalCount\": 3,\n \"page\": 1,\n \"limit\": 10,\n \"properties\": [\n {\n \"id\": 48,\n \"name\": \"Wisdom Fred Apartments\",\n \"state\": \"San Francisco\",\n \"city\": \"Ohio\",\n \"address\": \"20 main street\",\n \"description\": \"A Nice Landed Property\",\n \"squaremeters\": \"450ft\",\n \"property_type\": \"apartment\",\n \"number_of_bathrooms\": null,\n \"number_of_bedrooms\": null,\n \"installment_duration\": \"7\",\n \"payment_frequency\": \"20000\",\n \"down_payment\": \"1000\",\n \"installment_payment_price\": 1000,\n \"keywords\": [\n \"Apartment\",\n \"Lagos\"\n ],\n \"price\": 2000,\n \"is_sold\": false,\n \"date_sold\": null,\n \"created_at\": \"2024-10-01T11:27:17.601Z\",\n \"updated_at\": \"2024-10-01T11:27:17.601Z\",\n \"sellerid_id\": 1,\n \"common_user\": {\n \"id\": 1,\n \"email\": \"test@gmail.com\",\n \"fname\": \"test\",\n \"lname\": \"test\",\n \"business_name\": null\n },\n \"common_propertyimages\": []\n },\n {\n \"id\": 49,\n \"name\": \"Lagos\",\n \"state\": \"Lagos\",\n \"city\": \"Lagos\",\n \"address\": \"Main Street 123\",\n \"description\": \"5 Bedrooms and 3 Bathrooms\",\n \"squaremeters\": \"200\",\n \"property_type\": \"Apartment\",\n \"number_of_bathrooms\": 3,\n \"number_of_bedrooms\": 5,\n \"installment_duration\": \"8\",\n \"payment_frequency\": \"4\",\n \"down_payment\": \"200000\",\n \"installment_payment_price\": 1000,\n \"keywords\": [\n \"Apartment\",\n \"Lagos\"\n ],\n \"price\": 5000000,\n \"is_sold\": false,\n \"date_sold\": null,\n \"created_at\": \"2024-10-01T11:57:49.903Z\",\n \"updated_at\": \"2024-10-01T11:57:49.903Z\",\n \"sellerid_id\": 1,\n \"common_user\": {\n \"id\": 1,\n \"email\": \"test@gmail.com\",\n \"fname\": \"test\",\n \"lname\": \"test\",\n \"business_name\": null\n },\n \"common_propertyimages\": [\n {\n \"id\": 3,\n \"img\": \"http://express-api.propertyhive.com.ng/static/images/1727783869745.png\"\n },\n {\n \"id\": 4,\n \"img\": \"http://express-api.propertyhive.com.ng/static/images/1727783869746.png\"\n }\n ]\n },\n {\n \"id\": 50,\n \"name\": \"Lagos\",\n \"state\": \"Lagos\",\n \"city\": \"Lagos\",\n \"address\": \"Main Street 123\",\n \"description\": \"3 bathrooms and 5 bedrooms\",\n \"squaremeters\": \"200\",\n \"property_type\": \"Apartment\",\n \"number_of_bathrooms\": 3,\n \"number_of_bedrooms\": 5,\n \"installment_duration\": \"7\",\n \"payment_frequency\": \"20000\",\n \"down_payment\": \"1000\",\n \"installment_payment_price\": 1000,\n \"keywords\": [\n \"Apartment\",\n \"Lagos\"\n ],\n \"price\": 20000,\n \"is_sold\": false,\n \"date_sold\": null,\n \"created_at\": \"2024-10-01T11:58:58.682Z\",\n \"updated_at\": \"2024-10-01T11:58:58.682Z\",\n \"sellerid_id\": 1,\n \"common_user\": {\n \"id\": 1,\n \"email\": \"test@gmail.com\",\n \"fname\": \"test\",\n \"lname\": \"test\",\n \"business_name\": null\n },\n \"common_propertyimages\": []\n }\n ]\n}"}],"_postman_id":"0689ea04-fd24-4a91-87d4-a5814db0c74d"},{"name":"Search Properties","id":"4756a330-ef16-4249-9055-5ccdcee28d10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://express-api.propertyhive.com.ng/api/v1/properties/search/?query=\"\"","description":"Search Properties: Searches properties based on specified criteria.The Property Management section handles operations related to property listings and associated documents.
\nEndpoint: GET /api/v1/property-document/
This endpoint retrieves a specific document associated with a property.
\nHeaders:
\nAuthorization: BearerParameters:
\ndocument_id: The unique identifier of the property document.Response:
\n200 OK: Successfully retrieved the document
\n404 Not Found: Document not found
\n401 Unauthorized: Invalid or missing token
\nNotes:
\nThe exact structure of the response may vary based on the type of document.
\nAccess to certain documents may be restricted based on user roles or permissions.
\nThe Financial Operations section handles invoices and transactions.
\nEndpoint: GET /api/v1/invoice/
This endpoint retrieves details of a specific invoice.
\nHeaders:
\nAuthorization: BearerParameters:
\ninvoice_id: The unique identifier of the invoice.Response:
\n200 OK: Successfully retrieved invoice details
\n404 Not Found: Invoice not found
\n401 Unauthorized: Invalid or missing token
\nExample Response:
\n{\n \"invoice_id\": \"INV-001\",\n \"amount\": 1000.00,\n \"status\": \"paid\",\n \"issue_date\": \"2024-09-28\",\n \"due_date\": \"2024-10-28\",\n \"items\": [\n {\n \"description\": \"Property listing fee\",\n \"quantity\": 1,\n \"unit_price\": 1000.00\n }\n ]\n}\n\nNotes:
\nThe structure of the invoice may vary based on the specific requirements of Property Hive.
\nAccess to invoice details may be restricted to authorized personnel only.
\nEndpoint: GET /api/v1/transactions/
This endpoint retrieves a list of transactions associated with the authenticated company.
\nHeaders:
\nAuthorization: BearerQuery Parameters:
\npage: (optional) Page number for pagination
limit: (optional) Number of transactions per page
Response:
\n200 OK: Successfully retrieved transactions
\n401 Unauthorized: Invalid or missing token
\nExample Response:
\n{\n \"transactions\": [\n {\n \"transaction_id\": \"TRX-001\",\n \"amount\": 1000.00,\n \"type\": \"credit\",\n \"description\": \"Payment for Invoice INV-001\",\n \"date\": \"2024-09-28T14:30:00Z\"\n },\n {\n \"transaction_id\": \"TRX-002\",\n \"amount\": 500.00,\n \"type\": \"debit\",\n \"description\": \"Refund for cancelled listing\",\n \"date\": \"2024-09-27T10:15:00Z\"\n }\n ],\n \"total_count\": 50,\n \"page\": 1,\n \"limit\": 10\n}\n\nStartFragment
\nGet Transactions: Retrieves a list of transactions related to properties.EndFragment
\n","_postman_id":"cd8a37a4-037b-40e5-acf6-ca08dc8ad77e"},{"name":"Details","item":[{"name":"Get Invoice","id":"aa77b753-70eb-4167-82de-44c6bf1c57be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"GET Get Invoice: Retrieves an invoice for a specific transaction.
\n","urlObject":{"path":["api","v1","invoice","1"],"host":["https://api.propertyhive.com.ng/"],"query":[],"variable":[]}},"response":[{"id":"a784e2c1-5408-4831-af48-48b02949402c","name":"Invalid Invoice","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/invoice/1"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.24.0 (Ubuntu)"},{"key":"Date","value":"Sat, 28 Sep 2024 15:20:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"48"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Vary","value":"Cookie"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"No Invoice matches the given query.\"\n}"}],"_postman_id":"aa77b753-70eb-4167-82de-44c6bf1c57be"},{"name":"Get Transaction","id":"c60c1238-5a4c-481d-9822-bade2bf93e3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.propertyhive.com.ng/api/v1/transactions/:transactionId/","description":"GET Get Transaction: Retrieves the details of a specific transaction.
\n","urlObject":{"path":["v1","transactions",":transactionId",""],"host":["https://api.propertyhive.com.ng/api"],"query":[],"variable":[{"type":"any","value":"","key":"transactionId"}]}},"response":[],"_postman_id":"c60c1238-5a4c-481d-9822-bade2bf93e3c"},{"name":"Purchase Property","id":"be84793c-d242-4aad-a6f6-a3223b5aa175","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"userId\": 1,\r\n \"propertyId\": 86,\r\n \"paymentMethod\": \"Paystack\",\r\n \"totalAmount\": 1000000\r\n}","options":{"raw":{"language":"json"}}},"url":"https://express-api.propertyhive.com.ng/api/v1/purchase","urlObject":{"path":["v1","purchase"],"host":["https://express-api.propertyhive.com.ng/api"],"query":[],"variable":[]}},"response":[{"id":"c373b1d0-3049-4649-8ad0-43809cd2b020","name":"New Request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"userId\": 1,\r\n \"propertyId\": 86,\r\n \"paymentMethod\": \"Paystack\",\r\n \"totalAmount\": 1000000\r\n}","options":{"raw":{"language":"json"}}},"url":"https://express-api.propertyhive.com.ng/api/v1/purchase"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.24.0 (Ubuntu)"},{"key":"Date","value":"Wed, 09 Oct 2024 11:16:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"255"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"ff-yMCOGN+73G+/lWUM4aBNQQ1FkwQ\""}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"message\": \"Property purchased successfully\",\n \"data\": {\n \"id\": 4,\n \"status\": \"P\",\n \"payment_method\": \"Paystack\",\n \"total_amount\": 1000000,\n \"created_at\": \"2024-10-09T11:16:44.680Z\",\n \"updated_at\": \"2024-10-09T11:16:44.680Z\",\n \"propertyid_id\": 86,\n \"userid_id\": 1\n }\n}"}],"_postman_id":"be84793c-d242-4aad-a6f6-a3223b5aa175"}],"id":"0240a03f-a3a0-4289-bf20-38fe1fed88a9","_postman_id":"0240a03f-a3a0-4289-bf20-38fe1fed88a9","description":""}],"id":"4d4d1b84-6c5d-4bb5-aa26-8263f529d131","description":"The Financial Operations section handles invoices and transactions.
\nEndpoint: GET /api/v1/invoice/
This endpoint retrieves details of a specific invoice.
\nHeaders:
\nAuthorization: BearerParameters:
\ninvoice_id: The unique identifier of the invoice.Response:
\n200 OK: Successfully retrieved invoice details
\n404 Not Found: Invoice not found
\n401 Unauthorized: Invalid or missing token
\nExample Response:
\n{\n \"invoice_id\": \"INV-001\",\n \"amount\": 1000.00,\n \"status\": \"paid\",\n \"issue_date\": \"2024-09-28\",\n \"due_date\": \"2024-10-28\",\n \"items\": [\n {\n \"description\": \"Property listing fee\",\n \"quantity\": 1,\n \"unit_price\": 1000.00\n }\n ]\n}\n\nNotes:
\nThe structure of the invoice may vary based on the specific requirements of Property Hive.
\nAccess to invoice details may be restricted to authorized personnel only.
\nEndpoint: GET /api/v1/transactions/
This endpoint retrieves a list of transactions associated with the authenticated company.
\nHeaders:
\nAuthorization: BearerQuery Parameters:
\npage: (optional) Page number for pagination
limit: (optional) Number of transactions per page
Response:
\n200 OK: Successfully retrieved transactions
\n401 Unauthorized: Invalid or missing token
\nExample Response:
\n{\n \"transactions\": [\n {\n \"transaction_id\": \"TRX-001\",\n \"amount\": 1000.00,\n \"type\": \"credit\",\n \"description\": \"Payment for Invoice INV-001\",\n \"date\": \"2024-09-28T14:30:00Z\"\n },\n {\n \"transaction_id\": \"TRX-002\",\n \"amount\": 500.00,\n \"type\": \"debit\",\n \"description\": \"Refund for cancelled listing\",\n \"date\": \"2024-09-27T10:15:00Z\"\n }\n ],\n \"total_count\": 50,\n \"page\": 1,\n \"limit\": 10\n}\n\nAuthentication and User Management
\nCompany registration
\nUser login and logout
\nPassword management (including forgot and reset password functionalities)
\nProfile Management
\nCompany profile creation and updates
\nUser profile retrieval and management
\nProperty Management
\nProperty listing and information retrieval
\n(Potential future features for property creation, updating, and deletion)
\nFinancial Operations
\nInvoice generation and retrieval
\nTransaction tracking
\nNotes:
\nTransactions are typically paginated to manage large datasets efficiently.
\nThe response includes metadata about pagination to help navigate through the results.
\nRate Limiting: Many endpoints, especially those dealing with authentication and password reset, may have rate limiting to prevent abuse. Clients should be prepared to handle 429 Too Many Requests responses.
\nError Handling: All endpoints should return appropriate HTTP status codes and error messages. Clients should be prepared to handle and present these errors meaningfully to the end-user.
\nData Validation: Server-side validation is crucial, but client-side validation can improve user experience by catching obvious errors before submission.
\nSecurity: All endpoints require authentication via Bearer token, except for registration, login, and password reset initiation. Ensure tokens are stored securely and transmitted only over HTTPS.
\nPagination: For endpoints that return lists (e.g., transactions), implement pagination to manage large datasets efficiently.
\nTimezone Handling: Ensure all date-time fields are in a consistent format, preferably UTC, and clients handle timezone conversions appropriately.
\nCORS (Cross-Origin Resource Sharing): If the API is to be accessed from web browsers, ensure proper CORS headers are set up to allow requests from authorized domains.
\nVersioning: The current version (v1) is specified in the URL. Future updates should consider backward compatibility or clear migration paths for clients.
\nThis extensive breakdown of the Property Hive API Version 1 provides a comprehensive guide for developers integrating with the platform. It covers authentication flows, profile management, property-related operations, and financial tracking, offering insights into request/response structures, authentication requirements, and best practices for each endpoint.
\n","_postman_id":"68f326f3-1b37-4260-bfa8-0611ba9debb7"}],"event":[{"listen":"prerequest","script":{"id":"ff5a7ef1-96c3-4fe5-b7a3-77d0d3c35835","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"c09f942b-3e78-4bab-8bbb-aeb037b13167","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"base_url_1","value":"https://api.propertyhive.com.ng/","type":"string"},{"key":"base_url_2","value":"https://express-api.propertyhive.com.ng/","type":"string"}]}