API ReferenceapiidentityGET /v1/admin/users/{user_id}/settings

GET /v1/admin/users/\{user_id\}/settings

Service: identity · operationId: (none)

Required scopes

(no scope declared — review service config)

Path parameters

  • user_id (string) required

Responses

200 User settings needed for service-side workflows

{
  "type": "object",
  "properties": {
    "user_id": {
      "type": "string"
    },
    "timezone": {
      "type": [
        "string",
        "null"
      ]
    },
    "dose_reminder_schedule": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "morning_time": {
          "type": "string"
        },
        "evening_time": {
          "type": "string"
        },
        "days": {
          "type": "array",
          "items": {
            "type": "integer",
            "minimum": 0,
            "maximum": 6
          }
        }
      },
      "required": [
        "morning_time",
        "evening_time",
        "days"
      ]
    }
  },
  "required": [
    "user_id",
    "timezone",
    "dose_reminder_schedule"
  ]
}

500 Internal error

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "message"
  ]
}

Example

curl -X GET https://identity.platform.loop.health/v1/admin/users/{user_id}/settings \
  -H "Authorization: Bearer $ACCESS_TOKEN"