# One location, with this month's pace **Not live yet:** the v1 API and its hosts are not open. See [Sandbox](/get-started/sandbox/). GET /locations/{id} Select code sampleFetchcURL ```js const url = 'https://api.creatorain.com/v1/locations/loc_3f2a9c1e5b7d4a6f8e0c2b4d6f8a0c2e'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```sh curl --request GET \ --url https://api.creatorain.com/v1/locations/loc_3f2a9c1e5b7d4a6f8e0c2b4d6f8a0c2e \ --header 'Authorization: Bearer ' ``` - Live (crp\_live\_ keys) - Sandbox (crp\_test\_ keys) Scope `read`. The location as in the list, plus `month`: this store-local month’s planned videos, the visits booked and done, and the videos posted (stated at the store, the ones the bill counts). `month` is null when it cannot be counted. A malformed id, an unknown one and another account’s location are the same `404 not_found`. No query parameters. ## Authorizations - **[bearerAuth](/reference/#bearerauth)** ## Parameters ### Path Parameters **id** required string /^loc\_\[0-9a-f\]{32}$/ #### Example ``` loc_3f2a9c1e5b7d4a6f8e0c2b4d6f8a0c2e ``` ## Responses ### 200 The location. Media typeapplication/json object **object** required string Allowed values: location **id** required string **livemode** required boolean **name** required string nullable **address** required string nullable **plan** required string Allowed values: paid free **videos\_per\_month** required integer nullable **term\_months** required integer nullable **price\_per\_video\_cents** required integer nullable **currency** required string Allowed values: USD **deposit** required object **cents** required The quote at create (half of month one; free 0). Not what is due now. integer nullable **charged** required boolean **state** required The network state the app’s Network page shows. string Allowed values: payment\_failed ended paused needs\_hours on\_hold awaiting\_payment full\_this\_month accepting **status** required string Allowed values: active paused ended **held** required Held by the API hold until CreatoRain releases it to recruiting. boolean **accepting** required True exactly when state is accepting. boolean **term\_ends\_on** required string format: date nullable **created\_at** required RFC 3339, UTC. string format: date-time **month** required object **month** required The store-local month. string **planned** required Videos a month in force this month. integer nullable **allowance** required integer nullable **booked** required Visits this month that are booked or done. integer **visited** required Visits this month that happened. integer **posted** required Videos stated at this location that went live this month. integer **full** required Held back until next month by the pacing. boolean **full\_until** required string format: date-time nullable #### Example ```json { "object": "location", "id": "loc_3f2a9c1e5b7d4a6f8e0c2b4d6f8a0c2e", "plan": "paid", "currency": "USD", "deposit": { "charged": false }, "state": "payment_failed", "status": "active", "month": { "month": "2026-11" } } ``` #### Headers **Request-Id** string format: uuid This request’s id. Equal to error.request\_id; quote it to support. **RateLimit-Limit** integer ##### Example ```json 600 ``` Requests allowed in the current minute for this workspace (600). **RateLimit-Remaining** integer Requests left in the current minute for this workspace. **RateLimit-Reset** integer Seconds until the current window resets. ### 400 Parameter\_invalid (with `field`) or invalid\_json. Media typeapplication/json object **error** required object **type** required string Allowed values: invalid\_request\_error authentication\_error permission\_error idempotency\_error rate\_limit\_error api\_error **code** required string Allowed values: parameter\_invalid invalid\_json idempotency\_key\_invalid idempotency\_key\_required customization\_not\_supported videos\_per\_month\_out\_of\_range batch\_invalid terms\_not\_accepted invalid\_key test\_key\_on\_live live\_key\_on\_sandbox insufficient\_balance scope\_missing forbidden\_ip forbidden live\_key\_requires\_top\_up limit\_raise\_requires\_dashboard not\_found idempotency\_conflict idempotency\_in\_progress conflict location\_already\_in\_network external\_id\_conflict dispute\_open request\_too\_large address\_not\_verified not\_food\_business metro\_not\_served package\_not\_available account\_location\_limit commit\_limit\_exceeded top\_up\_exceeds\_feasible no\_saved\_card rate\_limited quota\_exceeded slow\_down internal\_error service\_unavailable **message** required string **field** The request field at fault string **doc\_url** required string format: uri **request\_id** required string format: uuid **items** Batch\_invalid only. Every refused location, by its index in the request. Array