Simple In/Out API v4 Documentation

Welcome to the Simple In/Out API! You can use our API to access Simple In/Out data. You can request both read and write access.

The Simple In/Out v4 API is a RESTful (mostly) API protected by OAuth 2.

Rate Limiting

APIv4 is protected by daily rate limits. Currently, your application can access APIv4 up to 10,000 times per 24 hour period. Every request to APIv4 will return with two headers: X-RateLimit-Limit and X-RateLimit-Remaining. X-RateLimit-Limit will indicate the total number of requests that can be made against APIv4 over a 24 hour period (always 10,000 for now). X-RateLimit-Remaining will indicate how many requests you have left.

When you’ve run out of requests, APIv4 will return a HTTP status of 429 indicating Too Many Requests.

Expansions

Some of our APIs allow you to include additional information. This saves on API calls, as you can retrieve related information in the primary call and avoid additional requests.

When an API supports including additional information, it does so via the expand query parameter. This is a comma-delimited list of resources to include. We support expansions via embedding directly into the payload.

The Meta object

Most API payloads include a meta object to provide additional details about the requested resource(s). This includes paging most often, and sometimes additional information about the user making the request. For some payloads there may be additional items in the meta.

Here’s an example of a meta object

{"meta": {
  "paging": {
    "page": 1,
    "page_size": 25,
    "page_count": 2,
    "count": 47,
    "previous_page": null,
    "next_page": 2,
    "first_href": "https://www.simpleinout.com/api/v4/beacons",
    "last_href": "https://www.simpleinout.com/api/v4/beacons?page=2",
    "previous_href": null,
    "next_href": "https://www.simpleinout.com/api/v4/beacons?page=2"
  },
  "last_updated_at": {
    "beacons": 1435250484,
    "favorites": 1437151284,
    "fences": 1436546484,
    "groups": 1436287284,
    "settings": 1439916084
  }
}}

Pagination

Pagination occurs when requesting multiple objects. Information about this appears in the meta object.

Name Description
page the page number currently being returned
page_size the number of results per page
page_count the total number of pages available
count the total number of results
previous_page the number of the previous page
next_page the number of the next page
first_href the URL of the API call for the first page of results
last_href the URL of the API call for the last page of results
previous_href the URL of the API call for the page of results prior to the current page
next_href the URL of the API call for the page of results after the current page

Last Update At

The last_updated_at attribute in the meta object returns the epoch time indicating the last time certain resources have been updated. This applies to the authorized user’s company. By storing these dates, you can discover when resources have been updated without having to poll those resources on a regular basis.

If Modified Since and If None Match

Most of the GET requests to the API support the If-Modified-Since and If-None-Match headers. If these two headers are present, the GET request will only return a payload if the relevant data has been updated since the time specified in the If-Modified-Since header and the ETag in the If-None-Match header. If it has been updated since, the payload will be the same as usual. If the data has not been updated, the return will be empty with a HTTP status of 304 (Not Modified). The format of the time is in the HTTP specification, while the ETag should be the same as that returned when a request has been made previously.

When a GET API returns data, the Last-Modified header will be present providing the exact time it’s been modified. This date should be used for future If-Modified-Since requests. The ETag header will be present providing the hash value representing the returned payload. This hash should be used for future If-None-Match requests.

Range Searching

Some integer or date/time fields can be searched by using operators. This permits exact searches, as well as less than, greater than, or between. For these fields, you have an array of options.

  • For exact matches, simply include the value. Date/time fields use epoch time, so it’s almost impossible to get an exact match to the second. Examples are 18 or 1524168783.
  • For ranges based on a single value, you may prepend a symbol to the front of the value. The symbols <, >, <=, or >= are supported. Examples are <18 or >=1524168783.
  • For between range searches, the .. operator is used in between the two values. This includes the values on both ends, as well as those in between. Examples are 9..18 or 1523854800..1524459599.

Sorting

When requesting multiple objects, most of the time you’ll have some sorting options available. Sorting occurs by passing in the sort query parameter. The value is a comma-delimited string of fields in the order you wish them to be sorted. By default, all fields will sort in ascending fashion, but you can sort in descending fashion by including a - sign before the field. An example of this would be sort=name,-begin_at.

Errors

Error objects in Simple In/Out consist of three parts: code, message, and details.

  • code corresponds with those listed below. These provide context as to what type of error occurred.
  • message is an English plain-text reading of what happened. This should be used for further developer debugging, but should not be relied on to remain consistent over time. While these messages can be displayed to end-users, it is highly discouraged as they can change without notice and they are always going to be in English.
  • details provides an array of information in the case of validation failures. This will typically be populated with 5005 validation errors, though they also can appear with improperly formatted status updates (2002). The format of the objects in the array are key: value pairs, whereby key is the name of a field and value is one of a number of possible strings to indicated more specfically what was invalid with the input. Please note that while the key will typically be a parameter on the object, it can occassionally be base for errors that fail validation but don’t apply to a particular field.

An example of an error payload:

{
  "code": 5005,
  "message": "Validation Failure: Name can't be blank, UUID is invalid, Beacons exceed company limit of 100",
  "details": [
    { "name": "blank" },
    { "uuid": "invalid" },
    { "base": "greater_than" }
  ]
}

Error Codes

1002: Company is Disabled

Either the user’s company was on a trial and the trial has expired or the company has let their subscription to Simple In/Out expire. This error will present itself on almost all APIs and will return with the status code 403.


2002: Status Failure

The status update could not be completed.


5001: Bad Range

The integer or date value/range is invalid.


5002: Unknown Sort

The sort requested does not exist. The full message of this error will provide more explanation.


5003: Unknown Expansion

The expansion requested does not exist. The full message of this error will provide more explanation.


5005: Validation Failure

When attempting to create/update/delete the object, some data was either missing or invalid. The full message of this error will provide more explanation.


5007: Parameters Missing

A required parameter for this API was missing.


5008: Array Required

A parameter which is required to be an array was passed something other than an array.


5009: Unknown Only

The only field requested does not exist. The full message of this error will provide more explanation.


5010: Invalid Float

The floating point number is invalid.


5012: Invalid JSON

The posted JSON body is invalid.


5013: Invalid Page Size of Zero

The page_size parameter cannot be zero.

Error Details

taken

The attribute is not unique

inclusion

The attribute is not in the list of acceptable values

invalid

The attribute is not valid

empty

The attribute cannot be empty

blank

The attribute cannot be blank

too_long

The attribute is too long

not_a_hex

The attribute is not a valid hex color code

not_a_number

The attribute is not a number

not_an_integer

The attribute is not an integer

greater_than

The attribute is greater than a predefined limit

greater_than_or_equal_to

The attribute is greater than or equal to a predefined limit

less_than

The attribute is less than a predefined floor

less_than_or_equal_to

The attribute is greater than or equal to a predefined floor

too_long

The attribute is longer than allowed

too_short

The attribute is shorter than allowed

Forbidden Requests (403)

When the user is authenticated, but doesn’t have the necessary permissions to perform an action, the server will respond with the status code of 403 and include the user’s privileges in the payload.

Example payload:

{
  "company": {
    "id": "1",
    "scheduled_statuses": true
  },
  "user": {
    "id": "5",
    "roles": {
      "name": "Regular User",
      "billing": false
      "followed_users": false,
      "reminders": false,
      "safeties": false,
      "tablet_access": false,
      "manage_company_and_users": false,
      "manage_groups_and_memberships": false,
      "manage_others_archives": false,
      "manage_others_futures": false,
      "manage_others_status": false,
      "manage_own_archives": false,
      "manage_own_futures": true,
      "manage_own_status": true,
      "view_badges": false,
      "view_others_archives": true,
      "view_others_futures": true,
      "view_others_reports": false,
      "view_status_updated_at": true,
      "view_users": true,
      "created_at": 1506268448,
      "updated_at": 1506269853
    }
  }
}

The privileges payload may not exist on all forbidden responses. In the cases when an error code is used, such as when a company is disabled, only the code and message will be returned.

Web Hooks

Web Hooks are a great way to be notified when something happens inside Simple In/Out. When you add a Web Hook URL to Simple In/Out, we’ll send a request to that URL with JSON in the body to tell you about things that have happened.

Currently, this applies to only two event types: status.new and status.destroy, though many may be added in the future. It is strongly advised that you code against the type attribute on the root of the JSON object to avoid new event types being added in the future having unexpected impacts on your code.

The root JSON keys define the basics and out of the box are compatible with Slack’s imcoming webhooks. This also means that the text with be formatted in Markdown. Within the data object is much of the information specific to Simple In/Out, including ids that can be used in combination with APIv4 to request further information.

{
  "username": "Bojack Horseman",
  "email": "bojack@horsinaround.com",
  "icon_url": "http://bojackhorseman.com/avatar.gif",
  "text": "*In*: In Hollywoo",
  "type": "status.new",
  "data": {
    "user_id": "34858",
    "status": "in",
    "comment": "In Hollywoo",
    "created_at": 1448046759,
    "admin": {
      "id": "2844", "name": "Princess Carolyn"
    },
    "application": {
      "id": "84774", "name": "Simple In/Out iOS"
    }
  }
}



Authentication

Authorization

Authorization is required to access the Simple In/Out API. This results in a HTTP 302 redirect to simpleinout.com. There, Simple In/Out will ask the user for their credentials and verify they wish to grant your application permission to act on their behalf. If they allow it, Simple In/Out will send a request to your redirect_uri with a code that you can use in the Authorization Code grant to have access and refresh tokens to access the API.

Endpoint

GET /oauth/authorize

Parameters

Name Description
response_type required (string) the type of authorization to use, in this case always 'code'
client_id required (string) your API client key
redirect_uri required (string) the URI to return the user to after authenticating, must match those registered with Simple In/Out
scope required (string) requested scope, either 'read' or 'write', by default 'read'
locale (string) the language for authorization. Available locales: en, en-au, en-ca, en-gb, es. Defaults to 'en'

Request

Route

GET /oauth/authorize?response_type=code&client_id=PLACE_YOUR_API_CLIENT_ID_HERE&redirect_uri=https%3A%2F%2Fmitchell.net&scope=write&locale=en

Query Parameters

response_type=code
client_id=PLACE_YOUR_API_CLIENT_ID_HERE
redirect_uri=https://mitchell.net
scope=write
locale=en

cURL

curl -g "https://www.simpleinout.com/oauth/authorize?response_type=code&client_id=PLACE_YOUR_API_CLIENT_ID_HERE&redirect_uri=https%3A%2F%2Fmitchell.net&scope=write&locale=en" -X GET 

Response

Simulated Response

Status

302

Body

<html><body>You are being <a href="http://example.org/en/users/sign_in">redirected</a>.</body></html>

Authorization Code grant

Authorization Code should be used for accessing the API on behalf of a particular user. This is useful for pulling information about the user, or customizing the return of some APIs by the user’s preference.

The first step here is to have your user authorize your app for use. To do this, send your user to our site as noted to the left, passing your client_id and your redirect_uri. We’ll handle asking for the user, authenticating they are who they say they are, and handling the authorization (asking the user for permission on your behalf).

Once your user successfully authorizes your application, they will be redirected back to you. In this response will be a code in the form of a query string. Use this code to request tokens from Simple In/Out. You’ll then receive an access token and refresh token.

Endpoint

POST /oauth/token

Parameters

Name Description
grant_type required (string) type of grant to use
client_id required (string) your API client key
client_secret required (string) your API client secret
code required (string) if using Authorization Code grant, this is the code that is returned from Simple In/Out
redirect_uri required (string) the URI to return the user to after authenticating, must match those registered with Simple In/Out
scope (string) requested scope, either 'read' or 'write', defaults to 'read'

Request

Route

POST /oauth/token

Body

{
  "grant_type": "authorization_code",
  "client_id": "YOUR_API_CLIENT_ID",
  "client_secret": "YOUR_API_CLIENT_SECRET",
  "code": "44141f3dfaf223980cbf169620dd90a3be745608a54fb95863f9a1caa5fb601f",
  "redirect_uri": "https://jastdubuque.com"
}

cURL

curl "https://www.simpleinout.com/oauth/token" -d '{"grant_type":"authorization_code","client_id":"YOUR_API_CLIENT_ID","client_secret":"YOUR_API_CLIENT_SECRET","code":"44141f3dfaf223980cbf169620dd90a3be745608a54fb95863f9a1caa5fb601f","redirect_uri":"https://jastdubuque.com"}' -X POST 

Response

Simulated Response

Response Fields

Name Description
access_token (string) the access token used to make API requests
refresh_token (string) used with the Refresh Token grant type to request a new token
token_type (string) identifies the type of token
expires_in (integer) length of time, in seconds, that the token will be honored
scope (string) the scope of the token, either 'read' or 'write'
created_at (integer) the time the token was issued
user (object) the authenticated user's id, company id, and role.

Status

200

Headers

ETag: W/"ddfdca5e32eaae791afcd3bc613d2761"

Body

{
  "access_token": "85b1aa1367a3295758213752fa3062f7374c0bc18e8bd2673f2ce9db96658fc8",
  "token_type": "bearer",
  "expires_in": 60,
  "refresh_token": "4a576102ed27f847e3ff9557a69ed4fb661fbebd1a0801333c37ef1f3a25cff6",
  "scope": "write",
  "created_at": 1560187289,
  "user": {
    "id": "1595",
    "company_id": "736",
    "roles": {
      "id": "3041",
      "name": "Administrator",
      "billing": true,
      "followed_users": true,
      "reminders": true,
      "safeties": true,
      "user_board": true,
      "manage_company_and_users": true,
      "manage_groups_and_memberships": true,
      "manage_others_archives": true,
      "manage_others_futures": true,
      "manage_others_status": true,
      "manage_own_archives": true,
      "manage_own_futures": true,
      "manage_own_status": true,
      "view_others_archives": true,
      "view_others_futures": true,
      "view_others_reports": true,
      "view_user_board_updated_at": true,
      "created_at": 1560187289,
      "updated_at": 1560187289
    }
  }
}

