در حال بارگذاری…
Represents a gym entity with all its attributes, relationships, and status information.
| Field | Type | Description |
|---|---|---|
| id | int | Unique identifier for the gym |
| name | string | Name of the gym |
| address | string | Address of the gym |
| location_lat | float | Latitude coordinate |
| location_lng | float | Longitude coordinate |
| is_active | bool | Whether the gym is active |
| description | string |
| Description of the gym |
| created_at | string (datetime) | Creation timestamp |
| updated_at | string (datetime) | Last update timestamp |
| show_crowd | bool | Whether crowd information is displayed |
| user_id | int | User ID of the gym owner |
| crowd | int|null | Current crowd count (null if show_crowd is false) |
| city | City Resource | City where the gym is located (see here) |
| majors | Major Resource[] | List of majors associated with the gym (see here) |
| working_periods | Working Period[] | List of working periods (see here) |
| working_status | object|null | Current working status (see below) |
| boost | object|null | Marketing boost info (see here) |
| media | Media Resource[] | List of media items (see here) |
| rating_count | int | Number of ratings |
| rating_average | float | Average rating |
| gym_license_image | string|null | Restricted. Download link for the license document, or null if none is uploaded |
| gym_license_approved | bool|null | Restricted. true approved, false rejected, null pending review |
| gym_license_rejection_reason | string|null | Restricted. Why the license was rejected |
| owner | object|absent | Restricted. Nested User resource of the gym owner (see here); phone and email inside it follow the User resource's own rule (users.view_all or self) |
Restricted fields. The three
gym_license_*fields andownerare only present for the gym's owner (user_id) and for viewers holdinggyms.view_all. For everyone else, including anonymous callers of the public GET /api/v1/gyms, the keys are absent from the response entirely, not null.The license document is stored as a media row with
purpose=gym_license. Such rows are excluded from themediaarray above and are not publicly downloadable: GET /api/v1/media/{media}/{filename} returns403for them unless the caller is the gym owner or holdsgyms.view_all.
{
"id": 123,
"name": "Iron Paradise",
"address": "123 Main St",
"location_lat": 35.6892,
"location_lng": 51.3890,
"is_active": true,
"description": "A premium gym with modern equipment.",
"created_at": "2023-01-01 10:00:00",
"updated_at": "2023-01-01 10:00:00",
"show_crowd": false,
"user_id": 5,
"crowd": null,
"city": {
"id": 5,
"name": "Tehran",
"translated_name": "Tehran",
"location_lat": 35.6944,
"location_lng": 51.4215,
"state": {
"id": 1,
"name": "Tehran Province"
}
},
"majors": [
{ "id": 1, "title": "Bodybuilding" },
{ "id": 2, "title": "Crossfit" }
],
"working_periods": [
{
"id": 1,
"gym_id": 123,
"day": "monday",
"gender": "women",
"opens_at": "07:00",
"closes_at": "23:30",
"description": "Morning shift",
"is_exception": false,
"exception_start_date": null,
"exception_end_date": null
}
],
"working_status": {
"current": {
"gender": "genderless",
"opens_at": "08:30",
"closes_at": "23:00"
}
},
"boost": null,
"media": [
{
"id": 10,
"attachable_type": "App\\Models\\Gyms\\Gym",
"attachable_id": 123,
"link": "https://example.com/media/10.jpg"
}
],
"rating_count": 12,
"rating_average": 4.5,
"owner": {
"id": 5,
"first_name": "Sara",
"last_name": "Ahmadi",
"username": "sara.ahmadi"
}
}
The example shows a privileged viewer. For everyone else
ownerand the threegym_license_*keys are absent from the object entirely.owneris a full User resource: the fields inside it are gated in turn by the User Resource's own rule, so a viewer withgyms.view_allbut notusers.view_allsees the owner withoutphoneor
The working_status field provides information about the gym's current operational status for the day. It can be:
null: The gym is closed for the day.current: The gym is currently open.next: The gym is currently closed but will open later today.last: The gym was open earlier but is now closed for the day.Each status object contains:
{
"gender": "genderless",
"opens_at": "08:30",
"closes_at": "23:00"
}
The crowd field shows the current number of people checked in at the gym, calculated from subscription check-ins/outs. If show_crowd is false, this value will be null.