---
title: "Get Custom POI Info"
method: GET
path: "/v1/poi/custom-poi/{id}"
tags: ["Manage POIs"]
---

# Get Custom POI Info

`GET /v1/poi/custom-poi/{id}`

The Get Custom POI Info service can be used to retrieve information regarding any of your <<glossary:Custom POI>>s, by providing its id.</br> If the requested Custom POI is newly created, this endpoint will respond with the following statuses:</br>
- **HTTP code = 200**: The full response for the Get Custom POI is provided.</br> - **HTTP code = 202**: The creation process is still in progress.</br> - **HTTP code = 404**: The POI does not exist, indicating a failure in the creation process. Please retry creating the custom POI.</br> - **HTTP code = 500**: Server error.

## Path parameters

- `id` string, required

## Response `200`

200 response

- CustomPoiInfoGetResponse
  - `apiId` string — Placer API Entity Id
  - `name` string — Entity Name
  - `entityId` string — Entity ID
  - `entityType` 'venue' | 'complex' | 'chain' — Entity Type (i.e. venue, complex etc.)
  - `categoryInfo` CategoryInfo — Property’s categorization
    - `category` string
    - `group` string
    - `subCategory` string
  - `address` Address
    - `city` string — Entity City
    - `state` string — Entity State
    - `countryCode` string — Entity Country Code
    - `streetName` string — Entity Street Name
    - `formattedAddress` string — Entity Address
    - `shortFormattedAddress` string — Entity Address
    - `zipCode` string — Entity Zip Code
  - `isFlagged` boolean — The Entity Data Is Incomplete
  - `regions` object — The regions in which the property is included
    - `dma` object — The Entity Designated Market Area
      - `code` string
      - `name` string
    - `state` object — Entity State
      - `code` string
      - `name` string
    - `cbsa` object — The Entity Core-Based Statistical Areas
      - `code` string
      - `name` string
  - `placerUrl` string
  - `parentChains` object
  - `parentTags` object
  - `isPermitted` boolean — This flag indicates whether the account is permitted to generate/request reports on this entity or not.
  - `regionType` string — The regions which the entity is associated with. Supported regions are: 'nationwide', 'state', 'dma' & 'cbsa'. Relevant only for chain.
  - `regionCode` string — The code defining the region (e.g. The state of Arizona -> 'AZ', nationwide -> 'US'). Relevant only for chain.
  - `storeId` string — The identification of a venue. Relevant only for chain's venues.

## Other responses

- `400` — 400 Bad Request
- `403` — 403 Permission Denied
- `500` — 500 Internal Server Error

---

[API](https://skmtc.net/placer/apis/papi.md) · [All operations](https://skmtc.net/placer/apis/papi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/placer/papi/revisions/e317a0bbbd11/schema)