Refresh Token grant

Refresh Token should be used to renew your access token in the event that it has expired. This is useful for regaining access without again having to as the user for credentials.

Endpoint

POST /oauth/token

Parameters

Name Description
grant_type required (string) type of grant to use, in this case always 'refresh_token'
refresh_token required (string) your refresh token

Request

Route

POST /oauth/token

Body

{
  "grant_type": "refresh_token",
  "refresh_token": "t34gwknjygj6b7c6qwftf4rzxqjtdk3w"
}

cURL

curl "https://www.simpleinout.com/oauth/token" -d '{"grant_type":"refresh_token","refresh_token":"t34gwknjygj6b7c6qwftf4rzxqjtdk3w"}' -X POST 

Response

Simulated Response

Response Fields

Name Description
access_token (string) the access token used to make API requests
refresh_token (string) used with the Refresh Token grant type to request a new token
token_type (string) identifies the type of token
expires_in (integer) length of time, in seconds, that the token will be honored
scope (string) the scope of the token, either 'read' or 'write'
created_at (integer) the time the token was issued
user (object) the authenticated user's id and role.

Status

200

Headers

ETag: W/"d0306cc0b50135ad8913c505f58ae954"

Body

{
  "access_token": "864152067d145a05741a460940feaeba459e69fa652df6d44620e90f2d6d6070",
  "token_type": "bearer",
  "expires_in": 60,
  "refresh_token": "b0b8d7d7c4361d104cb1624185b11b102afc4d82a6ff429bb2d7aa899aec8768",
  "scope": "write",
  "created_at": 1560187289,
  "user": {
    "id": "1600",
    "company_id": "739",
    "roles": {
      "id": "3053",
      "name": "Administrator",
      "billing": true,
      "followed_users": true,
      "reminders": true,
      "safeties": true,
      "user_board": true,
      "manage_company_and_users": true,
      "manage_groups_and_memberships": true,
      "manage_others_archives": true,
      "manage_others_futures": true,
      "manage_others_status": true,
      "manage_own_archives": true,
      "manage_own_futures": true,
      "manage_own_status": true,
      "view_others_archives": true,
      "view_others_futures": true,
      "view_others_reports": true,
      "view_user_board_updated_at": true,
      "created_at": 1560187289,
      "updated_at": 1560187289
    }
  }
}

Revoke a token

Revokes a token, rendering it invalid.

Endpoint

POST /oauth/revoke

Parameters

Name Description
client_id required (string) your API client key
client_secret required (string) your API client secret
token required (string) the token to revoke

Request

Route

POST /oauth/revoke

Body

{
  "client_id": "PLACE_YOUR_API_CLIENT_ID_HERE",
  "client_secret": "PLACE_YOUR_API_CLIENT_SECRET_HERE",
  "token": "382131ebb00387bb9dc1283d8ab8ba67a109ccbfcaedf205043421cfd85380a4"
}

cURL

curl "https://www.simpleinout.com/oauth/revoke" -d '{"client_id":"PLACE_YOUR_API_CLIENT_ID_HERE","client_secret":"PLACE_YOUR_API_CLIENT_SECRET_HERE","token":"382131ebb00387bb9dc1283d8ab8ba67a109ccbfcaedf205043421cfd85380a4"}' -X POST 

Response

Simulated Response

Status

200

Headers

ETag: W/"44136fa355b3678a1146ad16f7e8649e"

Body

{}

Token information

Provides details about the OAuth token.

Endpoint

GET /oauth/token/info

Request

Route

GET /oauth/token/info

Headers

Authorization: Bearer 22114cae8e8df1d203f282f38016021cb1a0d603d79981948ec80d22f712be2f

cURL

curl -g "https://www.simpleinout.com/oauth/token/info" -X GET \
	-H "Authorization: Bearer 22114cae8e8df1d203f282f38016021cb1a0d603d79981948ec80d22f712be2f"

Response

Simulated Response

Response Fields

Name Description
resource_owner_id (integer) the id of the user
scopes (array) the scopes this token is authorized to use
expires_in_seconds (integer) the number of seconds until the token expires
application (object) information about the application
created_at (integer) the time the token was issued

Status

200

Headers

ETag: W/"82739e4f59cf99aaaa9b7665e0465147"

Body

{
  "resource_owner_id": 1597,
  "scopes": [
    "read"
  ],
  "expires_in_seconds": 604800,
  "application": {
    "uid": "3323717083690"
  },
  "created_at": 1560187289
}

Beacons

Create a beacon

Creates a new beacon. Once this beacon is created, it will appear in the company’s beacons within the Simple In/Out apps. The UUID can then be added to a hardware beacon to broadcast. Users must have a role that permits managing the company to create beacons. Companies are limited to 100 Beacons.

Endpoint

POST /api/v4/beacons

Parameters

Name Description
beacon[name] required (string) the name of the beacon
beacon[uuid] (string) the unique beacon identifier
beacon[comment_on_entry] (string) the comment applied to status updates on entry, defaults to 'In at {name}'
beacon[comment_on_exit] (string) the comment applied to status updates on exit, defaults to 'Left {name}'
beacon[status_on_entry] (string) the status to apply on entry: 'in', 'out', or 'off', defaults to 'in'
beacon[status_on_exit] (string) the status to apply on exit: 'in', 'out', or 'off', defaults to 'out'

Request

Route

POST /api/v4/beacons

Headers

Authorization: Bearer aa40faa3d0f6e1d5ca3fe123720fd64fa8a32dcf2f72fd3bc12cb5d520bb0710

Body

