YOyoco
Locations

Fetch a location

Changed on

Fetch a location

Required scope: business/locations:read

get/v1/locations/{location_id}

Request

  • Base URL
    https://api.yoco.com
  • Auth
    HTTP bearer

Path parameters

location_idstring required

The unique identifier of the location.

Response

Successful Response

idstring required

The unique identifier of the location.

namestring required

The name of the location.

status'active' | 'deactivating' | 'inactive' required
created_atstring date-time required

The location creation date and time in ISO 8601 format.

updated_atstring date-time nullable required

The date and time the location was last modified in ISO 8601 format.

Example response

{
  "created_at": "2024-11-19T15:27:02+00:00",
  "id": "1743683416648-616bc018-c572-430b-9c07-4e813ed03eb4",
  "name": "Main Store",
  "status": "active",
  "updated_at": "2024-11-19T16:27:23+00:00"
}

Changes