Retrieve Organization

Auth required

GET/v1/organizations/

Parameters

This endpoint takes no parameters.

Credentials

X-APPLOYE-API-KEY

Stored in this browser tab only. Try It always sends your key; code samples show a YOUR_API_KEY placeholder until you reveal the key with the eye toggle.

curl --request GET \
  --url "https://api.apploye.com/v1/organizations/" \
  --header "accept: application/json" \
  --header "X-APPLOYE-API-KEY: YOUR_API_KEY"

Response

Organization detail

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "description": "string",
  "color": "string",
  "address": "string",
  "timezone": "string",
  "plan": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "normalized_name": "string"
  },
  "configuration": {
    "currency": "string",
    "screenshot_track": true,
    "screenshot_blur": true,
    "screenshot_frequency": 0,
    "application_track": true,
    "url_track": true,
    "keystroke_track": true,
    "mouse_track": true,
    "user_delete_screenshot": true,
    "receive_weekly_email": true,
    "ask_instant_screenshot_permission": true,
    "allow_user_add_manual_timesheet": true,
    "require_manual_timesheet_approval": true,
    "show_screenshot_notification": true,
    "instant_screenshot": true,
    "video_recording": true,
    "video_duration": 0,
    "date_format": "string",
    "start_day_of_week": 0
  },
  "idle_time_setting": {
    "idle_time": 0,
    "action": "string"
  }
}

Retrieve Organization

Parameters#

Parameters