API Documentation

General

Endpoints

Appendix

User Settings

User Object

Property Type Description Writable
id string Your unique identifier. No
email string The email address associated with your account. The maximum length is 200 characters. Yes
firstname string Your first name. The maximum length is 50 characters. Yes
lastname string Your last name. The maximum length is 100 characters. Yes
language_tag string The language of the user interface. Must be en for English or de for German. Default is en. Yes
date_format string The format used for displaying dates. Must be one of: m/d/Y, m-d-Y, m.d.Y, d/m/Y, d-m-Y, d.m.Y, Y/m/d, Y-m-d, Y.m.d. Yes
time_format string The format used for displaying times. Must be one of: H:i (24 hour format, e.g. 13:00), h:i A (12 hour format, e.g. 1:00 PM), h:i a (12 hour format, e.g. 1:00 p.m.). Yes
timezone string The time zone that is used to display times. It is also used implicitly when you don't specify one when creating bookings. Must be an Olson DB timezone identifier. Yes
first_day_of_week string First day of week used in calendars and schedules. Must be one of: monday, saturday, sunday. Yes
allow_collaboration boolean true if other Oberplan users can add you as a collaborator for a schedule; false otherwise. Default is true. Yes
profile_completed boolean If set to false you will be asked to complete your user profile after logging to the app. Yes
collaboration_limit integer Maximum number of schedules that you can access as a collaborator. No
request_rate_limit integer Maximum number of requests you are allowed to send within 5 minutes. No
updated_at string The date and time when this collaborator was last updated, in UTC and ISO 8601 format. No
created_at string The date and time when this collaborator was created, in UTC and ISO 8601 format. No

Get Your User Settings

GET /users/me

Returns your user settings.

Example

The following request returns your user settings:

curl https://api.oberplan.com/v1/users/me \
-X GET \
-u user@oberplan.com:mypassword

Sample response:

{
   "data": {
      "allow_collaboration": true,
      "collaboration_limit": 100,
      "created_at": "2018-06-29T12:29:42Z",
      "date_format": "m/d/Y",
      "email": "user@oberplan.com",
      "first_day_of_week": "sunday",
      "firstname": "John",
      "id": "bdodfk9fgluim7yp",
      "language_tag": "en",
      "lastname": "Smith",
      "profile_completed": 1,
      "request_rate_limit": 100,
      "schedules_limit": 20,
      "time_format": "h:i a",
      "timezone": "US/Eastern",
      "updated_at": "2018-09-28T16:16:29Z"
   },
   "success": true
}

Update Your User Settings

PUT /users/me

Updates your user settings.

The request body may contain all object properties or only those properties that you want to edit.

Note: If you change your email address, you will receive an activation email to the new address. Follow the link in the email to activate the new email address.

Example

The following request changes the date and time format:

curl https://api.oberplan.com/v1/users/me \
-X PUT \
-u user@oberplan.com:mypassword \
-d \
'
{
   "date_format": "d.m.Y",
   "time_format": "H:i"
}
'

Response:

{
   "success": true
}

Change Your Password

PUT /users/me

The request body must contain a JSON object with the key new_password, whose value specifies the new password. The minimum length for the password is 6 characters.

Example

The following request changes your password from mypassword to mypassword2:

curl https://api.oberplan.com/v1/users/me \
-X PUT \
-u user@oberplan.com:mypassword \
-d \
'
{
   "new_password": "mypassword2"
}
'

Response:

{
   "success": true
}

Delete Your Account

DELETE /users/me

Deletes your Oberplan account.

Parameters

Name Description
Query Parameters
me In order to prevent accidental deletion, this parameter must be set to 1.

Example

The following request deletes your account:

curl https://api.oberplan.com/v1/users/me?me=1 \
-X DELETE \
-u user@oberplan.com:mypassword

Response:

{
   "success": true
}