> ## 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 listing statuses for properties. Returns a paginated light-weight list of listing statuses which can be used for synchronizing new properties, property updates and status changes. The pagination limit is 100 for this endpoint to assist in faster syncs. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "version": "1.0", "title": "App Integration API", "description": "API for EasyBroker's partners. To get started click the Authorize button below and enter your API key." }, "security": [ { "ApiKeyAuth": [] } ], "servers": [ { "url": "https://api.stagingeb.com/v1/integration_partners", "description": "API URL" } ], "paths": { "/listing_statuses": { "get": { "tags": [ "ListingStatuses" ], "summary": "List all listing statuses for properties.", "description": "Returns a paginated light-weight list of listing statuses which can be used for synchronizing new properties, property updates and status changes. The pagination limit is 100 for this endpoint to assist in faster syncs.", "parameters": [ { "$ref": "#/components/parameters/country_code" }, { "$ref": "#/components/parameters/page" }, { "name": "limit", "in": "query", "required": false, "description": "Max results per page (Maximum: 100)", "schema": { "type": "integer", "maximum": 100, "default": 100 } }, { "name": "search", "in": "query", "required": false, "style": "deepObject", "explode": true, "schema": { "$ref": "#/components/schemas/ListingStatusSearchParams" } }, { "$ref": "#/components/parameters/listing_statuses_search_published" }, { "$ref": "#/components/parameters/listing_statuses_search_agency_id" }, { "$ref": "#/components/parameters/listing_statuses_search_property_types" } ], "responses": { "200": { "description": "Successful listing status list request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListingStatusList" } } } }, "400": { "$ref": "#/components/responses/InvalidFormatError" }, "401": { "$ref": "#/components/responses/UnauthorizedError" } } } } }, "components": { "responses": { "UnauthorizedError": { "description": "API key is missing or invalid, or a restricted country was selected", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "Your API key is invalid." } } } } } }, "InvalidFormatError": { "description": "At least one param has an invalid format.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": { "updated_after": [ "has an invalid format" ] } } } } } } } }, "parameters": { "page": { "name": "page", "in": "query", "required": false, "description": "Content's page", "schema": { "type": "integer", "default": 1 } }, "listing_statuses_search_agency_id": { "in": "query", "name": "search[agency_id]", "required": false, "description": "This parameter allows you to filter listings from one specific agency.", "schema": { "type": "integer", "default": "" } }, "listing_statuses_search_published": { "in": "query", "name": "search[published]", "required": false, "description": "Allows you to filter published or unpublished properties, leave it blank if you want to list both.", "schema": { "example": true, "type": "boolean" } }, "listing_statuses_search_property_types": { "in": "query", "name": "search[property_types][]", "required": false, "explode": true, "schema": { "type": "array", "items": { "type": "string", "example": "apartment" } } }, "country_code": { "name": "Country-Code", "in": "header", "required": true, "description": "This header is mandatory and will be used to filter the resources", "schema": { "type": "string", "enum": [ "MX", "CL", "DO", "GT", "AR", "BR", "CO", "UY", "AF", "AL", "DZ", "AS", "AD", "AO", "AI", "AG", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "IO", "VG", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CN", "CX", "CC", "KM", "CD", "CG", "CK", "CR", "CI", "CU", "CY", "CZ", "DK", "DJ", "DM", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FO", "FK", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HR", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IL", "IT", "JM", "JP", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SK", "SI", "SB", "SO", "ZA", "ES", "LK", "SH", "KN", "LC", "PM", "VC", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "VI", "UG", "UA", "AE", "GB", "UM", "US", "UZ", "VU", "VE", "VN", "WF", "EH", "YE", "ZM", "ZW" ], "example": "MX" } } }, "schemas": { "ListingStatusList": { "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" }, "content": { "type": "array", "items": { "$ref": "#/components/schemas/ListingStatus" } } } }, "ListingStatus": { "properties": { "public_id": { "type": "string", "example": "EB-XXX123" }, "published": { "type": "boolean", "example": true, "description": "Indicates whether this property should be published in your website or not." }, "updated_at": { "type": "string", "format": "date-time", "example": "2020-03-01T23:26:53.402Z", "description": "The last time the property was updated." } } }, "ListingStatusSearchParams": { "type": "object", "description": "Optional search parameters.", "properties": { "updated_after": { "type": "string", "format": "date-time", "example": "2020-03-01T23:26:53.402Z", "description": "Retrieve listing statuses for properties updated after the given time." }, "updated_before": { "type": "string", "format": "date-time", "example": "2020-03-01T23:26:53.402Z", "description": "Retrieve listing statuses for properties updated before the given time." } } }, "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": "Keys for this API are only available for our partners." } } }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true }, "_id": { "buffer": { "0": 99, "1": 137, "2": 61, "3": 110, "4": 171, "5": 138, "6": 160, "7": 0, "8": 29, "9": 31, "10": 125, "11": 97 } } } ```