# List places ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /v1/locations/places/list: post: summary: List places deprecated: false description: '' tags: - API Reference/Reporting API/Geo API parameters: - name: per_page in: query description: >- Number of results to be returned per request. See: [API Pagination](doc-341638) example: 10 schema: type: integer default: '10' - name: page_no in: query description: 'Number of results page. See: [API Pagination](doc-341638)' example: 1 schema: type: integer minimum: 1 default: '1' - name: Content-Type in: header description: '[Details](doc-341635)' required: true example: application/json schema: type: string default: application/json const: application/json - name: X-User-Agent in: header description: Arbitrary identifier of your client. [Details](doc-341635) required: true example: '{{X_USER_AGENT}}' schema: type: string default: '{{X_USER_AGENT}}' - name: X-Product-Name in: header description: API Product for API context. [Details](doc-341635) required: true example: '{{PRODUCT_NAME}}' schema: type: string default: '{{PRODUCT_NAME}}' - name: Authorization in: header description: '[Member](doc-342129) or [User](doc-342130) Authorization.' required: false example: Bearer {{_OAUTH_TOKEN}} schema: type: string default: Bearer {{_OAUTH_TOKEN}} - name: X-Client-Authorization in: header description: '[Token](doc-342128) Authorization.' example: '{{API_TOKEN}}' schema: type: string default: '{{API_TOKEN}}' requestBody: content: application/json: schema: type: object properties: country: type: string description: 'country code ' x-apidog-mock: '{{$location.countryCode}}' precision: type: string enum: - city - postcode x-apidog-enum: - value: city name: '' description: '' - value: postcode name: '' description: '' description: place precision type ids: type: array items: &ref_0 $ref: '#/components/schemas/id' description: array of place id cities: type: array items: type: string x-apidog-mock: '{{$location.city}}' description: array of city names postcodes: type: array items: type: string x-apidog-mock: '{{$location.zipCode}}' description: array of postcodes radius: type: integer description: for fitlering by distance number in meters x-apidog-mock: '{{$number.int(min=1)}}' latitude: type: number description: for fitlering by distance latitude of radius center x-apidog-mock: '{{$location.latitude}}' longitude: type: number description: for fitlering by distance longitude of radius center x-apidog-mock: '{{$location.longitude}}' x-apidog-orders: - country - precision - ids - cities - postcodes - radius - latitude - longitude x-apidog-ignore-properties: [] responses: '200': description: '' content: application/json: schema: type: object properties: places: type: array items: $ref: '#/components/schemas/Place' pagination_info: $ref: '#/components/schemas/PaginationInfo' x-apidog-orders: - places - pagination_info required: - places - pagination_info x-apidog-refs: {} x-apidog-ignore-properties: [] example: places: - id: 1 precision: city country: 'NO' postcode: '51912' city: South Laurettastead district: Fort Felix state: Oregon suburb: Velma Point county: Clay County latitude: '-25.3364' longitude: '-152.5065' polygon: null created_at: '2022-11-05T16:25:58.099512Z' updated_at: '2022-11-15T16:25:58.099512Z' - precision: city country: 'NO' postcode: '02962' city: Lake Maximillianfort district: East Mya state: North Dakota suburb: Kaela Glens county: Lincoln County latitude: '-14.3785' longitude: '-141.699' polygon: - - 25.9829 - 83.5864 - - -52.6075 - -88.4505 pagination_info: total_count: 2050 headers: {} x-apidog-name: Success '422': description: '' content: application/json: schema: type: object properties: error: type: string examples: - Invalid parameters const: Invalid parameters details: type: object properties: {} x-apidog-orders: [] description: 'See: [Params Validation](doc-341637)' additionalProperties: true x-apidog-ignore-properties: [] required: - error - details x-apidog-orders: - error - details x-apidog-ignore-properties: [] headers: {} x-apidog-name: Invalid Parameters security: [] x-apidog-folder: API Reference/Reporting API/Geo API x-apidog-status: pending x-run-in-apidog: https://app.eu.apidog.com/web/project/346351/apis/api-3667048-run components: schemas: id: type: integer description: Primary identifier of the record format: uint64 readOnly: true examples: - 1 x-apidog-folder: '' PaginationInfo: type: object properties: count: type: integer description: Actual number of results returned in request readOnly: true examples: - 1000 total_count: type: integer description: Number of all available results minimum: 1 examples: - 2050 per_page: type: integer description: Number of results returned per request readOnly: true examples: - 1000 total_pages: type: integer description: Number of all available pages readOnly: true examples: - 3 current_page: type: integer readOnly: true examples: - 1 next_page: type: integer description: Next available page (null when it's a last page) readOnly: true examples: - 2 nullable: true prev_page: type: integer description: Next available page (null when it's a first page) readOnly: true examples: - null nullable: true is_first_page: type: boolean readOnly: true examples: - true is_last_page: type: boolean readOnly: true examples: - false is_out_of_range: type: boolean description: Is given `per_page` param out of range? readOnly: true examples: - false offset: type: integer readOnly: true examples: - 0 required: - count - total_count - per_page - total_pages - current_page - next_page - prev_page - is_first_page - is_last_page - is_out_of_range - offset x-apidog-orders: - count - total_count - per_page - total_pages - current_page - next_page - prev_page - is_first_page - is_last_page - is_out_of_range - offset readOnly: true x-apidog-ignore-properties: [] nullable: true x-apidog-folder: '' Place: type: object properties: id: *ref_0 precision: type: string enum: - city - postcode x-apidog-enum: - value: city name: '' description: '' - value: postcode name: '' description: '' country: $ref: '#/components/schemas/country' postcode: type: string x-apidog-mock: '{{$location.zipCode}}' nullable: true city: type: string x-apidog-mock: '{{$location.city}}' nullable: true district: type: string x-apidog-mock: '{{$location.city}}' nullable: true state: type: string x-apidog-mock: '{{$location.state}}' nullable: true suburb: type: string x-apidog-mock: '{{$location.street}}' nullable: true county: type: string x-apidog-mock: '{{$location.county}}' nullable: true latitude: type: string x-apidog-mock: '{{$location.latitude}}' longitude: type: string x-apidog-mock: '{{$location.longitude}}' polygon: type: array items: type: array items: type: number x-apidog-mock: '{{$location.latitude}}' minItems: 2 maxItems: 2 nullable: true created_at: $ref: '#/components/schemas/date_time.created_at' updated_at: $ref: '#/components/schemas/date_time.updated_at' x-apidog-orders: - id - precision - country - postcode - city - district - state - suburb - county - latitude - longitude - polygon - created_at - updated_at required: - id - precision - country - postcode - city - district - state - suburb - county - latitude - longitude - polygon - created_at - updated_at x-apidog-ignore-properties: [] x-apidog-folder: '' date_time.updated_at: type: string description: Time of the last record update format: date-time examples: - '2022-11-15T16:25:58.099512Z' readOnly: true x-apidog-folder: '' date_time.created_at: type: string description: Time of record creation format: date-time examples: - '2022-11-05T16:25:58.099512Z' readOnly: true x-apidog-folder: '' country: type: string description: '[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)' examples: - 'NO' x-apidog-folder: '' securitySchemes: {} servers: - url: https://api.mpc.dev.placewise.com description: Staging security: [] ```