{
  "beacon": {
    "name": "My Office",
    "uuid": "6EA4801F-4D41-4114-AFA7-7EC977C81B41"
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/beacons" -d '{"beacon":{"name":"My Office","uuid":"6EA4801F-4D41-4114-AFA7-7EC977C81B41"}}' -X POST \
	-H "Authorization: Bearer aa40faa3d0f6e1d5ca3fe123720fd64fa8a32dcf2f72fd3bc12cb5d520bb0710"

Response

Simulated Response

Response Fields

Name Description
beacons (object) the newly created beacon attributes

Status

201

Headers

ETag: W/"6d113de94896975cc198a74c207934ff"

Body

{
  "beacons": {
    "id": "17",
    "name": "My Office",
    "uuid": "6EA4801F-4D41-4114-AFA7-7EC977C81B41",
    "comment_on_entry": "In at My Office",
    "comment_on_exit": "Left My Office",
    "entry": true,
    "exit": true,
    "status_on_entry": "in",
    "status_on_exit": "out",
    "created_at": 1560187293,
    "updated_at": 1560187293
  },
  "meta": {
    "last_updated_at": {
      "beacons": 1560187293,
      "favorites": 1553620893,
      "fences": 1559668893,
      "groups": 1554484893,
      "networks": 0,
      "roles": 1560187293,
      "settings": 1560187293
    }
  }
}

Delete a beacon

Deletes an existing beacon. Users must have a role that permits managing the company to delete beacons.

Endpoint

DELETE /api/v4/beacons/:id

Request

Route

DELETE /api/v4/beacons/18

Headers

Authorization: Bearer 0ef5b9ae3d27d69a382914e2041cba87143c1f05a3f4ac2f9b0188ab28c7d640

cURL

curl "https://www.simpleinout.com/api/v4/beacons/18" -d '' -X DELETE \
	-H "Authorization: Bearer 0ef5b9ae3d27d69a382914e2041cba87143c1f05a3f4ac2f9b0188ab28c7d640"

Response

Simulated Response

Status

204

List all beacons

Return a list of all the beacons belonging to the company.

Endpoint

GET /api/v4/beacons

Parameters

Name Description
sort (string) order of the return with optional '-' to denote descending, possibilities include: 'name'
page_size (integer) number of results to return per page, defaults to 25
page (integer) page number of results

Request

Route

GET /api/v4/beacons

Headers

Authorization: Bearer 1e8a2d8d464de878b35f54f675c7bb30e44299528d491c68879f1ff41c51244c

cURL

curl -g "https://www.simpleinout.com/api/v4/beacons" -X GET \
	-H "Authorization: Bearer 1e8a2d8d464de878b35f54f675c7bb30e44299528d491c68879f1ff41c51244c"

Response

Simulated Response

Response Fields

Name Description
beacons (array) an array of beacons

Status

200

Headers

ETag: W/"7a0f53f2b52f6a1c436aacf29169d98f"
Last-Modified: Mon, 10 Jun 2019 17:21:33 GMT

Body

{
  "beacons": [
    {
      "id": "16",
      "name": "D'Amore-Feil",
      "uuid": "4218E18A-0CAC-4534-AD4E-CFA63528BC4D",
      "comment_on_entry": "In at D'Amore-Feil",
      "comment_on_exit": "Left D'Amore-Feil",
      "entry": true,
      "exit": true,
      "status_on_entry": "in",
      "status_on_exit": "out",
      "created_at": 1560187293,
      "updated_at": 1560187293
    },
    {
      "id": "15",
      "name": "Bashirian, Bailey and Casper",
      "uuid": "BC272F8A-20CB-4949-9713-32DD7D1D16AF",
      "comment_on_entry": "In at Bashirian, Bailey and Casper",
      "comment_on_exit": "Left Bashirian, Bailey and Casper",
      "entry": true,
      "exit": true,
      "status_on_entry": "in",
      "status_on_exit": "out",
      "created_at": 1560187293,
      "updated_at": 1560187293
    }
  ],
  "meta": {
    "paging": {
      "page": 1,
      "page_size": 25,
      "page_count": 1,
      "count": 2,
      "previous_page": null,
      "next_page": null,
      "first_href": "http://example.org/api/v4/beacons",
      "last_href": "http://example.org/api/v4/beacons",
      "previous_href": null,
      "next_href": null
    },
    "last_updated_at": {
      "beacons": 1560187293,
      "favorites": 1551810093,
      "fences": 1555780893,
      "groups": 1552929693,
      "networks": 0,
      "roles": 1560187293,
      "settings": 1560187293
    }
  }
}

Update a beacon

Updates an existing beacon. Please note that if the UUID of the beacon is updated, any corresponding hardware must also be updated to broadcast the new UUID. Users must have a role that permits managing the company to update beacons.

Endpoint

PATCH /api/v4/beacons/:id

Parameters

Name Description
beacon[name] (string) the name of the beacon
beacon[uuid] (string) the unique beacon identifier
beacon[comment_on_entry] (string) the comment applied to status updates on entry, defaults to 'In at {name}'
beacon[comment_on_exit] (string) the comment applied to status updates on exit, defaults to 'Left {name}'
beacon[status_on_entry] (string) the status to apply on entry: 'in', 'out', or 'off', defaults to 'in'
beacon[status_on_exit] (string) the status to apply on exit: 'in', 'out', or 'off', defaults to 'out'

Request

Route

PATCH /api/v4/beacons/14

Headers

Authorization: Bearer bbd22deb04d646c8b88e59cd6ad02e652ca855cc721655cc33865619c3bd1036

Body

{
  "beacon": {
    "name": "My Renamed Office"
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/beacons/14" -d '{"beacon":{"name":"My Renamed Office"}}' -X PATCH \
	-H "Authorization: Bearer bbd22deb04d646c8b88e59cd6ad02e652ca855cc721655cc33865619c3bd1036"

Response

Simulated Response

Response Fields

Name Description
beacons (object) the newly updated beacon attributes

Status

200

Headers

ETag: W/"ee9cb005472db25925b0b3a2696c21dc"

Body

{
  "beacons": {
    "id": "14",
    "name": "My Renamed Office",
    "uuid": "61090E2F-ED4B-4B2D-9ED7-A80094BE47A5",
    "comment_on_entry": "In at My Renamed Office",
    "comment_on_exit": "Left My Renamed Office",
    "entry": true,
    "exit": true,
    "status_on_entry": "in",
    "status_on_exit": "out",
    "created_at": 1560187293,
    "updated_at": 1560187293
  },
  "meta": {
    "last_updated_at": {
      "beacons": 1560187293,
      "favorites": 1552411293,
      "fences": 1558891293,
      "groups": 1555089693,
      "networks": 0,
      "roles": 1560187293,
      "settings": 1560187293
    }
  }
}

Companies

Retrieve the current company

Return the company the authorized user belongs to.

Endpoint

GET /api/v4/companies/my

Parameters

Name Description
expand (string) comma-delimited list of extra information to include in the response, possibilities include: 'billing', 'beacons', 'fences', 'groups', 'favorites', 'networks', 'roles'

Request

Route

GET /api/v4/companies/my

Headers

Authorization: Bearer 92033b76e8e6ef947b60b6646937b3235321b9daa7c836732bb7c7c0827c9578

cURL

curl -g "https://www.simpleinout.com/api/v4/companies/my" -X GET \
	-H "Authorization: Bearer 92033b76e8e6ef947b60b6646937b3235321b9daa7c836732bb7c7c0827c9578"

Response

Simulated Response

Response Fields

Name Description
companies[name] (string) the authorized user's company name
companies[logo_url] (string) url of an image to be used as a fullscreen logo
companies[default_role_id] (string) the unique identifier for the default role
companies[scheduled_statuses] (boolean) whether Scheduled Statuses feature is enabled
companies[created_at] (integer) epoch time the company was created

Status

200

Headers

ETag: W/"ecfa40ddc60371ab184f842b0cd9e2c3"
Last-Modified: Mon, 10 Jun 2019 17:21:31 GMT

Body

{
  "companies": {
    "id": "754",
    "name": "VonRueden-Streich",
    "scheduled_statuses": true,
    "default_role_id": "3115",
    "logo_url": null,
    "created_at": 1560187291
  },
  "meta": {
    "last_updated_at": {
      "beacons": 1552069291,
      "favorites": 1554484891,
      "fences": 1554744091,
      "groups": 1555780891,
      "networks": 0,
      "roles": 1560187291,
      "settings": 1560187291
    }
  }
}

Futures

Delete a future status

Deletes an existing scheduled status. The company must have scheduled statuses turned on. Users must have a role that permits managing their own scheduled statuses to delete one of their scheduled statuses. Users must have a role that permits managing the scheduled statuses of others to delete another user’s scheduled status.

Endpoint

DELETE /api/v4/futures/:id

Request

Route

DELETE /api/v4/futures/27

Headers

Authorization: Bearer 503b507309cd3ba181afa2ba6687091a6b05c3047ad8d7edef7b8afc43c6cea9

cURL

curl "https://www.simpleinout.com/api/v4/futures/27" -d '' -X DELETE \
	-H "Authorization: Bearer 503b507309cd3ba181afa2ba6687091a6b05c3047ad8d7edef7b8afc43c6cea9"

Response

Simulated Response

Status

204

List future statuses

List all the scheduled statuses. The company must have scheduled statuses turned on. Users must have a role that permits viewing the scheduled statuses of others or only the authorized user’s scheduled statuses will be returned.

Endpoint

GET /api/v4/futures

Parameters

Name Description
page_size (integer) number of results to return per page, defaults to 25
page (integer) page number of results
status (string) the status, either 'in' or 'out'
comment (string) the comment, case sensitive, included with the status change
apply_at (string) a date range string for the time this status will be added
user_id (string) the ID of a particular user
sort (string) order of the return with optional '-' to denote descending, possibilities include: 'apply_at', 'status', 'comment'"
expand (string) comma-delimited list of extra information to include in the response, possibilities include: 'user', 'changed_by_user'

Request

Route

GET /api/v4/futures

Headers

Authorization: Bearer 4bd023698fb50a9cb22b38be990a837e57a7216d4deb974602854bd278374d42

cURL

curl -g "https://www.simpleinout.com/api/v4/futures" -X GET \
	-H "Authorization: Bearer 4bd023698fb50a9cb22b38be990a837e57a7216d4deb974602854bd278374d42"

Response

Simulated Response

Response Fields

Name Description
futures (array) an array of matching future statuses

Status

200

Headers

ETag: W/"fa87cb50461a7404cf7adcab775eb574"
Last-Modified: Mon, 10 Jun 2019 17:21:30 GMT

Body

{
  "futures": [
    {
      "id": "25",
      "status": "out",
      "comment": "On Vacation, back Monday",
      "apply_at": 1562778000,
      "user_id": "1607",
      "changed_by_user_id": null
    },
    {
      "id": "26",
      "status": "out",
      "comment": "At the conference this week",
      "apply_at": 1576000800,
      "user_id": "1607",
      "changed_by_user_id": null
    }
  ],
  "meta": {
    "paging": {
      "page": 1,
      "page_size": 25,
      "page_count": 1,
      "count": 2,
      "previous_page": null,
      "next_page": null,
      "first_href": "http://example.org/api/v4/futures",
      "last_href": "http://example.org/api/v4/futures",
      "previous_href": null,
      "next_href": null
    },
    "last_updated_at": {
      "beacons": 1558804890,
      "favorites": 1554484890,
      "fences": 1558632090,
      "groups": 1554916890,
      "networks": 0,
      "roles": 1560187290,
      "settings": 1560187290
    }
  }
}

Geofences

Create a fence

Creates a new fence. Once this fence is created, it will appear in the company’s fences within the Simple In/Out apps and website. Users must have a role that permits managing the company to create fences. Companies are limited to 150 Geofences.

Endpoint

POST /api/v4/fences

Parameters

Name Description
fence[name] required (string) the name of the fence
fence[latitude] required (float) the latitude of the center point of the fence
fence[longitude] required (float) the longitude of the center point of the fence
fence[radius] required (integer) the radius of the fence, in meters
fence[comment_on_entry] (string) the comment applied to status updates on entry, defaults to 'In at {name}'
fence[comment_on_exit] (string) the comment applied to status updates on exit, defaults to 'Left {name}'
fence[status_on_entry] (string) the status to apply on entry: 'in', 'out', or 'off', defaults to 'in'
fence[status_on_exit] (string) the status to apply on exit: 'in', 'out', or 'off', defaults to 'out'

Request

Route

POST /api/v4/fences

Headers

Authorization: Bearer c38deea5220a8e3ccc9745443cdea879e7eab55041d6b9458d88326161a40809

Body

{
  "fence": {
    "name": "My Office",
    "latitude": 46.877931,
    "longitude": -96.787459,
    "radius": 150
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/fences" -d '{"fence":{"name":"My Office","latitude":46.877931,"longitude":-96.787459,"radius":150}}' -X POST \
	-H "Authorization: Bearer c38deea5220a8e3ccc9745443cdea879e7eab55041d6b9458d88326161a40809"

Response

Simulated Response

Response Fields

Name Description
fences (object) the newly created fence attributes

Status

201

Headers

ETag: W/"78c03cf334d882889ae344fecb3d96f6"

Body

{
  "fences": {
    "id": "14",
    "name": "My Office",
    "latitude": "46.877931",
    "longitude": "-96.787459",
    "radius": 150,
    "comment_on_entry": "In at My Office",
    "comment_on_exit": "Left My Office",
    "entry": true,
    "exit": true,
    "status_on_entry": "in",
    "status_on_exit": "out",
    "created_at": 1560187293,
    "updated_at": 1560187293
  },
  "meta": {
    "last_updated_at": {
      "beacons": 1556731293,
      "favorites": 1558200093,
      "fences": 1560187293,
      "groups": 1557508893,
      "networks": 0,
      "roles": 1560187293,
      "settings": 1560187293
    }
  }
}

Delete a fence

Deletes an existing fence. Users must have a role that permits managing the company to delete fences.

Endpoint

DELETE /api/v4/fences/:id

Request

Route

DELETE /api/v4/fences/11

Headers

Authorization: Bearer 2ee88c88e26bd15111404f5cf76ecbdcaafb2c2abe4517def9720d6401b38ed0

cURL

curl "https://www.simpleinout.com/api/v4/fences/11" -d '' -X DELETE \
	-H "Authorization: Bearer 2ee88c88e26bd15111404f5cf76ecbdcaafb2c2abe4517def9720d6401b38ed0"

Response

Simulated Response

Status

204

List all fences

Return a list of all the fences belonging to the company.

Endpoint

GET /api/v4/fences

Parameters

Name Description
sort (string) order of the return with optional '-' to denote descending, possibilities include: 'name', 'radius
page_size (integer) number of results to return per page, defaults to 25
page (integer) page number of results

Request

Route

GET /api/v4/fences

Headers

Authorization: Bearer a3bddc60f923641f7b2af1d19e2f3d0f32d451a595e78a3e478faead408b477b

cURL

curl -g "https://www.simpleinout.com/api/v4/fences" -X GET \
	-H "Authorization: Bearer a3bddc60f923641f7b2af1d19e2f3d0f32d451a595e78a3e478faead408b477b"

Response

Simulated Response

Response Fields

Name Description
fences (array) an array of fences

Status

200

Headers

ETag: W/"1f6f22be5db5d689152da506a8dec583"
Last-Modified: Mon, 10 Jun 2019 17:21:33 GMT

Body

{
  "fences": [
    {
      "id": "13",
      "name": "ostmp7fnpd6dn8utqhfc",
      "latitude": "-33.1833200521",
      "longitude": "16.2545982017",
      "radius": 3412,
      "comment_on_entry": "In at ostmp7fnpd6dn8utqhfc",
      "comment_on_exit": "Left ostmp7fnpd6dn8utqhfc",
      "entry": true,
      "exit": true,
      "status_on_entry": "in",
      "status_on_exit": "out",
      "created_at": 1560187293,
      "updated_at": 1560187293
    },
    {
      "id": "12",
      "name": "c2hrrouwabsmwk8igmux",
      "latitude": "-29.7283821796",
      "longitude": "26.1803885985",
      "radius": 10792,
      "comment_on_entry": "In at c2hrrouwabsmwk8igmux",
      "comment_on_exit": "Left c2hrrouwabsmwk8igmux",
      "entry": true,
      "exit": true,
      "status_on_entry": "in",
      "status_on_exit": "out",
      "created_at": 1560187293,
      "updated_at": 1560187293
    }
  ],
  "meta": {
    "paging": {
      "page": 1,
      "page_size": 25,
      "page_count": 1,
      "count": 2,
      "previous_page": null,
      "next_page": null,
      "first_href": "http://example.org/api/v4/fences",
      "last_href": "http://example.org/api/v4/fences",
      "previous_href": null,
      "next_href": null
    },
    "last_updated_at": {
      "beacons": 1557422492,
      "favorites": 1552756892,
      "fences": 1560187293,
      "groups": 1552155692,
      "networks": 0,
      "roles": 1560187293,
      "settings": 1560187293
    }
  }
}

Update a fence

Updates an existing fence. Users must have a role that permits managing the company to update fences.

Endpoint

PATCH /api/v4/fences/:id

Parameters

Name Description
fence[name] (string) the name of the fence
fence[latitude] (float) the latitude of the center point of the fence
fence[longitude] (float) the longitude of the center point of the fence
fence[radius] (integer) the radius of the fence, in meters
fence[comment_on_entry] (string) the comment applied to status updates on entry, defaults to 'In at {name}'
fence[comment_on_exit] (string) the comment applied to status updates on exit, defaults to 'Left {name}'
fence[status_on_entry] (string) the status to apply on entry: 'in', 'out', or 'off', defaults to 'in'
fence[status_on_exit] (string) the status to apply on exit: 'in', 'out', or 'off', defaults to 'out'

Request

Route

PATCH /api/v4/fences/15

Headers

Authorization: Bearer a8c8317eacfc74b17c9aa67c87dd6cb6010bfa23b0725a941db5e01042e5ebf4

Body

{
  "fence": {
    "name": "My Renamed Geofence"
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/fences/15" -d '{"fence":{"name":"My Renamed Geofence"}}' -X PATCH \
	-H "Authorization: Bearer a8c8317eacfc74b17c9aa67c87dd6cb6010bfa23b0725a941db5e01042e5ebf4"

Response

Simulated Response

Response Fields

Name Description
fences (object) the newly updated fence attributes

Status

200

Headers

ETag: W/"92f45afba1ee4d053bfa597d41e0028d"

Body

{
  "fences": {
    "id": "15",
    "name": "My Renamed Geofence",
    "latitude": "50.2746969078",
    "longitude": "-62.2834448598",
    "radius": 2016,
    "comment_on_entry": "In at My Renamed Geofence",
    "comment_on_exit": "Left My Renamed Geofence",
    "entry": true,
    "exit": true,
    "status_on_entry": "in",
    "status_on_exit": "out",
    "created_at": 1560187293,
    "updated_at": 1560187293
  },
  "meta": {
    "last_updated_at": {
      "beacons": 1555867293,
      "favorites": 1553361693,
      "fences": 1560187293,
      "groups": 1555521693,
      "networks": 0,
      "roles": 1560187293,
      "settings": 1560187293
    }
  }
}

Groups

Create a group

Creates a new group. Once this group is created, it will appear in the company’s groups within the Simple In/Out apps and website. Users must have a role that permits managing groups/memberships to create groups. Companies are limited to 100 Groups.

Endpoint

POST /api/v4/groups

Parameters

Name Description
group[name] required (string) the name of the group

Request

Route

POST /api/v4/groups

Headers

Authorization: Bearer 25ae20954adeea4fbe7e4e8700c78f4568a54d5fe817d7ab7f3f8b459d19f831

Body

{
  "group": {
    "name": "New Department"
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/groups" -d '{"group":{"name":"New Department"}}' -X POST \
	-H "Authorization: Bearer 25ae20954adeea4fbe7e4e8700c78f4568a54d5fe817d7ab7f3f8b459d19f831"

Response

Simulated Response

Response Fields

Name Description
groups (object) the newly created group attributes

Status

201

Headers

ETag: W/"2314413442c4c03c2d35f62386397d2b"

Body

{
  "groups": {
    "id": "188",
    "name": "New Department"
  },
  "meta": {
    "last_updated_at": {
      "beacons": 1553620890,
      "favorites": 1555003290,
      "fences": 1551896490,
      "groups": 1560187290,
      "networks": 0,
      "roles": 1560187290,
      "settings": 1560187290
    }
  }
}

Delete a group

Deletes an existing group. Users must have a role that permits managing groups/memberships to delete groups.

Endpoint

DELETE /api/v4/groups/:id

Request

Route

DELETE /api/v4/groups/189

Headers

Authorization: Bearer 00c232f2de31bee792a4141df675c63cb5f014b507ff6236df50efbf0cc1fd56

cURL

curl "https://www.simpleinout.com/api/v4/groups/189" -d '' -X DELETE \
	-H "Authorization: Bearer 00c232f2de31bee792a4141df675c63cb5f014b507ff6236df50efbf0cc1fd56"

Response

Simulated Response

Status

204

List all groups

Return a list of all the groups belonging to the company.

Endpoint

GET /api/v4/groups

Parameters

Name Description
sort (string) order of the return with optional '-' to denote descending, possibilities include: 'name'
page_size (integer) number of results to return per page, defaults to 25
page (integer) page number of results

Request

Route

GET /api/v4/groups

Headers

Authorization: Bearer 5e9f2dad98ac07f0d0928485ab9faff5125ee31e4430f46544a4955485d4b558

cURL

curl -g "https://www.simpleinout.com/api/v4/groups" -X GET \
	-H "Authorization: Bearer 5e9f2dad98ac07f0d0928485ab9faff5125ee31e4430f46544a4955485d4b558"

Response

Simulated Response

Response Fields

Name Description
groups (array) an array of groups

Status

200

Headers

ETag: W/"8d36c369fa77512d816ab7665292d201"
Last-Modified: Mon, 10 Jun 2019 17:21:30 GMT

Body

{
  "groups": [
    {
      "id": "186",
      "name": "Prohaska-Bednar"
    },
    {
      "id": "185",
      "name": "Bogan-Sawayn"
    }
  ],
  "meta": {
    "paging": {
      "page": 1,
      "page_size": 25,
      "page_count": 1,
      "count": 2,
      "previous_page": null,
      "next_page": null,
      "first_href": "http://example.org/api/v4/groups",
      "last_href": "http://example.org/api/v4/groups",
      "previous_href": null,
      "next_href": null
    },
    "last_updated_at": {
      "beacons": 1552756889,
      "favorites": 1555003289,
      "fences": 1560187289,
      "groups": 1560187290,
      "networks": 0,
      "roles": 1560187290,
      "settings": 1560187290
    }
  }
}

Update a group

Updates an existing group. Users must have a role that permits managing groups/memberships to update groups.

Endpoint

PATCH /api/v4/groups/:id

Parameters

Name Description
group[name] (string) the name of the group

Request

Route

PATCH /api/v4/groups/187

Headers

Authorization: Bearer e316f245ad9e04a07c7b34081e58bfca21f40b83866562e3315de3c68dd3510c

Body

{
  "group": {
    "name": "Renamed Department"
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/groups/187" -d '{"group":{"name":"Renamed Department"}}' -X PATCH \
	-H "Authorization: Bearer e316f245ad9e04a07c7b34081e58bfca21f40b83866562e3315de3c68dd3510c"

Response

Simulated Response

Response Fields

Name Description
groups (object) the newly updated group attributes

Status

200

Headers

ETag: W/"e47b6ff0417f03625cd05a59f717e1d7"

Body

{
  "groups": {
    "id": "187",
    "name": "Renamed Department"
  },
  "meta": {
    "last_updated_at": {
      "beacons": 1558545690,
      "favorites": 1558804890,
      "fences": 1557336090,
      "groups": 1560187290,
      "networks": 0,
      "roles": 1560187290,
      "settings": 1560187290
    }
  }
}

Networks

Create a network

Creates a new network. Once this network is created, it will appear in the company’s networks within the Simple In/Out apps. Users must have a role that permits managing the company to create networks. Companies are limited to 100 Networks.

Endpoint

POST /api/v4/networks

Parameters

Name Description
network[name] required (string) the name of the network, no longer than 44 characters
network[ssid] required (string) the unique network identifier, no longer than 250 characters
network[comment_on_entry] (string) the comment applied to status updates on entry, defaults to 'In at {name}'
network[comment_on_exit] (string) the comment applied to status updates on exit, defaults to 'Left {name}'
network[status_on_entry] (string) the status to apply on entry: 'in', 'out', or 'off', defaults to 'in'
network[status_on_exit] (string) the status to apply on exit: 'in', 'out', or 'off', defaults to 'out'

Request

Route

POST /api/v4/networks

Headers

Authorization: Bearer a5376c6049b79337d0a8a0463d4a75dc1a3decbaf8e0a2ee3343ddc52994853d

Body

{
  "network": {
    "name": "My Office",
    "ssid": "Office WiFi Hotspot"
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/networks" -d '{"network":{"name":"My Office","ssid":"Office WiFi Hotspot"}}' -X POST \
	-H "Authorization: Bearer a5376c6049b79337d0a8a0463d4a75dc1a3decbaf8e0a2ee3343ddc52994853d"

Response

Simulated Response

Response Fields

Name Description
networks (object) the newly created network attributes

Status

201

Headers

ETag: W/"ed7c6dbd832004127f660c20e6aed8e3"

Body

{
  "networks": {
    "id": "15",
    "name": "My Office",
    "ssid": "Office WiFi Hotspot",
    "comment_on_entry": "In at My Office",
    "comment_on_exit": "Left My Office",
    "entry": true,
    "exit": true,
    "status_on_entry": "in",
    "status_on_exit": "out",
    "created_at": 1560187290,
    "updated_at": 1560187290
  },
  "meta": {
    "last_updated_at": {
      "beacons": 1551637290,
      "favorites": 1553361690,
      "fences": 1552497690,
      "groups": 1557422490,
      "networks": 1560187290,
      "roles": 1560187290,
      "settings": 1560187290
    }
  }
}

Delete a network

Deletes an existing network. Users must have a role that permits managing the company to delete networks.

Endpoint

DELETE /api/v4/networks/:id

Request

Route

DELETE /api/v4/networks/14

Headers

Authorization: Bearer 9560c4622a86f85ea42fdd4a8853c5f458ea14d5fc80f4a3771be435329dae8a

cURL

curl "https://www.simpleinout.com/api/v4/networks/14" -d '' -X DELETE \
	-H "Authorization: Bearer 9560c4622a86f85ea42fdd4a8853c5f458ea14d5fc80f4a3771be435329dae8a"

Response

Simulated Response

Status

204

List all networks

Return a list of all the networks belonging to the company.

Endpoint

GET /api/v4/networks

Parameters

Name Description
sort (string) order of the return with optional '-' to denote descending, possibilities include: 'name'
page_size (integer) number of results to return per page, defaults to 25
page (integer) page number of results

Request

Route

GET /api/v4/networks

Headers

Authorization: Bearer 81e0b66fd39d0c426fcdf826bb1a98814f0f3189484cf8af446c544ab30680ad

cURL

curl -g "https://www.simpleinout.com/api/v4/networks" -X GET \
	-H "Authorization: Bearer 81e0b66fd39d0c426fcdf826bb1a98814f0f3189484cf8af446c544ab30680ad"

Response

Simulated Response

Response Fields

Name Description
networks (array) an array of networks

Status

200

Headers

ETag: W/"752658af994f80368ff3607fd53e0860"
Last-Modified: Mon, 10 Jun 2019 17:21:30 GMT

Body

{
  "networks": [
    {
      "id": "11",
      "name": "Murazik, Schultz and O'Hara",
      "ssid": "87byywofydg6agxdkjckuo5mtv9m6sl3",
      "comment_on_entry": "In at Murazik, Schultz and O'Hara",
      "comment_on_exit": "Left Murazik, Schultz and O'Hara",
      "entry": true,
      "exit": true,
      "status_on_entry": "in",
      "status_on_exit": "out",
      "created_at": 1560187290,
      "updated_at": 1560187290
    },
    {
      "id": "12",
      "name": "Wisozk Inc",
      "ssid": "bmtlruvcycv4mvm6i4efjvrpa04f77tz",
      "comment_on_entry": "In at Wisozk Inc",
      "comment_on_exit": "Left Wisozk Inc",
      "entry": true,
      "exit": true,
      "status_on_entry": "in",
      "status_on_exit": "out",
      "created_at": 1560187290,
      "updated_at": 1560187290
    }
  ],
  "meta": {
    "paging": {
      "page": 1,
      "page_size": 25,
      "page_count": 1,
      "count": 2,
      "previous_page": null,
      "next_page": null,
      "first_href": "http://example.org/api/v4/networks",
      "last_href": "http://example.org/api/v4/networks",
      "previous_href": null,
      "next_href": null
    },
    "last_updated_at": {
      "beacons": 1560100890,
      "favorites": 1554139290,
      "fences": 1556558490,
      "groups": 1553707290,
      "networks": 1560187290,
      "roles": 1560187290,
      "settings": 1560187290
    }
  }
}

Update a network

Updates an existing network. Please note that if the SSID of the network is updated, any corresponding hardware must also be updated to broadcast the new SSID. Users must have a role that permits managing the company to update networks.

Endpoint

PATCH /api/v4/networks/:id

Parameters

Name Description
network[name] (string) the name of the network, no longer than 44 characters
network[ssid] (string) the unique network identifier, no longer than 250 characters
network[comment_on_entry] (string) the comment applied to status updates on entry, defaults to 'In at {name}'
network[comment_on_exit] (string) the comment applied to status updates on exit, defaults to 'Left {name}'
network[status_on_entry] (string) the status to apply on entry: 'in', 'out', or 'off', defaults to 'in'
network[status_on_exit] (string) the status to apply on exit: 'in', 'out', or 'off', defaults to 'out'

Request

Route

PATCH /api/v4/networks/13

Headers

Authorization: Bearer 3d5e9605eaaef38e629a2e2cfb3fc01b4e19532e044d698bebb49c3961bef541

Body

{
  "network": {
    "name": "My Renamed Office"
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/networks/13" -d '{"network":{"name":"My Renamed Office"}}' -X PATCH \
	-H "Authorization: Bearer 3d5e9605eaaef38e629a2e2cfb3fc01b4e19532e044d698bebb49c3961bef541"

Response

Simulated Response

Response Fields

Name Description
networks (object) the newly updated network attributes

Status

200

Headers

ETag: W/"746f370c3ece2be51dbdf95c21c405d2"

Body

{
  "networks": {
    "id": "13",
    "name": "My Renamed Office",
    "ssid": "5zkv3ctzp9xkyh9b51tcb8zoor23vaod",
    "comment_on_entry": "In at My Renamed Office",
    "comment_on_exit": "Left My Renamed Office",
    "entry": true,
    "exit": true,
    "status_on_entry": "in",
    "status_on_exit": "out",
    "created_at": 1560187290,
    "updated_at": 1560187290
  },
  "meta": {
    "last_updated_at": {
      "beacons": 1556904090,
      "favorites": 1558027290,
      "fences": 1557163290,
      "groups": 1560014490,
      "networks": 1560187290,
      "roles": 1560187290,
      "settings": 1560187290
    }
  }
}

Ok

Make sure things are Ok

This API is only used to verify you’ve successfully authorized.

Endpoint

GET /api/v4/ok

Request

Route

GET /api/v4/ok

Headers

Authorization: Bearer dbf3b266b91c6e225d959cfab60311ffb14177cf3b6882ef24486eb43fd7bba2

cURL

curl -g "https://www.simpleinout.com/api/v4/ok" -X GET \
	-H "Authorization: Bearer dbf3b266b91c6e225d959cfab60311ffb14177cf3b6882ef24486eb43fd7bba2"

Response

Simulated Response

Status

204

Roles

Create a role

Creates a new role. Once this role is created, it will be available to assign to users within the Simple In/Out apps and website. Users must have a role that permits managing the company to create roles. Companies are limited to 100 Roles.

Endpoint

POST /api/v4/roles

Parameters

Name Description
role[name] required (string) the name of the role, no longer than 255 characters, must be unique for the company
role[billing] (boolean) these users can change the company's plan, credit card, and invoice email/information.
role[followed_users] (boolean) these users can receive notifications on their devices when another user updates their status.
role[reminders] (boolean) these users can manage notifications sent to other users reminding them to update their status.
role[safeties] (boolean) these users can receive notifications when another user hasn't updated their status.
role[user_board] (boolean) these users can see other users and their current status.
role[manage_groups_and_memberships] (boolean) these users can manage groups and which users are assigned to each group.
role[manage_others_archives] (boolean) these users can change the past statuses of others by adding and deleting status updates.
role[manage_others_futures] (boolean) these users can schedule future status updates for other users.
role[manage_others_status] (boolean) these users can change the current status of other users.
role[manage_own_archives] (boolean) these users can change their own past statuses by adding and deleting status updates.
role[manage_own_futures] (boolean) these users can schedule future status updates for themselves.
role[manage_own_status] (boolean) these users can update their own status from any device or the website. If a user is not allowed to update their own status, they can only update their status from a common device running FrontDesk or TimeClock.
role[view_others_archives] (boolean) these users can view the past status updates made by other users.
role[view_others_futures] (boolean) these users can view the scheduled status updates for other users.
role[view_others_reports] (boolean) these users can run reports on the status history of other users.
role[view_user_board_updated_at] (boolean) these users can view the time that status updates were made on the board.

Request

Route

POST /api/v4/roles

Headers

Authorization: Bearer 5de57807cc9aeecbc86a82a1ff8846c9a91e33568d341f122472f881e1084202

Body

{
  "role": {
    "name": "Billing Role",
    "billing": true,
    "followed_users": false,
    "reminders": false,
    "safeties": false,
    "user_board": false,
    "manage_groups_and_memberships": false,
    "manage_others_archives": false,
    "manage_others_futures": false,
    "manage_others_status": false,
    "manage_own_archives": false,
    "manage_own_futures": false,
    "manage_own_status": false,
    "view_others_archives": false,
    "view_others_futures": false,
    "view_others_reports": false,
    "view_user_board_updated_at": false
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/roles" -d '{"role":{"name":"Billing Role","billing":true,"followed_users":false,"reminders":false,"safeties":false,"user_board":false,"manage_groups_and_memberships":false,"manage_others_archives":false,"manage_others_futures":false,"manage_others_status":false,"manage_own_archives":false,"manage_own_futures":false,"manage_own_status":false,"view_others_archives":false,"view_others_futures":false,"view_others_reports":false,"view_user_board_updated_at":false}}' -X POST \
	-H "Authorization: Bearer 5de57807cc9aeecbc86a82a1ff8846c9a91e33568d341f122472f881e1084202"

Response

Simulated Response

Response Fields

Name Description
roles (object) the newly created role attributes

Status

201

Headers

ETag: W/"ca5602481ffba93afe8ca2915d7068c4"

Body

{
  "roles": {
    "id": "3199",
    "name": "Billing Role",
    "billing": true,
    "followed_users": false,
    "reminders": false,
    "safeties": false,
    "user_board": false,
    "manage_company_and_users": false,
    "manage_groups_and_memberships": false,
    "manage_others_archives": false,
    "manage_others_futures": false,
    "manage_others_status": false,
    "manage_own_archives": false,
    "manage_own_futures": false,
    "manage_own_status": false,
    "view_others_archives": false,
    "view_others_futures": false,
    "view_others_reports": false,
    "view_user_board_updated_at": false,
    "created_at": 1560187294,
    "updated_at": 1560187294
  },
  "meta": {
    "last_updated_at": {
      "beacons": 1552238494,
      "favorites": 1555262494,
      "fences": 1557163294,
      "groups": 1555694494,
      "networks": 0,
      "roles": 1560187294,
      "settings": 1560187294
    }
  }
}

Delete a role

Deletes an existing role. Users must have a role that permits managing the company to delete roles.

Endpoint

DELETE /api/v4/roles/:id

Request

Route

DELETE /api/v4/roles/3194

Headers

Authorization: Bearer 67f1276b509fd20fea313a29d1f87a0c38bb4e5a763e44147f3fc64bc8c4e7f5

cURL

curl "https://www.simpleinout.com/api/v4/roles/3194" -d '' -X DELETE \
	-H "Authorization: Bearer 67f1276b509fd20fea313a29d1f87a0c38bb4e5a763e44147f3fc64bc8c4e7f5"

Response

Simulated Response

Status

204

List all roles

Return a list of all the roles belonging to the company.

Endpoint

GET /api/v4/roles

Parameters

Name Description
sort (string) order of the return with optional '-' to denote descending, possibilities include: 'name'
page_size (integer) number of results to return per page, defaults to 25
page (integer) page number of results

Request

Route

GET /api/v4/roles

Headers

Authorization: Bearer 2648d3d500890b86dfeb8307e481f95668e677556a91dab429e9df5a234f2164

cURL

curl -g "https://www.simpleinout.com/api/v4/roles" -X GET \
	-H "Authorization: Bearer 2648d3d500890b86dfeb8307e481f95668e677556a91dab429e9df5a234f2164"

Response

Simulated Response

Response Fields

Name Description
roles (array) an array of roles

Status

200

Headers

ETag: W/"97482686f7ae9c19beff9ad305d7eb15"
Last-Modified: Mon, 10 Jun 2019 17:21:34 GMT

Body

{
  "roles": [
    {
      "id": "3205",
      "name": "Administrator",
      "billing": true,
      "followed_users": true,
      "reminders": true,
      "safeties": true,
      "user_board": true,
      "manage_company_and_users": true,
      "manage_groups_and_memberships": true,
      "manage_others_archives": true,
      "manage_others_futures": true,
      "manage_others_status": true,
      "manage_own_archives": true,
      "manage_own_futures": true,
      "manage_own_status": true,
      "view_others_archives": true,
      "view_others_futures": true,
      "view_others_reports": true,
      "view_user_board_updated_at": true,
      "created_at": 1560187294,
      "updated_at": 1560187294
    },
    {
      "id": "3206",
      "name": "Manager",
      "billing": false,
      "followed_users": false,
      "reminders": false,
      "safeties": false,
      "user_board": true,
      "manage_company_and_users": false,
      "manage_groups_and_memberships": false,
      "manage_others_archives": false,
      "manage_others_futures": true,
      "manage_others_status": true,
      "manage_own_archives": false,
      "manage_own_futures": true,
      "manage_own_status": true,
      "view_others_archives": true,
      "view_others_futures": true,
      "view_others_reports": true,
      "view_user_board_updated_at": true,
      "created_at": 1560187294,
      "updated_at": 1560187294
    },
    {
      "id": "3207",
      "name": "Regular User",
      "billing": false,
      "followed_users": false,
      "reminders": false,
      "safeties": false,
      "user_board": true,
      "manage_company_and_users": false,
      "manage_groups_and_memberships": false,
      "manage_others_archives": false,
      "manage_others_futures": false,
      "manage_others_status": false,
      "manage_own_archives": false,
      "manage_own_futures": true,
      "manage_own_status": true,
      "view_others_archives": true,
      "view_others_futures": true,
      "view_others_reports": false,
      "view_user_board_updated_at": true,
      "created_at": 1560187294,
      "updated_at": 1560187294
    },
    {
      "id": "3208",
      "name": "Limited User",
      "billing": false,
      "followed_users": false,
      "reminders": false,
      "safeties": false,
      "user_board": true,
      "manage_company_and_users": false,
      "manage_groups_and_memberships": false,
      "manage_others_archives": false,
      "manage_others_futures": false,
      "manage_others_status": false,
      "manage_own_archives": false,
      "manage_own_futures": false,
      "manage_own_status": false,
      "view_others_archives": true,
      "view_others_futures": true,
      "view_others_reports": false,
      "view_user_board_updated_at": true,
      "created_at": 1560187294,
      "updated_at": 1560187294
    }
  ],
  "meta": {
    "paging": {
      "page": 1,
      "page_size": 25,
      "page_count": 1,
      "count": 4,
      "previous_page": null,
      "next_page": null,
      "first_href": "http://example.org/api/v4/roles",
      "last_href": "http://example.org/api/v4/roles",
      "previous_href": null,
      "next_href": null
    },
    "last_updated_at": {
      "beacons": 1558545694,
      "favorites": 1558372894,
      "fences": 1556472094,
      "groups": 1551982894,
      "networks": 0,
      "roles": 1560187294,
      "settings": 1560187294
    }
  }
}

Retrieve a role

Retrieve an existing role.

Endpoint

GET /api/v4/roles/:id

Request

Route

GET /api/v4/roles/3204

Headers

Authorization: Bearer c5d413080712a24785570ddd5988f8b56a3776703652e7cfa22ad1d0733f2073

cURL

curl -g "https://www.simpleinout.com/api/v4/roles/3204" -X GET \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer c5d413080712a24785570ddd5988f8b56a3776703652e7cfa22ad1d0733f2073"

Response

Simulated Response

Response Fields

Name Description
roles (object) the role attributes

Status

200

Headers

ETag: W/"0186cad2d74c6b2691e3d1a94f675a5e"
Last-Modified: Mon, 10 Jun 2019 17:21:34 GMT

Body

{
  "roles": {
    "id": "3204",
    "name": "Abbott LLC",
    "billing": false,
    "followed_users": false,
    "reminders": false,
    "safeties": false,
    "user_board": false,
    "manage_company_and_users": false,
    "manage_groups_and_memberships": false,
    "manage_others_archives": false,
    "manage_others_futures": false,
    "manage_others_status": false,
    "manage_own_archives": false,
    "manage_own_futures": false,
    "manage_own_status": false,
    "view_others_archives": false,
    "view_others_futures": false,
    "view_others_reports": false,
    "view_user_board_updated_at": false,
    "created_at": 1560187294,
    "updated_at": 1560187294
  },
  "meta": {
    "last_updated_at": {
      "beacons": 1556731294,
      "favorites": 1554571294,
      "fences": 1559323294,
      "groups": 1557768094,
      "networks": 0,
      "roles": 1560187294,
      "settings": 1560187294
    },
    "update_available": false
  }
}

Update a role

Updates an existing role. Users must have a role that permits managing the company to update roles.

Endpoint

PATCH /api/v4/roles/:id

Parameters

Name Description
role[name] (string) the name of the role, no longer than 255 characters, must be unique for the company
role[billing] (boolean) these users can change the company's plan, credit card, and invoice email/information.
role[followed_users] (boolean) these users can receive notifications on their devices when another user updates their status.
role[reminders] (boolean) these users can manage notifications sent to other users reminding them to update their status.
role[safeties] (boolean) these users can receive notifications when another user hasn't updated their status.
role[user_board] (boolean) these users can see other users and their current status.
role[manage_groups_and_memberships] (boolean) these users can manage groups and which users are assigned to each group.
role[manage_others_archives] (boolean) these users can change the past statuses of others by adding and deleting status updates.
role[manage_others_futures] (boolean) these users can schedule future status updates for other users.
role[manage_others_status] (boolean) these users can change the current status of other users.
role[manage_own_archives] (boolean) these users can change their own past statuses by adding and deleting status updates.
role[manage_own_futures] (boolean) these users can schedule future status updates for themselves.
role[manage_own_status] (boolean) these users can update their own status from any device or the website. If a user is not allowed to update their own status, they can only update their status from a common device running FrontDesk or TimeClock.
role[view_others_archives] (boolean) these users can view the past status updates made by other users.
role[view_others_futures] (boolean) these users can view the scheduled status updates for other users.
role[view_others_reports] (boolean) these users can run reports on the status history of other users.
role[view_user_board_updated_at] (boolean) these users can view the time that status updates were made on the board.

Request

Route

PATCH /api/v4/roles/3189

Headers

Authorization: Bearer 2f6ab389dc71087a351a0493603524721151200f066b28871a0000cd53835408

Body

{
  "role": {
    "name": "My Renamed Role",
    "billing": false,
    "view_others_archives": true,
    "view_others_futures": true
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/roles/3189" -d '{"role":{"name":"My Renamed Role","billing":false,"view_others_archives":true,"view_others_futures":true}}' -X PATCH \
	-H "Authorization: Bearer 2f6ab389dc71087a351a0493603524721151200f066b28871a0000cd53835408"

Response

Simulated Response

Response Fields

Name Description
roles (object) the newly updated role attributes

Status

200

Headers

ETag: W/"7134ef41e0f5f717c65fac85404f9283"

Body

{
  "roles": {
    "id": "3189",
    "name": "My Renamed Role",
    "billing": false,
    "followed_users": false,
    "reminders": false,
    "safeties": false,
    "user_board": false,
    "manage_company_and_users": false,
    "manage_groups_and_memberships": false,
    "manage_others_archives": false,
    "manage_others_futures": false,
    "manage_others_status": false,
    "manage_own_archives": false,
    "manage_own_futures": false,
    "manage_own_status": false,
    "view_others_archives": true,
    "view_others_futures": true,
    "view_others_reports": false,
    "view_user_board_updated_at": false,
    "created_at": 1560187294,
    "updated_at": 1560187294
  },
  "meta": {
    "last_updated_at": {
      "beacons": 1553102493,
      "favorites": 1556126493,
      "fences": 1558804893,
      "groups": 1556126493,
      "networks": 0,
      "roles": 1560187294,
      "settings": 1560187293
    }
  }
}

Statuses

List statuses

List all the statuses within the time period specified by the ‘created_at’ date range. Users must have a role that permits viewing the status history of others or only the authorized user’s statuses will be returned.

Endpoint

GET /api/v4/statuses

Parameters

Name Description
page_size (integer) number of results to return per page, defaults to 25
page (integer) page number of results
created_at required (string) a date range string for the time the status was created
status (string) the status, either 'in' or 'out'
comment (string) the comment, case sensitive, included with the status change
user_id (string) the ID of a particular user
sort (string) order of the return with optional '-' to denote descending, possibilities include: 'created_at', 'status', 'comment'
expand (string) comma-delimited list of extra information to include in the response, possibilities include: 'user', 'user.memberships', 'user.memberships.group', 'user.phones', 'changed_by_user', 'application'

Request

Route

GET /api/v4/statuses?created_at=1559538000..1559797199

Headers

Authorization: Bearer c056dab11de6a46b32770a33728c1021bc6e0482422681c74a73196df92e8b37

Query Parameters

created_at=1559538000..1559797199

cURL

curl -g "https://www.simpleinout.com/api/v4/statuses?created_at=1559538000..1559797199" -X GET \
	-H "Authorization: Bearer c056dab11de6a46b32770a33728c1021bc6e0482422681c74a73196df92e8b37"

Response

Simulated Response

Response Fields

Name Description
statuses (array) an array of matching statuses

Status

200

Headers

ETag: W/"28f9d7d77b4ce29d82dec206cf6a74ab"
Last-Modified: Tue, 04 Jun 2019 14:00:00 GMT

Body

{
  "statuses": [
    {
      "status": "in",
      "comment": "At Work",
      "user_id": "1615",
      "changed_by_user_id": null,
      "created_at": 1559545200
    },
    {
      "status": "out",
      "comment": "Left Work",
      "user_id": "1615",
      "changed_by_user_id": null,
      "created_at": 1559559600
    },
    {
      "status": "in",
      "comment": "At Work",
      "user_id": "1615",
      "changed_by_user_id": null,
      "created_at": 1559563200
    },
    {
      "status": "out",
      "comment": "Left Work",
      "user_id": "1615",
      "changed_by_user_id": null,
      "created_at": 1559581200
    },
    {
      "status": "in",
      "comment": "At Work",
      "user_id": "1615",
      "changed_by_user_id": null,
      "created_at": 1559631600
    },
    {
      "status": "out",
      "comment": "Left Work",
      "user_id": "1615",
      "changed_by_user_id": null,
      "created_at": 1559653200
    },
    {
      "status": "out",
      "comment": "On Vacation",
      "user_id": "1615",
      "changed_by_user_id": "1616",
      "created_at": 1559656800
    }
  ],
  "meta": {
    "paging": {
      "page": 1,
      "page_size": 25,
      "page_count": 1,
      "count": 7,
      "previous_page": null,
      "next_page": null,
      "first_href": "http://example.org/api/v4/statuses?created_at=1559538000..1559797199",
      "last_href": "http://example.org/api/v4/statuses?created_at=1559538000..1559797199",
      "previous_href": null,
      "next_href": null
    },
    "last_updated_at": {
      "beacons": 1556731290,
      "favorites": 1558545690,
      "fences": 1559150490,
      "groups": 1552238490,
      "networks": 0,
      "roles": 1560187291,
      "settings": 1560187291
    }
  }
}

Users

Create a future status update for a user

Add a scheduled status for a specific user. Users must have a role that permits managing their own scheduled statuses if updating themselves or be permitted to manage the scheduled statuses of others if updating another user. The company must also have scheduled statuses enabled.

Endpoint

POST /api/v4/users/:id/futures

Parameters

Name Description
future[status] required (string) must be 'in' or 'out'
future[apply_at] required (integer) epoch time to apply status change, must be in the future, have minutes within (00, 15, 30, 45), and seconds of 0
future[comment] (string) up to 50 character description of the status update
expand (string) comma-delimited list of extra information to include in the response, possibilities include: 'user', 'changed_by_user'

Request

Route

POST /api/v4/users/1555/futures

Headers

Authorization: Bearer 4190e4b0870f32154dd5a209a0336a5f147a9dcd0fdb04bf36fe372980711f36

Body

{
  "future": {
    "status": "out",
    "apply_at": 1565456400,
    "comment": "On Vacation"
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/users/1555/futures" -d '{"future":{"status":"out","apply_at":1565456400,"comment":"On Vacation"}}' -X POST \
	-H "Authorization: Bearer 4190e4b0870f32154dd5a209a0336a5f147a9dcd0fdb04bf36fe372980711f36"

Response

Simulated Response

Response Fields

Name Description
futures (object) the newly created future object

Status

201

Headers

ETag: W/"d9b05ffbd27b131778c3673836371713"

Body

{
  "futures": {
    "id": "24",
    "status": "out",
    "comment": "On Vacation",
    "apply_at": 1565456400,
    "user_id": "1555",
    "changed_by_user_id": "1554"
  },
  "meta": {
    "last_updated_at": {
      "beacons": 1551723687,
      "favorites": 1554744087,
      "fences": 1556817687,
      "groups": 1556904087,
      "networks": 0,
      "roles": 1560187287,
      "settings": 1560187287
    }
  }
}

Create a future status update for the current user

Add a scheduled status for the current user. Users must have a role that permits managing their own scheduled statuses and the company must have scheduled statuses enabled.

Endpoint

POST /api/v4/users/my/futures

Parameters

Name Description
future[status] required (string) must be 'in' or 'out'
future[apply_at] required (integer) epoch time to apply status change, must be in the future and have minutes within (00, 15, 30, 45), and seconds of 0
future[comment] (string) up to 50 character description of the status update
expand (string) comma-delimited list of extra information to include in the response, possibilities include: 'user', 'changed_by_user'

Request

Route

POST /api/v4/users/my/futures

Headers

Authorization: Bearer 6c9e643aa76e503e01ef8147facd4d1a651b40433e87b35624401902efbba056

Body

{
  "future": {
    "status": "out",
    "apply_at": 1565456400,
    "comment": "On Vacation"
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/users/my/futures" -d '{"future":{"status":"out","apply_at":1565456400,"comment":"On Vacation"}}' -X POST \
	-H "Authorization: Bearer 6c9e643aa76e503e01ef8147facd4d1a651b40433e87b35624401902efbba056"

Response

Simulated Response

Response Fields

Name Description
futures (object) the newly created future object

Status

201

Headers

ETag: W/"5313563077b50865f8ecf1d1a8b1683e"

Body

{
  "futures": {
    "id": "21",
    "status": "out",
    "comment": "On Vacation",
    "apply_at": 1565456400,
    "user_id": "1541",
    "changed_by_user_id": null
  },
  "meta": {
    "last_updated_at": {
      "beacons": 1557163286,
      "favorites": 1554571286,
      "fences": 1551810086,
      "groups": 1558372886,
      "networks": 0,
      "roles": 1560187286,
      "settings": 1560187286
    }
  }
}

Create a status update for a user

Changes a user’s status. Users must have a role that permits managing their own current status or their own past statuses if updating themselves. Users must be permitted to manage the current status of others or the past status of others if updating another user.

Endpoint

POST /api/v4/users/:id/statuses

Parameters

Name Description
status[status] required (string) must be 'in' or 'out'
status[comment] (string) up to 50 character description of the status update
status[created_at] (integer) epoch time to apply status change, defaults to the current time (if this paramter is passed the date must be in the past)
expand (string) comma-delimited list of extra information to include in the response, possibilities include: 'user', 'user.memberships', 'user.phones', 'user.recents', 'changed_by_user', 'application'

Request

Route

POST /api/v4/users/1521/statuses

Headers

Authorization: Bearer 6a33b3e3074ead613111e0b23b11c1f0ddc3092ce8de878f6fcaf230002b8741

Body

{
  "status": {
    "status": "in",
    "comment": "In at HQ"
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/users/1521/statuses" -d '{"status":{"status":"in","comment":"In at HQ"}}' -X POST \
	-H "Authorization: Bearer 6a33b3e3074ead613111e0b23b11c1f0ddc3092ce8de878f6fcaf230002b8741"

Response

Simulated Response

Response Fields

Name Description
statuses (object) the newly created status object

Status

201

Headers

ETag: W/"eb19eb0b9c6994792b6175c3d6036ca1"

Body

{
  "statuses": {
    "status": "in",
    "comment": "In at HQ",
    "user_id": "1521",
    "changed_by_user_id": "1520",
    "created_at": 1560187285
  },
  "meta": {
    "last_updated_at": {
      "beacons": 1556904084,
      "favorites": 1559755284,
      "fences": 1555435284,
      "groups": 1558977684,
      "networks": 0,
      "roles": 1560187284,
      "settings": 1560187284
    }
  }
}

Create a status update for the current user

Changes the current user’s status. Users must have a role that permits managing their own current status or their own past statuses.

Endpoint

POST /api/v4/users/my/statuses

Parameters

Name Description
status[status] required (string) must be 'in' or 'out'
status[comment] (st`ring) up to 50 character description of the status update
status[created_at] (integer) epoch time to apply status change, defaults to the current time (if this paramter is passed the date must be in the past)
expand (string) comma-delimited list of extra information to include in the response, possibilities include: 'user', 'user.memberships', 'user.phones', 'user.recents', 'changed_by_user', 'application'

Request

Route

POST /api/v4/users/my/statuses

Headers

Authorization: Bearer 5226ccd7564ef23dd4baf1801b17526ba63ecd1a4f84594fc40160edb6329f2c

Body

{
  "status": {
    "status": "in",
    "comment": "In at HQ"
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/users/my/statuses" -d '{"status":{"status":"in","comment":"In at HQ"}}' -X POST \
	-H "Authorization: Bearer 5226ccd7564ef23dd4baf1801b17526ba63ecd1a4f84594fc40160edb6329f2c"

Response

Simulated Response

Response Fields

Name Description
statuses (object) the newly created status object

Status

201

Headers

ETag: W/"676253d703b92796a123b3617d2fc1d8"

Body

{
  "statuses": {
    "status": "in",
    "comment": "In at HQ",
    "user_id": "1528",
    "changed_by_user_id": null,
    "created_at": 1560187285
  },
  "meta": {
    "last_updated_at": {
      "beacons": 1558891285,
      "favorites": 1552929685,
      "fences": 1553361685,
      "groups": 1554916885,
      "networks": 0,
      "roles": 1560187285,
      "settings": 1560187285
    }
  }
}

Create a user

Creates a new user. When this is completed, the user will be sent a welcome email from Simple In/Out with a link to choose their own password. Users must have a role that permits managing the company/users to create users. Companies are limited to the number of users their plan supports, and attempting to add more users will result in a greater_than error on the base parameter.

Endpoint

POST /api/v4/users

Parameters

Name Description
user[email] required (string) new user's email address
user[name] required (string) new user's full name
user[details] (string) additional text information about the user
user[lang] (string) preferred locale of the user defaulting to the locale of the authorized user, can be de, en-au, en-ca, en-gb, en, es, fr-ca, fr, ja, lv, nb, nl, ru, sq, sv
user[phones_attributes] (array) phone objects to attach to the user, each with a 'number' attribute
user[memberships_attributes] (array) membership objects to place the user in the group, each with a 'group_id' attribute
user[role_id] required (string) the ID of the role to assign to the user
only (string) comma-delimited list of fields to render only, possibilities include: 'id', 'name', 'email', 'image_url', 'details', 'lang', 'created_at', 'updated_at', 'cached_at'
expand (string) comma-delimited list of extra information to include in the response, possibilities include: 'memberships', 'memberships.group', 'phones', 'status', 'status.application', 'status.changed_by_user', 'recents', 'role'

Request

Route

POST /api/v4/users

Headers

Authorization: Bearer 5168ded382e5b6b62800fc457a7f2cb194bf48ed6c1bbcb18c50100a168d1fb8

Body

{
  "user": {
    "email": "bojack@horsinaround.com",
    "name": "Bojack Horseman",
    "details": "Lead Actor",
    "lang": "en",
    "phones_attributes": [
      {
        "number": "966-497-9931 x848"
      }
    ],
    "memberships_attributes": [
      {
        "group_id": 180
      }
    ],
    "role_id": "2929"
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/users" -d '{"user":{"email":"bojack@horsinaround.com","name":"Bojack Horseman","details":"Lead Actor","lang":"en","phones_attributes":[{"number":"966-497-9931 x848"}],"memberships_attributes":[{"group_id":180}],"role_id":"2929"}}' -X POST \
	-H "Authorization: Bearer 5168ded382e5b6b62800fc457a7f2cb194bf48ed6c1bbcb18c50100a168d1fb8"

Response

Simulated Response

Response Fields

Name Description
users (object) the newly created user object

Status

201

Headers

ETag: W/"67b09a08d9c0f4b47379661ccf1e4a9f"

Body

{
  "users": {
    "id": "1538",
    "name": "Bojack Horseman",
    "email": "bojack@horsinaround.com",
    "image_url": "https://gravatar.com/avatar/a05868c1d1022f804699801238e5eb07.png?s=270\u0026d=blank",
    "details": "Lead Actor",
    "lang": "en",
    "role_id": "2929",
    "created_at": 1560187286,
    "updated_at": 1560187286,
    "cached_at": "1560187286.420352000"
  },
  "meta": {
    "last_updated_at": {
      "beacons": 1559841686,
      "favorites": 1559236886,
      "fences": 1558891286,
      "groups": 1560187286,
      "networks": 0,
      "roles": 1560187286,
      "settings": 1560187286
    }
  }
}

Delete a user

Deletes an existing user. Users must have a role that permits managing the company/users to delete users. Companies must have at least one user with the Administrator role, if you attempt to delete the last user with the Administrator role, this will result in a less_than error on the base parameter.

Endpoint

DELETE /api/v4/users/:id

Request

Route

DELETE /api/v4/users/1543

Headers

Authorization: Bearer aeb0ec0e2c05a78d91fda61159492e9f5f27d19c945a357a75598ee3124f3346

cURL

curl "https://www.simpleinout.com/api/v4/users/1543" -d '' -X DELETE \
	-H "Authorization: Bearer aeb0ec0e2c05a78d91fda61159492e9f5f27d19c945a357a75598ee3124f3346"

Response

Simulated Response

Status

204

Favorite a status for the current user

Designates a previous status update as a favorite for the current user’s Quick Picks.

Endpoint

PATCH /api/v4/users/my/statuses/favorite

Parameters

Name Description
status[status] required (string) must be 'in' or 'out'
status[comment] (string) up to 50 character description of the status update

Request

Route

PATCH /api/v4/users/my/statuses/favorite

Headers

Authorization: Bearer 7a92049cda860f6fa415f4ee589aad692ab0ed7a77d9965228e3cdfedee4fcc6

Body

{
  "status": {
    "status": "in",
    "comment": "At Lunch"
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/users/my/statuses/favorite" -d '{"status":{"status":"in","comment":"At Lunch"}}' -X PATCH \
	-H "Authorization: Bearer 7a92049cda860f6fa415f4ee589aad692ab0ed7a77d9965228e3cdfedee4fcc6"

Response

Simulated Response

Status

204

Hide a status for the current user

Hides a previous status update from the current user’s Quick Picks.

Endpoint

PATCH /api/v4/users/my/statuses/hide

Parameters

Name Description
status[status] required (string) must be 'in' or 'out'
status[comment] (string) up to 50 character description of the status update

Request

Route

PATCH /api/v4/users/my/statuses/hide

Headers

Authorization: Bearer ecaceac78ec50103db6c7b93fb439271337534c17119d49ea5a60fc30682b9e3

Body

{
  "status": {
    "status": "in",
    "comment": "At Lunch"
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/users/my/statuses/hide" -d '{"status":{"status":"in","comment":"At Lunch"}}' -X PATCH \
	-H "Authorization: Bearer ecaceac78ec50103db6c7b93fb439271337534c17119d49ea5a60fc30682b9e3"

Response

Simulated Response

Status

204

List all future statuses for a user

List all the scheduled statuses for the specified user. Please note that the user making this request must have a role with permission to view the scheduled statuses of others and the company must have scheduled statuses enabled.

Endpoint

GET /api/v4/users/:id/futures

Parameters

Name Description
comment (string) the comment, case sensitive, included with the status change
sort (string) order of the return with optional '-' to denote descending, possibilities include: 'apply_at', 'status', 'comment'
apply_at (string) a date range string for the time the status will be added
expand (string) comma-delimited list of extra information to include in the response, possibilities include: 'user', 'changed_by_user'
page_size (integer) number of results to return per page, defaults to 25
page (integer) page number of results

Request

Route

GET /api/v4/users/1529/futures

Headers

Authorization: Bearer efe8ae9a6d7636063a95ccb66b987d2731d191ccd05d205de9d1c64e3b2b84af

cURL

curl -g "https://www.simpleinout.com/api/v4/users/1529/futures" -X GET \
	-H "Authorization: Bearer efe8ae9a6d7636063a95ccb66b987d2731d191ccd05d205de9d1c64e3b2b84af"

Response

Simulated Response

Response Fields

Name Description
futures (array) an array of matching scheduled statuses

Status

200

Headers

ETag: W/"c034928621e815991d1eaa052f42b9ee"
Last-Modified: Mon, 10 Jun 2019 17:21:25 GMT

Body

{
  "futures": [
    {
      "id": "19",
      "status": "out",
      "comment": "Offsite Meeting",
      "apply_at": 1560754800,
      "user_id": "1529",
      "changed_by_user_id": null
    },
    {
      "id": "20",
      "status": "out",
      "comment": "Gone Fishing",
      "apply_at": 1566212400,
      "user_id": "1529",
      "changed_by_user_id": "1530"
    }
  ],
  "meta": {
    "paging": {
      "page": 1,
      "page_size": 25,
      "page_count": 1,
      "count": 2,
      "previous_page": null,
      "next_page": null,
      "first_href": "http://example.org/api/v4/users/1529/futures?user_id=1529",
      "last_href": "http://example.org/api/v4/users/1529/futures?user_id=1529",
      "previous_href": null,
      "next_href": null
    },
    "last_updated_at": {
      "beacons": 1556299285,
      "favorites": 1558113685,
      "fences": 1558113685,
      "groups": 1553361685,
      "networks": 0,
      "roles": 1560187285,
      "settings": 1560187285
    }
  }
}

List all future statuses for the current user

List all the scheduled statuses for the current user. Please note that the company must have scheduled statuses enabled for users to see their scheduled statuses.

Endpoint

GET /api/v4/users/my/futures

Parameters

Name Description
comment (string) the comment, case sensitive, included with the status change
sort (string) order of the return with optional '-' to denote descending, possibilities include: 'apply_at', 'status', 'comment'
apply_at (string) a date range string for the time the status will be added
expand (string) comma-delimited list of extra information to include in the response, possibilities include: 'user', 'changed_by_user'
page_size (integer) number of results to return per page, defaults to 25
page (integer) page number of results

Request

Route

GET /api/v4/users/my/futures

Headers

Authorization: Bearer 92137027266e0b18473a9b192a33d7b932b46c9c3ac99ced808e731ff89c1c81

cURL

curl -g "https://www.simpleinout.com/api/v4/users/my/futures" -X GET \
	-H "Authorization: Bearer 92137027266e0b18473a9b192a33d7b932b46c9c3ac99ced808e731ff89c1c81"

Response

Simulated Response

Response Fields

Name Description
futures (array) an array of matching scheduled statuses

Status

200

Headers

ETag: W/"00427754cabff2f9513d6efafffd15bd"
Last-Modified: Mon, 10 Jun 2019 17:21:26 GMT

Body

{
  "futures": [
    {
      "id": "22",
      "status": "out",
      "comment": "Offsite Meeting",
      "apply_at": 1560754800,
      "user_id": "1547",
      "changed_by_user_id": null
    },
    {
      "id": "23",
      "status": "out",
      "comment": "Gone Fishing",
      "apply_at": 1566212400,
      "user_id": "1547",
      "changed_by_user_id": "1548"
    }
  ],
  "meta": {
    "paging": {
      "page": 1,
      "page_size": 25,
      "page_count": 1,
      "count": 2,
      "previous_page": null,
      "next_page": null,
      "first_href": "http://example.org/api/v4/users/my/futures?user_id=1547",
      "last_href": "http://example.org/api/v4/users/my/futures?user_id=1547",
      "previous_href": null,
      "next_href": null
    },
    "last_updated_at": {
      "beacons": 1557336086,
      "favorites": 1552756886,
      "fences": 1551723686,
      "groups": 1560014486,
      "networks": 0,
      "roles": 1560187286,
      "settings": 1560187286
    }
  }
}

List all statuses for a user

List all the statuses for the specified user within the time period specified by the ‘created_at’ date range. Users must have a role that permits viewing the past statuses of others if viewing another user. They can always view their own past statuses.

Endpoint

GET /api/v4/users/:id/statuses

Parameters

Name Description
created_at required (string) a date range string for the time the status was created
comment (string) the comment, case sensitive, included with the status change
sort (string) order of the return with optional '-' to denote descending, possibilities include: 'created_at', 'status', 'comment'
expand (string) comma-delimited list of extra information to include in the response, possibilities include: 'user', 'user.memberships', 'user.phones', 'user.recents', 'changed_by_user', 'application'
page_size (integer) number of results to return per page, defaults to 25
page (integer) page number of results

Request

Route

GET /api/v4/users/1526/statuses?created_at=1559538000..1559797199

Headers

Authorization: Bearer e7811f0d6d855d4e0a6f74a8830e30fd99963f9d1fbfe113157dc96cb97e0a5d

Query Parameters

created_at=1559538000..1559797199

cURL

curl -g "https://www.simpleinout.com/api/v4/users/1526/statuses?created_at=1559538000..1559797199" -X GET \
	-H "Authorization: Bearer e7811f0d6d855d4e0a6f74a8830e30fd99963f9d1fbfe113157dc96cb97e0a5d"

Response

Simulated Response

Response Fields

Name Description
statuses (array) an array of matching statuses

Status

200

Headers

ETag: W/"27b207b63546d1a297ecaaca4522baab"
Last-Modified: Tue, 04 Jun 2019 14:00:00 GMT

Body

{
  "statuses": [
    {
      "status": "in",
      "comment": "At Work",
      "user_id": "1526",
      "changed_by_user_id": null,
      "created_at": 1559545200
    },
    {
      "status": "out",
      "comment": "Left Work",
      "user_id": "1526",
      "changed_by_user_id": null,
      "created_at": 1559559600
    },
    {
      "status": "in",
      "comment": "At Work",
      "user_id": "1526",
      "changed_by_user_id": null,
      "created_at": 1559563200
    },
    {
      "status": "out",
      "comment": "Left Work",
      "user_id": "1526",
      "changed_by_user_id": null,
      "created_at": 1559581200
    },
    {
      "status": "in",
      "comment": "At Work",
      "user_id": "1526",
      "changed_by_user_id": null,
      "created_at": 1559631600
    },
    {
      "status": "out",
      "comment": "Left Work",
      "user_id": "1526",
      "changed_by_user_id": null,
      "created_at": 1559653200
    },
    {
      "status": "out",
      "comment": "Vacation",
      "user_id": "1526",
      "changed_by_user_id": "1527",
      "created_at": 1559656800
    }
  ],
  "meta": {
    "paging": {
      "page": 1,
      "page_size": 25,
      "page_count": 1,
      "count": 7,
      "previous_page": null,
      "next_page": null,
      "first_href": "http://example.org/api/v4/users/1526/statuses?created_at=1559538000..1559797199\u0026user_id=1526",
      "last_href": "http://example.org/api/v4/users/1526/statuses?created_at=1559538000..1559797199\u0026user_id=1526",
      "previous_href": null,
      "next_href": null
    },
    "last_updated_at": {
      "beacons": 1554657685,
      "favorites": 1557076885,
      "fences": 1559582485,
      "groups": 1558545685,
      "networks": 0,
      "roles": 1560187285,
      "settings": 1560187285
    }
  }
}

List all statuses for the current user

List all the statuses for the current user within the time period specified by the ‘created_at’ date range.

Endpoint

GET /api/v4/users/my/statuses

Parameters

Name Description
created_at required (string) a date range string for the time the status was created
comment (string) the comment, case sensitive, included with the status change
sort (string) order of the return with optional '-' to denote descending, possibilities include: 'created_at', 'status', 'comment'
expand (string) comma-delimited list of extra information to include in the response, possibilities include: 'user', 'user.memberships', 'user.phones', 'user.recents', 'changed_by_user', 'application'
page_size (integer) number of results to return per page, defaults to 25
page (integer) page number of results

Request

Route

GET /api/v4/users/my/statuses?created_at=1559538000..1559797199

Headers

Authorization: Bearer 5b912c4cbe8074f8c0474575c49ca7480fb0f01c031bf7c1cb4cdfb03ebe8d50

Query Parameters

created_at=1559538000..1559797199

cURL

curl -g "https://www.simpleinout.com/api/v4/users/my/statuses?created_at=1559538000..1559797199" -X GET \
	-H "Authorization: Bearer 5b912c4cbe8074f8c0474575c49ca7480fb0f01c031bf7c1cb4cdfb03ebe8d50"

Response

Simulated Response

Response Fields

Name Description
statuses (array) an array of matching statuses

Status

200

Headers

ETag: W/"bb84b7237436e0d4e18df741786214f9"
Last-Modified: Tue, 04 Jun 2019 14:00:00 GMT

Body

{
  "statuses": [
    {
      "status": "in",
      "comment": "At Work",
      "user_id": "1532",
      "changed_by_user_id": null,
      "created_at": 1559545200
    },
    {
      "status": "out",
      "comment": "Left Work",
      "user_id": "1532",
      "changed_by_user_id": null,
      "created_at": 1559559600
    },
    {
      "status": "in",
      "comment": "At Work",
      "user_id": "1532",
      "changed_by_user_id": null,
      "created_at": 1559563200
    },
    {
      "status": "out",
      "comment": "Left Work",
      "user_id": "1532",
      "changed_by_user_id": null,
      "created_at": 1559581200
    },
    {
      "status": "in",
      "comment": "At Work",
      "user_id": "1532",
      "changed_by_user_id": null,
      "created_at": 1559631600
    },
    {
      "status": "out",
      "comment": "Left Work",
      "user_id": "1532",
      "changed_by_user_id": null,
      "created_at": 1559653200
    },
    {
      "status": "out",
      "comment": "Vacation",
      "user_id": "1532",
      "changed_by_user_id": "1533",
      "created_at": 1559656800
    }
  ],
  "meta": {
    "paging": {
      "page": 1,
      "page_size": 25,
      "page_count": 1,
      "count": 7,
      "previous_page": null,
      "next_page": null,
      "first_href": "http://example.org/api/v4/users/my/statuses?created_at=1559538000..1559797199\u0026user_id=1532",
      "last_href": "http://example.org/api/v4/users/my/statuses?created_at=1559538000..1559797199\u0026user_id=1532",
      "previous_href": null,
      "next_href": null
    },
    "last_updated_at": {
      "beacons": 1554312085,
      "favorites": 1554571285,
      "fences": 1559841685,
      "groups": 1555435285,
      "networks": 0,
      "roles": 1560187285,
      "settings": 1560187285
    }
  }
}

List all users

Return a list of all the users belonging to the company. Users must have a role that permits viewing users.

Endpoint

GET /api/v4/users

Parameters

Name Description
page_size (integer) number of results to return per page, defaults to 25
page (integer) page number of results
name (string) return users with this name
email (string) return users with this email
id (array) return users by an array of ids
group_id (string/array) return users belonging to a group id, which can be a string or array in the form of group_id[]=INT
cached_at (integer/float) return users updated that have made a significant change since an epoch time, accurate to nanoseconds
sort (string) order of the return with optional '-' to denote descending, possibilities include: 'name', 'email', 'cached_at', 'status.status', 'status.created_at'
only (string) comma-delimited list of fields to render only, possibilities include: 'id', 'name', 'email', 'image_url', 'details', 'lang', 'created_at', 'updated_at', 'cached_at'
expand (string) comma-delimited list of extra information to include in the response, possibilities include: 'memberships', 'memberships.group', 'phones', 'status', 'status.application', 'status.changed_by_user', 'recents', 'role'

Request

Route

GET /api/v4/users

Headers

Authorization: Bearer 68e537e7b26388b08edc91c42db10c6ef1c2c57f0c147e1b212cee2f5708b383

cURL

curl -g "https://www.simpleinout.com/api/v4/users" -X GET \
	-H "Authorization: Bearer 68e537e7b26388b08edc91c42db10c6ef1c2c57f0c147e1b212cee2f5708b383"

Response

Simulated Response

Response Fields

Name Description
users (array) an array of users
trusted_cached_at (string in the meta object) the server time minus an amount to account for network delivery time

Status

200

Headers

ETag: W/"59ba92ed96575e9c4cbb5c4bf300a5a4"
Last-Modified: Mon, 10 Jun 2019 17:21:27 GMT

Body

{
  "users": [
    {
      "id": "1562",
      "name": "Lavern Spinka",
      "email": "nia@millerhane.io",
      "image_url": "https://gravatar.com/avatar/fd9629793ffb1088288fb64b4f32b96b.png?s=270\u0026d=blank",
      "details": "Provident aliquid nihil.",
      "lang": "en",
      "role_id": "2979",
      "created_at": 1560187287,
      "updated_at": 1560187287,
      "cached_at": "1560187287.749134000"
    },
    {
      "id": "1561",
      "name": "Emmett Champlin",
      "email": "wendie@huels.biz",
      "image_url": "https://gravatar.com/avatar/f0d426f2a6d6dc240d95c8e75dbd8806.png?s=270\u0026d=blank",
      "details": "Quos dignissimos adipisci.",
      "lang": "en",
      "role_id": "2979",
      "created_at": 1560187287,
      "updated_at": 1560187287,
      "cached_at": "1560187287.735418800"
    },
    {
      "id": "1560",
      "name": "Renaldo Rodriguez",
      "email": "davebartoletti@dickinson.net",
      "image_url": "https://gravatar.com/avatar/cd23e24b8958b14a9e469c04f09e246b.png?s=270\u0026d=blank",
      "details": "Doloribus dignissimos qui.",
      "lang": "en",
      "role_id": "2979",
      "created_at": 1560187287,
      "updated_at": 1560187287,
      "cached_at": "1560187287.718234800"
    },
    {
      "id": "1559",
      "name": "Tatiana Mayert",
      "email": "carlineyost@langoshberge.name",
      "image_url": "https://gravatar.com/avatar/c0f44495d1427e490c2512390b6f04e3.png?s=270\u0026d=blank",
      "details": "Et ullam nihil.",
      "lang": "en",
      "role_id": "2977",
      "created_at": 1560187287,
      "updated_at": 1560187287,
      "cached_at": "1560187287.706734200"
    }
  ],
  "meta": {
    "paging": {
      "page": 1,
      "page_size": 25,
      "page_count": 1,
      "count": 4,
      "previous_page": null,
      "next_page": null,
      "first_href": "http://example.org/api/v4/users",
      "last_href": "http://example.org/api/v4/users",
      "previous_href": null,
      "next_href": null
    },
    "last_updated_at": {
      "beacons": 1557422487,
      "favorites": 1554052887,
      "fences": 1554571287,
      "groups": 1558372887,
      "networks": 0,
      "roles": 1560187287,
      "settings": 1560187287
    },
    "trusted_cached_at": "1560187272.767866800"
  }
}

Retrieve a user

Retrieve an existing user. Users must have a role that permits viewing users.

Endpoint

GET /api/v4/users/:id

Parameters

Name Description
only (string) comma-delimited list of fields to render only, possibilities include: 'id', 'name', 'email', 'image_url', 'details', 'lang', 'created_at', 'updated_at', 'cached_at'
expand (string) comma-delimited list of extra information to include in the response, possibilities include: 'memberships', 'memberships.group', 'phones', 'status', 'status.application', 'status.changed_by_user', 'recents', 'role'

Request

Route

GET /api/v4/users/1525

Headers

Authorization: Bearer efddf236c6835bea6eb07fa77e298b701d4a1a6071bf56de89f17be1aa390673

cURL

curl -g "https://www.simpleinout.com/api/v4/users/1525" -X GET \
	-H "Authorization: Bearer efddf236c6835bea6eb07fa77e298b701d4a1a6071bf56de89f17be1aa390673"

Response

Simulated Response

Response Fields

Name Description
users (object) a user object

Status

200

Headers

ETag: W/"f10c85ddd58b2ea5e4bd45c12708d588"
Last-Modified: Mon, 10 Jun 2019 17:21:25 GMT

Body

{
  "users": {
    "id": "1525",
    "name": "James Olson",
    "email": "armandagulgowski@hane.net",
    "image_url": "https://gravatar.com/avatar/558790c2fe210f11be6d9e91f9e178ce.png?s=270\u0026d=blank",
    "details": "Ex sed est.",
    "lang": "en",
    "role_id": "2903",
    "created_at": 1560187285,
    "updated_at": 1560187285,
    "cached_at": "1560187285.363047800"
  },
  "meta": {
    "last_updated_at": {
      "beacons": 1560014485,
      "favorites": 1553880085,
      "fences": 1558027285,
      "groups": 1554312085,
      "networks": 0,
      "roles": 1560187285,
      "settings": 1560187285
    }
  }
}

Retrieve the current user

Retrieve the current user who is authorized.

Endpoint

GET /api/v4/users/my

Parameters

Name Description
only (string) comma-delimited list of fields to render only, possibilities include: 'id', 'name', 'email', 'image_url', 'details', 'lang', 'created_at', 'updated_at', 'cached_at'
expand (string) comma-delimited list of extra information to include in the response, possibilities include: 'memberships', 'memberships.group', 'phones', 'status', 'status.application', 'status.changed_by_user', 'recents', 'role'

Request

Route

GET /api/v4/users/my

Headers

Authorization: Bearer cbc5eebec323e64cdb4a46c11e585d4cdd70a9bc7eac81589c3cf86db5b58e27

cURL

curl -g "https://www.simpleinout.com/api/v4/users/my" -X GET \
	-H "Authorization: Bearer cbc5eebec323e64cdb4a46c11e585d4cdd70a9bc7eac81589c3cf86db5b58e27"

Response

Simulated Response

Response Fields

Name Description
users (object) a user object

Status

200

Headers

ETag: W/"99e9de26e5064794476d84798b4506c2"
Last-Modified: Mon, 10 Jun 2019 17:21:27 GMT

Body

{
  "users": {
    "id": "1558",
    "name": "Fidela Johnson DDS",
    "email": "virgina@kilbackkuphal.biz",
    "image_url": "https://gravatar.com/avatar/5bc37873378aa7501535bd4be49258a0.png?s=270\u0026d=blank",
    "details": "Ullam accusamus amet.",
    "lang": "en",
    "role_id": "2975",
    "created_at": 1560187287,
    "updated_at": 1560187287,
    "cached_at": "1560187287.625797000"
  },
  "meta": {
    "last_updated_at": {
      "beacons": 1554312087,
      "favorites": 1559755287,
      "fences": 1553448087,
      "groups": 1557854487,
      "networks": 0,
      "roles": 1560187287,
      "settings": 1560187287
    }
  }
}

Unfavorite a status for the current user

Undoes a previous status’ favorite designation for the current user’s Quick Picks.

Endpoint

PATCH /api/v4/users/my/statuses/unfavorite

Parameters

Name Description
status[status] required (string) must be 'in' or 'out'
status[comment] (string) up to 50 character description of the status update

Request

Route

PATCH /api/v4/users/my/statuses/unfavorite

Headers

Authorization: Bearer 1404e6ccd22f183baf4fc2040b621dcf88d4b1ed84a77815e59c8bd70f671e03

Body

{
  "status": {
    "status": "in",
    "comment": "At Lunch"
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/users/my/statuses/unfavorite" -d '{"status":{"status":"in","comment":"At Lunch"}}' -X PATCH \
	-H "Authorization: Bearer 1404e6ccd22f183baf4fc2040b621dcf88d4b1ed84a77815e59c8bd70f671e03"

Response

Simulated Response

Status

204

Update a user

Updates an existing user. Users must have a role that permits managing the company/users to update users. Companies must have at least one user with the Administrator role, if you attempt to change the role of the last user with the Administrator role, this will result in a less_than error on the base parameter.

Endpoint

PATCH /api/v4/users/:id

Parameters

Name Description
user[email] (string) new user's email address
user[name] (string) new user's full name
user[details] (string) additional text information about the user
user[lang] (string) preferred locale of the user, can be de, en-au, en-ca, en-gb, en, es, fr-ca, fr, ja, lv, nb, nl, ru, sq, sv
user[phones_attributes] (array) phone objects to attach to the user if both 'id' and 'number' are passed in, the existing phone number will be updated if just 'number' is passed in, a new phone will be added if both 'id' and '_destroy' are passed in ('_destroy' being truthy like 'true' or '1'), the phone number will be removed
user[memberships_attributes] (array) group objects to attach to the user if both 'id' and 'group_id' are passed in, the existing membership will be updated if just 'group_id' is passed in, a new membership will be added if both 'id' and '_destroy' are passed in ('_destroy' being truthy like 'true' or '1'), the group membership will be removed
user[role_id] (string) the ID of the role to assign to the user
only (string) comma-delimited list of fields to render only, possibilities include: 'id', 'name', 'email', 'image_url', 'details', 'lang', 'created_at', 'updated_at', 'cached_at'
expand (string) comma-delimited list of extra information to include in the response, possibilities include: 'memberships', 'memberships.group', 'phones', 'status', 'status.application', 'status.changed_by_user', 'recents', 'role'

Request

Route

PATCH /api/v4/users/1564

Headers

Authorization: Bearer f5984c7bb64c088ec40ef81c4f554c671cdb9f9b28e4ecfefffe54ca6514364d

Body

{
  "user": {
    "phones_attributes": [
      {
        "number": "1-283-049-9934 x738"
      }
    ],
    "memberships_attributes": [
      {
        "group_id": 184
      }
    ]
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/users/1564" -d '{"user":{"phones_attributes":[{"number":"1-283-049-9934 x738"}],"memberships_attributes":[{"group_id":184}]}}' -X PATCH \
	-H "Authorization: Bearer f5984c7bb64c088ec40ef81c4f554c671cdb9f9b28e4ecfefffe54ca6514364d"

Response

Simulated Response

Response Fields

Name Description
users (object) the newly updated user attributes

Status

200

Headers

ETag: W/"28dec69e032c6fdd90b8f2002ed114ec"

Body

{
  "users": {
    "id": "1564",
    "name": "Zella Steuber DDS",
    "email": "tyraschmeler@cummingskovacek.info",
    "image_url": "https://gravatar.com/avatar/5e2795333b9dddd6a91ddee0097e3ecd.png?s=270\u0026d=blank",
    "details": "Quod nesciunt tenetur.",
    "lang": "en",
    "role_id": "2983",
    "created_at": 1560187287,
    "updated_at": 1560187287,
    "cached_at": "1560187287.917592000"
  },
  "meta": {
    "last_updated_at": {
      "beacons": 1552411287,
      "favorites": 1553275287,
      "fences": 1557336087,
      "groups": 1560187287,
      "networks": 0,
      "roles": 1560187287,
      "settings": 1560187287
    }
  }
}

Update the current user

Updates the currently authorized user. The current user cannot update their own role.

Endpoint

PATCH /api/v4/users/my

Parameters

Name Description
user[email] (string) new user's email address
user[name] (string) new user's full name
user[details] (string) additional text information about the user
user[lang] (string) preferred locale of the user, can be de, en-au, en-ca, en-gb, en, es, fr-ca, fr, ja, lv, nb, nl, ru, sq, sv
user[phones_attributes] (array) phone objects to attach to the user if both 'id' and 'number' are passed in, the existing phone number will be updated if just 'number' is passed in, a new phone will be added if both 'id' and '_destroy' are passed in ('_destroy' being truthy like 'true' or '1'), the phone number will be removed
user[memberships_attributes] (array) group objects to attach to the user if both 'id' and 'group_id' are passed in, the existing membership will be updated if just 'group_id' is passed in, a new membership will be added if both 'id' and '_destroy' are passed in ('_destroy' being truthy like 'true' or '1') the group membership will be removed
only (string) comma-delimited list of fields to render only, possibilities include: 'id', 'name', 'email', 'image_url', 'details', 'lang', 'created_at', 'updated_at', 'cached_at'
expand (string) comma-delimited list of extra information to include in the response, possibilities include: 'memberships', 'memberships.group', 'phones', 'status', 'status.application', 'status.changed_by_user', 'recents', 'role'

Request

Route

PATCH /api/v4/users/my

Headers

Authorization: Bearer 01c675eb7375f828804e6467fadf7c61c451220980d1b6e27f78193e1aa0b598

Body

{
  "user": {
    "phones_attributes": [
      {
        "number": "684.726.1885 x5826"
      }
    ],
    "memberships_attributes": [
      {
        "group_id": 179
      }
    ]
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/users/my" -d '{"user":{"phones_attributes":[{"number":"684.726.1885 x5826"}],"memberships_attributes":[{"group_id":179}]}}' -X PATCH \
	-H "Authorization: Bearer 01c675eb7375f828804e6467fadf7c61c451220980d1b6e27f78193e1aa0b598"

Response

Simulated Response

Response Fields

Name Description
users (object) the newly updated user attributes

Status

200

Headers

ETag: W/"c650b686f09e8506fb6470dffc7f7fdb"

Body

{
  "users": {
    "id": "1536",
    "name": "Marvella Moore Jr.",
    "email": "ivorygreenholt@coleoconnell.io",
    "image_url": "https://gravatar.com/avatar/b0e09552e0c378ae6da4b1a9a252adc0.png?s=270\u0026d=blank",
    "details": "Laboriosam ut laudantium.",
    "lang": "en",
    "role_id": "2925",
    "created_at": 1560187286,
    "updated_at": 1560187286,
    "cached_at": "1560187286.323866100"
  },
  "meta": {
    "last_updated_at": {
      "beacons": 1557595286,
      "favorites": 1555176086,
      "fences": 1557768086,
      "groups": 1560187286,
      "networks": 0,
      "roles": 1560187286,
      "settings": 1560187286
    }
  }
}