List all contact requests > ## Documentation Index > Fetch the complete documentation index at: https://easybroker-staging.readme.io/llms.txt > Use this file to discover all available pages before exploring further. # List all contact requests Returns a list of the contact requests in a given period or for a specific property, if no parameters are provided all the contact requests will be returned # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "version": "1.0", "title": "EasyBroker API", "description": "API for accessing and working with EasyBroker accounts. To get started click the Authorize button below and enter your API key." }, "externalDocs": { "description": "View the getting started guide in Spanish", "url": "https://dev.easybroker.com/docs/api-de-easybroker" }, "security": [ { "ApiKeyAuth": [] } ], "servers": [ { "url": "https://api.stagingeb.com/v1", "description": "API URL" } ], "paths": { "/contact_requests": { "get": { "tags": [ "Contact Requests" ], "summary": "List all contact requests", "description": "Returns a list of the contact requests in a given period or for a specific property, if no parameters are provided all the contact requests will be returned", "parameters": [ { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/happened_after" }, { "$ref": "#/components/parameters/happened_before" }, { "$ref": "#/components/parameters/property_id" } ], "responses": { "200": { "description": "Successful contact requests list request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactRequestList" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } } } } }, "components": { "parameters": { "happened_after": { "name": "happened_after", "in": "query", "required": false, "description": "Contact requests created after the given date", "example": "2020-03-01T23:26:53.402Z", "schema": { "type": "string", "format": "date-time" } }, "happened_before": { "name": "happened_before", "in": "query", "required": false, "description": "Contact requests created before the given date", "example": "2025-03-01T23:26:53.402Z", "schema": { "type": "string", "format": "date-time" } }, "property_id": { "name": "property_id", "in": "query", "required": false, "description": "The ID of a property to retrieve the contact requests for", "schema": { "type": "string" } }, "page": { "name": "page", "in": "query", "required": false, "description": "Content's page", "schema": { "type": "integer", "default": 1 } }, "limit": { "name": "limit", "in": "query", "required": false, "description": "Max results per page (Maximum: 50)", "schema": { "type": "integer", "maximum": 50, "default": 20 } } }, "responses": { "UnauthorizedError": { "description": "API key is missing or invalid", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Your API key is invalid" } } } } } } }, "schemas": { "ContactRequestList": { "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/ContactRequestForList" } } } }, "ContactRequestForList": { "allOf": [ { "properties": { "id": { "type": "integer", "example": 123 }, "name": { "type": "string", "example": "John Smith" }, "phone": { "type": "string", "example": "5559090909" }, "email": { "type": "string", "example": "mail@example.com" }, "contact_id": { "nullable": true, "type": "integer", "example": 123, "description": "ID of the contact associated with this request. Can be null when the contact request was created by an agent on behalf of an unregistered lead; in that case the name, phone, and email fields reflect the agent who created the request." }, "property_id": { "type": "string", "example": "EB-XXXX01" }, "message": { "type": "string", "example": "I'm interested in this property. Please contact me." }, "source": { "type": "string", "example": "mydomain.com" }, "happened_at": { "type": "string", "format": "date-time", "example": "2020-03-01T23:26:53.402Z" } } } ] }, "Pagination": { "required": [ "limit", "page", "total,", "next_page" ], "properties": { "limit": { "type": "integer", "format": "int64", "maximum": 50, "example": 20 }, "page": { "type": "integer", "format": "int64", "example": 1 }, "total": { "type": "integer", "format": "int64", "example": 1 }, "next_page": { "type": "string", "example": null } } } }, "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-Authorization", "description": "You can find your API key in the general settings section of your EasyBroker account. It's only accessible for account administrators." } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true }, "_id": { "buffer": { "0": 99, "1": 142, "2": 110, "3": 111, "4": 217, "5": 194, "6": 135, "7": 0, "8": 24, "9": 185, "10": 196, "11": 37 } } } ```