List all property listing statuses

> ## 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 property listing statuses

Returns a list of property listing statuses from your organization.
                         If you have an MLS API plan, you can also get your collaborators' listing statuses for all their published properties and the properties unpublished in the last month.

# 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": {
    "/listing_statuses": {
      "get": {
        "tags": [
          "ListingStatuses"
        ],
        "summary": "List all property listing statuses",
        "description": "Returns a list of property listing statuses from your organization.\n                         If you have an MLS API plan, you can also get your collaborators' listing statuses for all their published properties and the properties unpublished in the last month.",
        "parameters": [
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "description": "Max results per page (Maximum: 100)",
            "schema": {
              "type": "integer",
              "maximum": 100,
              "default": 20
            }
          },
          {
            "in": "query",
            "name": "search",
            "required": false,
            "style": "deepObject",
            "explode": true,
            "schema": {
              "$ref": "#/components/schemas/ListingStatusSearchParams"
            }
          },
          {
            "$ref": "#/components/parameters/listing_statuses_search_statuses"
          },
          {
            "$ref": "#/components/parameters/listing_statuses_search_collaborator_listings"
          },
          {
            "$ref": "#/components/parameters/listing_statuses_search_agency_id"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful listing status list request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListingStatusList"
                }
              }
            }
          },
          "400": {
            "description": "At least one search param has an invalid format.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "errors": {
                      "type": "object",
                      "example": {
                        "updated_at": [
                          "has an invalid format"
                        ]
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          }
        }
      }
    }
  },
  "components": {
    "parameters": {
      "listing_statuses_search_statuses": {
        "in": "query",
        "name": "search[statuses][]",
        "required": false,
        "explode": true,
        "schema": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "published",
              "not_published",
              "reserved",
              "sold",
              "rented",
              "suspended",
              "flagged",
              "disapproved"
            ]
          }
        }
      },
      "listing_statuses_search_collaborator_listings": {
        "in": "query",
        "name": "search[include_collaborator_listings]",
        "required": false,
        "description": "Set this parameter to true if you have an MLS API Plan and you want to include your collaborators' listing statuses. All published properties will be included but only properties unpublished in the last month will be shown.",
        "schema": {
          "type": "boolean"
        }
      },
      "listing_statuses_search_agency_id": {
        "in": "query",
        "name": "search[agency_id]",
        "required": false,
        "description": "Only works if you have an MLS API plan and include_collaborator_listings is set to true. This parameter allows you to filter listings from one specific agency.",
        "example": 123,
        "schema": {
          "type": "integer",
          "default": ""
        }
      },
      "page": {
        "name": "page",
        "in": "query",
        "required": false,
        "description": "Content's page",
        "schema": {
          "type": "integer",
          "default": 1
        }
      }
    },
    "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": {
      "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
          }
        }
      },
      "ListingStatusList": {
        "properties": {
          "pagination": {
            "$ref": "#/components/schemas/Pagination"
          },
          "content": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ListingStatus"
            }
          }
        }
      },
      "ListingStatus": {
        "properties": {
          "public_id": {
            "type": "string",
            "example": "EB-XXX123"
          },
          "status": {
            "type": "string",
            "enum": [
              "published",
              "sold",
              "rented",
              "reserved",
              "suspended",
              "not_published"
            ],
            "example": "not_published",
            "description": "The listing status."
          },
          "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."
          }
        }
      }
    },
    "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
    }
  }
}
```