Easyteam Embedded
GuidesAPIWhite-Label UIs
GuidesAPIWhite-Label UIs
  1. Locations
  • Getting started
    • Authentication
      • Authentication Quick Start
      • Exchange Token
    • Permissions
      • Create Access Role
      • List Access Roles
      • Get Access Role
      • Update Access Role
      • Delete Access Role
  • Organizations
    • List Organizations
    • Get Organization
    • Get Organization by External ID
    • Create Organization
    • Create Organization With Defaults
    • Sync Locations
    • Update Organization
    • Delete Organization
    • Delete Organization by External ID
  • Locations
    • Retrieve all locations
      GET
    • Retrieve a specific location
      GET
    • Retrieve a specific location by external ID
      GET
    • Create a new location
      POST
    • Update a specific location
      PATCH
    • Delete a specific location
      DELETE
    • Retrieve timesheets for a specific location
      GET
    • Retrieve staff members for a specific location
      GET
  • Staff members
    • Retrieve all staff members
    • Retrieve a specific staff member
    • Retrieve a staff member by external ID
    • Retrieve staff member locations
    • Create a new staff member
    • Synchronize staff members
    • Update a specific staff member
    • Delete a specific staff member
  • Roles
    • Create a new role
    • Retrieve all roles
    • Retrieve a specific role
    • Update a specific role
    • Delete a specific role
  • Time Tracking
    • Retrieve staff member shift state
    • Clock in a staff member
    • Clock out a staff member
  • Breaks
    • Retrieve break types for a specific location
    • Create a new break type for a location
    • Update a specific break type
    • Delete a specific break type
  • Timesheets
    • Retrieve all shifts
    • Retrieve a specific shift
    • Export shifts
    • Generate per-employee shift reports
    • Generate shift reports
    • Create a new shift
    • Update a specific shift
    • Delete a specific shift
    • Delete all shifts on a specific date
  • Time Off
    • Retrieve all time off policies
    • Retrieve a policy
    • List all policy types
    • Create Policy
    • Update Policy
    • Activate Policy
    • Deactivate Policy
    • Get Worker Policies
    • List all worker policies
  • Requests and Approval
    • Get Time-Off Request
    • List Time-Offs
    • Create a time off request
    • Update Time-Off Request
    • Delete Time-Off Request
    • Approve Time-Off Request
    • Decline Time-Off Request
  • Shift Notes
    • Working with shift notes
    • List shift notes from current shift
    • Create shift note on current shift
  • Schedules
    • List all schedule entries
    • Get details for a schedule
    • Create schedule entry
    • Bulk copy schedule shifts
    • Update schedule entry
    • Remove schedule entry
    • List all draft schedule entries
    • Get details for a draft entry
    • Create draft schedule entry
    • Update draft entry
    • Remove draft schedule entry
    • Publish draft schedule
    • List open shifts
    • Get details for an open shift
    • Create open shift
    • Update open shift
    • Remove open shift
    • Claim open shift
    • Retract open shift submission
    • Create open shift preference
    • Retract open shift preference
    • Update open shift preference
    • Remove open shift preference
    • Assign or accept open shift preference
    • Bulk assign or accept open shift preferences
  • Settings
    • Retrieve organization time off settings
    • Update organization time off settings
  • Notifications
    • Coming soon
  1. Locations

Retrieve all locations

GET
/api/organizations/{organization_id}/locations
Retrieves a list of all locations within the specified organization.

Request

Path Params

Query Params

Responses

🟢200OK
application/json
A list of locations for the specified organization.
Body

🟠404Record Not Found
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/organizations//locations'
Response Response Example
200 - Success
{
    "id": "loc_001",
    "name": "San Francisco Office",
    "website": "www.example-sf.com",
    "country": "US",
    "state": "CA",
    "city": "San Francisco",
    "addressLine1": "123 Market St",
    "addressLine2": "Suite 100",
    "zipCode": 94105,
    "externalId": "sf_office_1",
    "longitude": "-122.406417",
    "latitude": "37.785834",
    "clock_in_distance_centimeters": 5000,
    "clock_out_distance_centimeters": 5000,
    "break_start_distance_centimeters": 3000,
    "break_end_distance_centimeters": 3000,
    "organizationId": "org_12345",
    "active": true,
    "createdAt": "2023-10-27T10:00:00Z",
    "updatedAt": "2023-10-27T10:00:00Z",
    "deletedAt": null
}
Modified at 2025-01-05 15:30:31
Previous
Delete Organization by External ID
Next
Retrieve a specific location