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.

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": {
    "announcements": 1435258926,
    "beacons": 1435250484,
    "favorites": 1437151284,
    "fences": 1436546484,
    "groups": 1436287284,
    "networks": 1436287284,
    "settings": 1439916084
  },
  emergency: nil
}}

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 specifically what was invalid with the input. Please note that while the key will typically be a parameter on the object, it can occasionally 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.


3001: Device Cannot Follow Everyone and Specific Groups

This device is following everyone, so following users in a specific group is prohibited.


3002: Device Cannot Follow Everyone and Specific Users

This device is following everyone, so following a specific user is prohibited.


3003: You May Not Follow Yourself

A device isn’t allowed to follow the user who is also authenticated on the device.


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 the object, some data was either missing or invalid. The full message of this error will provide more explanation.


5006: No Company Badge Salt

You’ve attempted to print badges for TimeClock, but the company has not created any badges.


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.


5011: Invalid SIO-Version Header

The format of the SIO-Version request header is invalid.


5012: Invalid JSON

The posted JSON body is invalid.


5013: Invalid Page Size of Zero

The page_size parameter cannot be zero.


5014: Invalid mime-type requested

An invalid mime-type was requested.


6001: Expired User Code

The user-facing device code that was attempted to authorize has expired.


6002: Invalid User Code

The user-facing device code that was attempted to authorize does not exist, and is therefore invalid.

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,
      "user_board": true,
      "manage_all_announcements": true,
      "manage_company_and_users": false,
      "manage_groups_and_memberships": false,
      "manage_member_announcements": 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,
      "member_board": false,
      "manage_member_archives": false,
      "manage_member_futures": false,
      "manage_member_status": false,
      "view_all_announcements": true,
      "view_member_announcements": false,
      "view_member_archives": false,
      "view_member_futures": false,
      "view_member_reports": false,
      "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 three event types: status.new, status.schedule, 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 incoming 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@simplymadeapps.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"
    }
  }
}



Announcements

Create a announcement

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

Punto de llegada

POST /api/v4/announcements

Parametros

Name Description
announcement[message] requerido (string) the name of the announcement
announcement[push] (boolean) whether this announcement should trigger a push notification to users, defaults to false
announcement[group_id] (string) restrict the announcement to a specific group, defaults to no restrictions
announcement[expires_at] (integer) the epoch time when the announcement should expire, defaults to no expiration
expand (string) comma-delimited list of extra information to include in the response, possibilities include: 'user'

Solicitud

Ruta

POST /api/v4/announcements

Encabezados

Content-Type: application/json
Authorization: Bearer r0YM_8bV_jru7xDeVwX4_d9s-GNiT9FX00oLfEtZ1kE

Cuerpo

{
  "announcement": {
    "message": "Evacuate the building",
    "push": false,
    "group_id": "7",
    "expires_at": 1747187011
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/announcements" -d '{"announcement":{"message":"Evacuate the building","push":false,"group_id":"7","expires_at":1747187011}}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer r0YM_8bV_jru7xDeVwX4_d9s-GNiT9FX00oLfEtZ1kE"

Respuesta

Simulated Response

Campos de respuesta

Name Description
announcements (object) the newly created announcement attributes

Estado

201

Encabezados

ETag: W/"69cf3d0e336ff67ac0d4b472491090bd"

Cuerpo

{
  "announcements": {
    "id": "3",
    "group_id": "7",
    "user_id": "69",
    "message": "Evacuate the building",
    "push": false,
    "expires_at": 1747187011,
    "created_at": 1747100611,
    "updated_at": 1747100611
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1747100611,
      "beacons": 1742435011,
      "desktop_presences": 1744681411,
      "favorites": 1745631811,
      "fences": 1745459011,
      "groups": 1747100611,
      "networks": 1739501011,
      "roles": 1747100611,
      "settings": 1747100611
    },
    "emergency": null
  }
}

Delete an announcement

Deletes an existing announcement. Users must have a role that permits managing the announcements to delete announcements.

Punto de llegada

DELETE /api/v4/announcements/:id

Solicitud

Ruta

DELETE /api/v4/announcements/4

Encabezados

Content-Type: application/json
Authorization: Bearer BGk23MHXuXP9DdJqQkkLgKr_cVgRJftX-zvOEUmFDHg

cURL

curl "https://www.simpleinout.com/api/v4/announcements/4" -d '' -X DELETE \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer BGk23MHXuXP9DdJqQkkLgKr_cVgRJftX-zvOEUmFDHg"

Respuesta

Simulated Response

Estado

204

List all announcements

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

Punto de llegada

GET /api/v4/announcements

Parametros

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
expand (string) comma-delimited list of extra information to include in the response, possibilities include: 'user'

Solicitud

Ruta

GET /api/v4/announcements

Encabezados

Content-Type: application/json
Authorization: Bearer 4D_tz4KgBhS5pE-4xB7mUvvo__e3H6_KZjiVL5icKl4

cURL

curl -g "https://www.simpleinout.com/api/v4/announcements" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer 4D_tz4KgBhS5pE-4xB7mUvvo__e3H6_KZjiVL5icKl4"

Respuesta

Simulated Response

Campos de respuesta

Name Description
announcements (array) an array of announcements

Estado

200

Encabezados

ETag: W/"ef57799951f5fad1af8e535018936a1a"
Last-Modified: Tue, 13 May 2025 01:43:31 GMT

Cuerpo

{
  "announcements": [
    {
      "id": "1",
      "group_id": null,
      "user_id": "68",
      "message": "Possimus ad aut voluptas.",
      "push": false,
      "expires_at": 1747187011,
      "created_at": 1747100611,
      "updated_at": 1747100611
    },
    {
      "id": "2",
      "group_id": null,
      "user_id": "68",
      "message": "Deleniti officiis recusandae eum.",
      "push": false,
      "expires_at": 1747187011,
      "created_at": 1747100611,
      "updated_at": 1747100611
    }
  ],
  "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/announcements",
      "last_href": "http://example.org/api/v4/announcements",
      "previous_href": null,
      "next_href": null
    },
    "last_updated_at": {
      "announcements": 1747100611,
      "beacons": 1741315411,
      "desktop_presences": 1747100611,
      "favorites": 1743126211,
      "fences": 1739155411,
      "groups": 1740365011,
      "networks": 1744076611,
      "roles": 1747100611,
      "settings": 1747100611
    },
    "emergency": null
  }
}

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.

Punto de llegada

GET /oauth/authorize

Parametros

Name Description
response_type requerido (string) the type of authorization to use, in this case always 'code'
client_id requerido (string) your API client key
redirect_uri requerido (string) the URI to return the user to after authenticating, must match those registered with Simple In/Out
scope requerido (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, de, es, fr, fr-ca. Defaults to 'en'

Solicitud

Ruta

GET /oauth/authorize?response_type=code&client_id=PLACE_YOUR_API_CLIENT_ID_HERE&redirect_uri=https%3A%2F%2Fwww.simplymadeapps.com%2Fredirect%2Furl&scope=write&locale=en

Encabezados

Content-Type: application/json

Parámetros de la consulta

response_type=code
client_id=PLACE_YOUR_API_CLIENT_ID_HERE
redirect_uri=https://www.simplymadeapps.com/redirect/url
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%2Fwww.simplymadeapps.com%2Fredirect%2Furl&scope=write&locale=en" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json"

Respuesta

Simulated Response

Estado

302

Authorization (Device)

Authorization is required to access the Simple In/Out API. This API will produce everything needed to display a code and URL to the user to authorize a device. Once this API has returned, polling can begin to the Device Grant to discover the user’s information after they have authorized.

Punto de llegada

POST /oauth/authorize_device

Parametros

Name Description
client_id requerido (string) your API client key
client_secret requerido (string) your API client secret
scope requerido (string) requested scope, must be 'executive'

Solicitud

Ruta

POST /oauth/authorize_device

Encabezados

Content-Type: application/json

Cuerpo

{
  "client_id": "PLACE_YOUR_API_CLIENT_ID_HERE",
  "client_secret": "PLACE_YOUR_API_CLIENT_SECRET_HERE",
  "scope": "executive"
}

cURL

curl "https://www.simpleinout.com/oauth/authorize_device" -d '{"client_id":"PLACE_YOUR_API_CLIENT_ID_HERE","client_secret":"PLACE_YOUR_API_CLIENT_SECRET_HERE","scope":"executive"}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json"

Respuesta

Simulated Response

Campos de respuesta

Name Description
device_code (string) the private code used to poll within the Device Grant
expires_in (integer) the number of seconds until these codes will expire
interval (integer) the number of seconds between polling events, any developer polling faster than this will receive 'slow_down' errors
user_code (string) the public code to display to the user
verification_uri (string) the public URL to display to the user
verification_uri_complete (string) the public URL to use if generating a QR code

Estado

200

Encabezados

ETag: W/"dbec0496b473d75c60e5abb7fcb23971"

Cuerpo

{
  "device_code": "Uin0-hocvBS_3dZVuk2w1E3vODw-kJUJQBrOL9bXssY",
  "user_code": "UDP3H8TK",
  "verification_uri": "http://example.org/code",
  "verification_uri_complete": "http://example.org/code?user_code=UDP3H8TK",
  "expires_in": 300,
  "interval": 5
}

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.

Punto de llegada

POST /oauth/token

Parametros

Name Description
grant_type requerido (string) type of grant to use
client_id requerido (string) your API client key
client_secret requerido (string) your API client secret
code requerido (string) if using Authorization Code grant, this is the code that is returned from Simple In/Out
redirect_uri requerido (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'

Solicitud

Ruta

POST /oauth/token

Encabezados

Content-Type: application/json

Cuerpo

{
  "grant_type": "authorization_code",
  "client_id": "YOUR_API_CLIENT_ID",
  "client_secret": "YOUR_API_CLIENT_SECRET",
  "code": "3OWM4fF8NyYwTlyYxse7aeGcIXD7WWBYfX-X61j5TNs",
  "redirect_uri": "https://www.simplymadeapps.com/redirect/url"
}

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":"3OWM4fF8NyYwTlyYxse7aeGcIXD7WWBYfX-X61j5TNs","redirect_uri":"https://www.simplymadeapps.com/redirect/url"}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json"

Respuesta

Simulated Response

Campos de respuesta

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.

Estado

200

Encabezados

ETag: W/"7fad90b26bd15d481e3c9b469c82707f"

Cuerpo

{
  "access_token": "xOw5hVkrmDBISqQ2FAYdO0UB1WE4aO3IEyp7E9iFI1o",
  "token_type": "Bearer",
  "expires_in": 7200,
  "refresh_token": "shlKgfasiaPyzNgPromRq0G-evJgqG37p51I3oh8JeM",
  "scope": "write",
  "created_at": 1747100613,
  "user": {
    "id": "134",
    "company_id": "81",
    "roles": {
      "id": "325",
      "name": "Administrator",
      "billing": true,
      "followed_users": true,
      "reminders": true,
      "safeties": true,
      "user_board": true,
      "manage_all_announcements": true,
      "manage_company_and_users": true,
      "manage_member_announcements": false,
      "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,
      "member_board": false,
      "manage_member_archives": false,
      "manage_member_futures": false,
      "manage_member_status": false,
      "view_all_announcements": true,
      "view_member_announcements": false,
      "view_member_archives": false,
      "view_member_futures": false,
      "view_member_reports": false,
      "created_at": 1747100613,
      "updated_at": 1747100613
    }
  }
}

Client Credentials grant

Client Credentials should be used for accessing the API generally, not attached to a specific user. Only the create company API allows the Client Credentials grant type as it is the only one that doesn’t require a specific user. This grant type is available for Simply Made Apps clients only.

Punto de llegada

POST /oauth/token

Parametros

Name Description
grant_type requerido (string) type of grant to use, in this case 'client_credentials'
client_id requerido (string) your API client key
client_secret requerido (string) your API client secret
scope requerido (string) requested scope, required to be 'executive'

Solicitud

Ruta

POST /oauth/token

Encabezados

Content-Type: application/json

Cuerpo

{
  "grant_type": "client_credentials",
  "client_id": "YOUR_API_CLIENT_ID",
  "client_secret": "YOUR_API_CLIENT_SECRET",
  "scope": "executive"
}

cURL

curl "https://www.simpleinout.com/oauth/token" -d '{"grant_type":"client_credentials","client_id":"YOUR_API_CLIENT_ID","client_secret":"YOUR_API_CLIENT_SECRET","scope":"executive"}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json"

Respuesta

Simulated Response

Campos de respuesta

Name Description
access_token (string) the access token used to make API requests
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 (always nil in this case)

Estado

200

Encabezados

ETag: W/"976f74e8e3d5b18aa5ad9fc5aba90b7b"

Cuerpo

{
  "access_token": "1eIp7-gV_XFV5pajvGOXlHqhTZcADXFLLp-oP-coKwo",
  "token_type": "Bearer",
  "expires_in": 7200,
  "scope": "executive",
  "created_at": 1747100613,
  "user": null
}

Device Code grant

Device Codes are used to generate API tokens for users based on codes displayed on devices (televisions, tablets). A private device code is required, which is not shown to the user, and the user will need to authorize via a user code that is smaller and displayed for them to enter into the Simple In/Out website. This grant type is available for Simply Made Apps clients only.

When successful, a status code of 200 will be returned along with tokens and information about the authorized user. When unsuccessful, a status code of 400 will be returned along with a JSON payload with an “error” key. The error key has several possible values.

  • authorization_pending is returned when the user hasn’t yet authorize this device code yet, but may in the future.
  • expired_token is returned when the user did not authorize and the device code is now expired (dead).
  • slow_down is returned when the developer is polling for a response faster than the agreed upon interval. Don’t do this.

Punto de llegada

POST /oauth/token

Parametros

Name Description
client_id requerido (string) your API client key
client_secret requerido (string) your API client secret
device_code requerido (string) private device_code to check
grant_type requerido (string) type of grant to use, in this case always 'urn:ietf:params:oauth:grant-type:device_code'

Solicitud

Ruta

POST /oauth/token

Encabezados

Content-Type: application/json

Cuerpo

{
  "client_id": "YOUR_API_CLIENT_ID",
  "client_secret": "YOUR_API_CLIENT_SECRET",
  "device_code": "uGbsz38p0Hxq4ne0o-LKe7N-BIxVC9yfEGTZH9Zyv5A",
  "grant_type": "urn:ietf:params:oauth:grant-type:device_code"
}

cURL

curl "https://www.simpleinout.com/oauth/token" -d '{"client_id":"YOUR_API_CLIENT_ID","client_secret":"YOUR_API_CLIENT_SECRET","device_code":"uGbsz38p0Hxq4ne0o-LKe7N-BIxVC9yfEGTZH9Zyv5A","grant_type":"urn:ietf:params:oauth:grant-type:device_code"}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Sio-Version: 1.0.0" \
	-H "Content-Type: application/json"

Respuesta

Simulated Response

Campos de respuesta

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.

Estado

200

Encabezados

ETag: W/"6f02bd8a334f1999b50ad536aecf8311"

Cuerpo

{
  "access_token": "p0KtaScd67D4Z9leiSjlG8qbUQbPc23WRFecCNyYT7k",
  "token_type": "Bearer",
  "expires_in": 7200,
  "refresh_token": "RfsrudPMdI2b5TXJclasYz2zLWbqAqu9X9DPmUEERC4",
  "scope": "executive",
  "created_at": 1747100613,
  "user": {
    "id": "129",
    "company_id": "77",
    "roles": {
      "id": "309",
      "name": "Administrator",
      "billing": true,
      "followed_users": true,
      "reminders": true,
      "safeties": true,
      "user_board": true,
      "manage_all_announcements": true,
      "manage_company_and_users": true,
      "manage_member_announcements": false,
      "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,
      "member_board": false,
      "manage_member_archives": false,
      "manage_member_futures": false,
      "manage_member_status": false,
      "view_all_announcements": true,
      "view_member_announcements": false,
      "view_member_archives": false,
      "view_member_futures": false,
      "view_member_reports": false,
      "created_at": 1747100613,
      "updated_at": 1747100613
    }
  }
}

Password grant

Password should be used for accessing the API for a specific user. Our Password grant type accepts username (email) and password. This grant type is available for Simply Made Apps clients only.

Punto de llegada

POST /oauth/token

Parametros

Name Description
grant_type requerido (string) type of grant to use, in this case always 'password'
client_id requerido (string) your API client key
client_secret requerido (string) your API client secret
username requerido (string) the email address of your user
password requerido (string) ths password of your user
scope requerido (string) requested scope, always 'executive'

Solicitud

Ruta

POST /oauth/token

Encabezados

Content-Type: application/json

Cuerpo

{
  "grant_type": "password",
  "client_id": "YOUR_API_CLIENT_ID",
  "client_secret": "YOUR_API_CLIENT_SECRET",
  "username": "sterling@simplymadeapps.com",
  "password": "abcdef123456",
  "scope": "executive"
}

cURL

curl "https://www.simpleinout.com/oauth/token" -d '{"grant_type":"password","client_id":"YOUR_API_CLIENT_ID","client_secret":"YOUR_API_CLIENT_SECRET","username":"sterling@simplymadeapps.com","password":"abcdef123456","scope":"executive"}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Sio-Version: 1.0.0" \
	-H "Content-Type: application/json"

Respuesta

Simulated Response

Campos de respuesta

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.

Estado

200

Encabezados

ETag: W/"37f2a07be5d1c1e1c3225099332b0daa"

Cuerpo

{
  "access_token": "d7Z9tYg30xIc9ShRMoYmrWjFBdcUbzJjCqyR_BEwPYk",
  "token_type": "Bearer",
  "expires_in": 7200,
  "refresh_token": "cjM1XIzvpf2f0nqa9IWCrIzuzyRRxkO6lKAmtB99xVw",
  "scope": "executive",
  "created_at": 1747100613,
  "user": {
    "id": "130",
    "company_id": "78",
    "roles": {
      "id": "313",
      "name": "Administrator",
      "billing": true,
      "followed_users": true,
      "reminders": true,
      "safeties": true,
      "user_board": true,
      "manage_all_announcements": true,
      "manage_company_and_users": true,
      "manage_member_announcements": false,
      "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,
      "member_board": false,
      "manage_member_archives": false,
      "manage_member_futures": false,
      "manage_member_status": false,
      "view_all_announcements": true,
      "view_member_announcements": false,
      "view_member_archives": false,
      "view_member_futures": false,
      "view_member_reports": false,
      "created_at": 1747100613,
      "updated_at": 1747100613
    }
  }
}

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.

Punto de llegada

POST /oauth/token

Parametros

Name Description
grant_type requerido (string) type of grant to use, in this case always 'refresh_token'
client_id requerido (string) your API client key
client_secret requerido (string) your API client secret
refresh_token requerido (string) your refresh token

Solicitud

Ruta

POST /oauth/token

Encabezados

Content-Type: application/json

Cuerpo

{
  "grant_type": "refresh_token",
  "client_id": "YOUR_API_CLIENT_ID",
  "client_secret": "YOUR_API_CLIENT_SECRET",
  "refresh_token": "hvssj6rm80jg9bu0sw63biw902amysyc"
}

cURL

curl "https://www.simpleinout.com/oauth/token" -d '{"grant_type":"refresh_token","client_id":"YOUR_API_CLIENT_ID","client_secret":"YOUR_API_CLIENT_SECRET","refresh_token":"hvssj6rm80jg9bu0sw63biw902amysyc"}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json"

Respuesta

Simulated Response

Campos de respuesta

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.

Estado

200

Encabezados

ETag: W/"c59c1b1c5e3b8336c68bf5fe4d7fdd22"

Cuerpo

{
  "access_token": "enjO8Sm0uIkwj1mqY8MGq5hffGONzMftB3GBWW4jecg",
  "token_type": "Bearer",
  "expires_in": 604800,
  "refresh_token": "I7p4vaTDeVGZ6vWh5loUOmO-l-XjE5ze3kn-Hgr_1MM",
  "scope": "write",
  "created_at": 1747100613,
  "user": {
    "id": "133",
    "company_id": "80",
    "roles": {
      "id": "321",
      "name": "Administrator",
      "billing": true,
      "followed_users": true,
      "reminders": true,
      "safeties": true,
      "user_board": true,
      "manage_all_announcements": true,
      "manage_company_and_users": true,
      "manage_member_announcements": false,
      "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,
      "member_board": false,
      "manage_member_archives": false,
      "manage_member_futures": false,
      "manage_member_status": false,
      "view_all_announcements": true,
      "view_member_announcements": false,
      "view_member_archives": false,
      "view_member_futures": false,
      "view_member_reports": false,
      "created_at": 1747100613,
      "updated_at": 1747100613
    }
  }
}

Revoke a token

Revokes a token, rendering it invalid.

Punto de llegada

POST /oauth/revoke

Parametros

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

Solicitud

Ruta

POST /oauth/revoke

Encabezados

Content-Type: application/json

Cuerpo

{
  "client_id": "8766766880844",
  "client_secret": "2746352484348",
  "token": "xzvyfvdY_-HijUk0BfFrK7eI71dTgwQBmYfLjrBgOtw"
}

cURL

curl "https://www.simpleinout.com/oauth/revoke" -d '{"client_id":"8766766880844","client_secret":"2746352484348","token":"xzvyfvdY_-HijUk0BfFrK7eI71dTgwQBmYfLjrBgOtw"}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json"

Respuesta

Simulated Response

Estado

200

Encabezados

ETag: W/"44136fa355b3678a1146ad16f7e8649e"

Cuerpo

{
}

Token information

Provides details about the OAuth token.

Punto de llegada

GET /oauth/token/info

Solicitud

Ruta

GET /oauth/token/info

Encabezados

Content-Type: application/json
Authorization: Bearer -XwTmjo9rLCnV_8TuTBIKPhHsnybAaiBK1RAd3rODrQ

cURL

curl -g "https://www.simpleinout.com/oauth/token/info" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer -XwTmjo9rLCnV_8TuTBIKPhHsnybAaiBK1RAd3rODrQ"

Respuesta

Simulated Response

Campos de respuesta

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

Estado

200

Encabezados

ETag: W/"8137b27e5a513dba22839af08ceb388a"

Cuerpo

{
  "resource_owner_id": 132,
  "scope": [
    "read"
  ],
  "expires_in": 604800,
  "application": {
    "uid": "5682348363938"
  },
  "created_at": 1747100613
}

Automatic Update Events

Create an automatic update event

Creates new automatic update events. Users must have a role that permits managing their own current status.

Punto de llegada

POST /api/v4/automatic_update_events

Parametros

Name Description
automatic_update_events requerido (array) the array of parameters for each of the events
automatic_update_events[][abandoned_at] (float) epoch time, with precision, for when the device stopped trying to post the event to the server
automatic_update_events[][device_id] requerido (string) the unique identifier of the user's device
automatic_update_events[][event_type] requerido (string) the type of event, either 'entry' or 'exit'
automatic_update_events[][trigger_id] requerido (string) the unique identifier of the item that triggered the event
automatic_update_events[][trigger_type] requerido (string) the type of item that triggered the event, 'Beacon', 'Fence', or 'Network'
automatic_update_events[][triggered_at] requerido (float) epoch time, with precision, for when the event was originally triggered

Solicitud

Ruta

POST /api/v4/automatic_update_events

Encabezados

Content-Type: application/json
Authorization: Bearer Ry4nk9jrUseGN4wUHaS_vIqyRioEMRbXdvowUKTwhdE

Cuerpo

{
  "automatic_update_events": [
    {
      "abandoned_at": 1747100553.791828,
      "device_id": 19,
      "event_type": "entry",
      "trigger_id": 6,
      "trigger_type": "Beacon",
      "triggered_at": 1747100493.795109
    },
    {
      "device_id": 19,
      "event_type": "exit",
      "trigger_id": "noop-deleted-beacon",
      "trigger_type": "Beacon",
      "triggered_at": 1747100613.795116
    }
  ]
}

cURL

curl "https://www.simpleinout.com/api/v4/automatic_update_events" -d '{"automatic_update_events":[{"abandoned_at":1747100553.791828,"device_id":19,"event_type":"entry","trigger_id":6,"trigger_type":"Beacon","triggered_at":1747100493.795109},{"device_id":19,"event_type":"exit","trigger_id":"noop-deleted-beacon","trigger_type":"Beacon","triggered_at":1747100613.795116}]}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer Ry4nk9jrUseGN4wUHaS_vIqyRioEMRbXdvowUKTwhdE"

Respuesta

Simulated Response

Campos de respuesta

Name Description
automatic_update_events (array) contains the ids of the created events or errors from the invalid events

Estado

201

Encabezados

ETag: W/"0d22dd125c7dfea86a88d64cb7426be7"

Cuerpo

{
  "automatic_update_events": [
    {
      "id": "2"
    },
    {
      "id": null,
      "errors": {
        "trigger": "blank"
      }
    }
  ],
  "meta": {
    "last_updated_at": {
      "announcements": 1744249413,
      "beacons": 1747100613,
      "desktop_presences": 1743644613,
      "favorites": 1745804613,
      "fences": 1739328213,
      "groups": 1745199813,
      "networks": 1745631813,
      "roles": 1747100613,
      "settings": 1747100613
    },
    "emergency": null,
    "update_available": false
  }
}

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.

Punto de llegada

POST /api/v4/beacons

Parametros

Name Description
beacon[name] requerido (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', 'remote', 'busy', 'break', 'out', 'sick', 'vacation', or 'off', defaults to 'in'
beacon[status_on_exit] (string) the status to apply on exit: 'in', 'remote', 'busy', 'break', 'out', 'sick', 'vacation', or 'off', defaults to 'out'

Solicitud

Ruta

POST /api/v4/beacons

Encabezados

Content-Type: application/json
Authorization: Bearer TyyTg24hLNwE4-WKBYLsmsOXoEPz3KLZHWk4mkl74k4

Cuerpo

{
  "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 "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer TyyTg24hLNwE4-WKBYLsmsOXoEPz3KLZHWk4mkl74k4"

Respuesta

Simulated Response

Campos de respuesta

Name Description
beacons (object) the newly created beacon attributes

Estado

201

Encabezados

ETag: W/"c01e25f02b88a0d643afbb2fbad81b4e"

Cuerpo

{
  "beacons": {
    "id": "2",
    "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": 1747100611,
    "updated_at": 1747100611
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1740537811,
      "beacons": 1747100611,
      "desktop_presences": 1746927811,
      "favorites": 1739933011,
      "fences": 1741830211,
      "groups": 1745891011,
      "networks": 1744249411,
      "roles": 1747100611,
      "settings": 1747100611
    },
    "emergency": null
  }
}

Delete a beacon

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

Punto de llegada

DELETE /api/v4/beacons/:id

Solicitud

Ruta

DELETE /api/v4/beacons/1

Encabezados

Content-Type: application/json
Authorization: Bearer Dy7u8RX38_dZsoPhPNoCvBFTS-63ITvS9KWCfjbZ1kQ

cURL

curl "https://www.simpleinout.com/api/v4/beacons/1" -d '' -X DELETE \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer Dy7u8RX38_dZsoPhPNoCvBFTS-63ITvS9KWCfjbZ1kQ"

Respuesta

Simulated Response

Estado

204

List all beacons

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

Punto de llegada

GET /api/v4/beacons

Parametros

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

Solicitud

Ruta

GET /api/v4/beacons

Encabezados

Content-Type: application/json
Authorization: Bearer EEpeVBuxaOolYKlQ8LmdlhNeIp0B8nzGaaLXqmLNSMI

cURL

curl -g "https://www.simpleinout.com/api/v4/beacons" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer EEpeVBuxaOolYKlQ8LmdlhNeIp0B8nzGaaLXqmLNSMI"

Respuesta

Simulated Response

Campos de respuesta

Name Description
beacons (array) an array of beacons

Estado

200

Encabezados

ETag: W/"b989da116dc3be48496c56e78af23e07"
Last-Modified: Tue, 13 May 2025 01:43:31 GMT

Cuerpo

{
  "beacons": [
    {
      "id": "4",
      "name": "3 - Sanjuanitamouth",
      "uuid": "8EA2672F-EDE2-4D0A-AF01-3E01A8F79A34",
      "comment_on_entry": "In at 3 - Sanjuanitamouth",
      "comment_on_exit": "Left 3 - Sanjuanitamouth",
      "entry": true,
      "exit": true,
      "status_on_entry": "in",
      "status_on_exit": "out",
      "created_at": 1747100611,
      "updated_at": 1747100611
    },
    {
      "id": "5",
      "name": "4 - Kassulkefurt",
      "uuid": "2FB606D4-BCB0-430C-B02D-C40AA8C2CFC4",
      "comment_on_entry": "In at 4 - Kassulkefurt",
      "comment_on_exit": "Left 4 - Kassulkefurt",
      "entry": true,
      "exit": true,
      "status_on_entry": "in",
      "status_on_exit": "out",
      "created_at": 1747100611,
      "updated_at": 1747100611
    }
  ],
  "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": {
      "announcements": 1743731011,
      "beacons": 1747100611,
      "desktop_presences": 1746409411,
      "favorites": 1740105811,
      "fences": 1742348611,
      "groups": 1742348611,
      "networks": 1739933011,
      "roles": 1747100611,
      "settings": 1747100611
    },
    "emergency": null
  }
}

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.

Punto de llegada

PATCH /api/v4/beacons/:id

Parametros

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', 'remote', 'busy', 'break', 'out', 'sick', 'vacation', or 'off', defaults to 'in'
beacon[status_on_exit] (string) the status to apply on exit: 'in', 'remote', 'busy', 'break', 'out', 'sick', 'vacation', or 'off', defaults to 'out'

Solicitud

Ruta

PATCH /api/v4/beacons/3

Encabezados

Content-Type: application/json
Authorization: Bearer 7tW8XNiBQKpjucQDkq2H3ecC__4KjBU4f1wIUA5VN0I

Cuerpo

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

cURL

curl "https://www.simpleinout.com/api/v4/beacons/3" -d '{"beacon":{"name":"My Renamed Office"}}' -X PATCH \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer 7tW8XNiBQKpjucQDkq2H3ecC__4KjBU4f1wIUA5VN0I"

Respuesta

Simulated Response

Campos de respuesta

Name Description
beacons (object) the newly updated beacon attributes

Estado

200

Encabezados

ETag: W/"f4a7de714b0eea55e967dcc3d98be981"

Cuerpo

{
  "beacons": {
    "id": "3",
    "name": "My Renamed Office",
    "uuid": "0D288BA3-8785-45B8-B984-1F8EE68EC1CB",
    "comment_on_entry": "In at 2 - Cathernburgh",
    "comment_on_exit": "Left 2 - Cathernburgh",
    "entry": true,
    "exit": true,
    "status_on_entry": "in",
    "status_on_exit": "out",
    "created_at": 1747100611,
    "updated_at": 1747100611
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1742089411,
      "beacons": 1747100611,
      "desktop_presences": 1741571011,
      "favorites": 1744767811,
      "fences": 1747100611,
      "groups": 1743126211,
      "networks": 1745459011,
      "roles": 1747100611,
      "settings": 1747100611
    },
    "emergency": null
  }
}

Codes

Authorize a user code

Authorize a user-facing code for access to the API. This is the equivalent to what simpleinout.com/code does for a user when entering this code. When scanning a QR code on a phone with the Simple In/Out app installed, it is presumed that there is a greater chance the user is authenticated in the app vs the website.

If an error occurs, the error code will be in the 6xxx series of errors. Refer to the error handling docs at the top of this readme for details.

This API requires executive scope (Simply Made Apps only).

Punto de llegada

POST /api/v4/codes

Parametros

Name Description
user_code requerido (string) the public-facing user code scanned by user

Solicitud

Ruta

POST /api/v4/codes

Encabezados

Content-Type: application/json
Authorization: Bearer Ap84IewHUhF0fLXS4h4WUncApLDCQmqgJ57v9Hfih0Q

Cuerpo

{
  "user_code": "WLMEDDOV"
}

cURL

curl "https://www.simpleinout.com/api/v4/codes" -d '{"user_code":"WLMEDDOV"}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer Ap84IewHUhF0fLXS4h4WUncApLDCQmqgJ57v9Hfih0Q"

Respuesta

Simulated Response

Estado

204

Companies

Create Badges PDF

Schedules a new PDF of badges to be created. This will be created in the background due to the length of time it may take to complete. The return will indicate where the badges will be stored when finished, and it is the responsibility of the developer to check that destination for the finished result. If the company does not have a ‘badge_salt’ yet set, this API will return a 404.

Users must have a role that permits managing the company to generate badges.

Punto de llegada

GET /api/v4/companies/my/badges

Parametros

Name Description
title Title to display on badges, defaults to company name
paper Paper type for badge printing, accepts US_LETTER, AVERY_5264, or BADGY, defaults to US_LETTER

Solicitud

Ruta

GET /api/v4/companies/my/badges?title=Badges&paper=AVERY_5264

Encabezados

Content-Type: application/json
Authorization: Bearer hidLOiA3oU1zzITcCuYH4ENvK6nMeWlmDsUc3XXcINA

Parámetros de la consulta

title=Badges
paper=AVERY_5264

cURL

curl -g "https://www.simpleinout.com/api/v4/companies/my/badges?title=Badges&paper=AVERY_5264" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer hidLOiA3oU1zzITcCuYH4ENvK6nMeWlmDsUc3XXcINA"

Respuesta

Simulated Response

Campos de respuesta

Name Description
badges (object) badges object containing the URL the PDF will be stored at

Estado

202

Cuerpo

{
  "badges": {
    "url": "https://s3.amazonaws.com/simpleinout-development/badges/badges-421747100611.pdf"
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1743385411,
      "beacons": 1742867011,
      "desktop_presences": 1741916611,
      "favorites": 1740797011,
      "fences": 1738809811,
      "groups": 1739673811,
      "networks": 1739241811,
      "roles": 1747100611,
      "settings": 1747100611
    },
    "emergency": null,
    "update_available": false
  }
}

Create a company

Creates a new company. The company defaults to the Pro 50 trial plan. This API requires a user-less Client Credential grant, and you must have executive scope (Simply Made Apps only).

Punto de llegada

POST /api/v4/companies

Parametros

Name Description
company[name] requerido (string) the name of the company
user[user_name] requerido (string) the name of the first user, who is also the admin
user[email] requerido (string) the email of the first user, who is also the admin
user[password] requerido (string) the password of the first user, who is also the admin
user[lang] requerido (string) the language code for the first user, defaults to 'en'
expand (string) comma-delimited list of extra information to include in the response, possibilities include: 'announcements', 'announcements.user', 'billing', 'beacons', 'desktop_presences', 'fences', 'groups', 'favorites', 'networks', 'roles'

Solicitud

Ruta

POST /api/v4/companies

Encabezados

Content-Type: application/json
Authorization: Bearer IxNkudEsKvg_raUgFB6FaTj33uQHCj99kS01RKj4hiE

Cuerpo

{
  "company": {
    "name": "My Company"
  },
  "user": {
    "user_name": "Bojack Horseman",
    "email": "bojack@simplymadeapps.com",
    "password": "abcdef123456"
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/companies" -d '{"company":{"name":"My Company"},"user":{"user_name":"Bojack Horseman","email":"bojack@simplymadeapps.com","password":"abcdef123456"}}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer IxNkudEsKvg_raUgFB6FaTj33uQHCj99kS01RKj4hiE"

Respuesta

Simulated Response

Campos de respuesta

Name Description
companies[name] (string) the authorized user's company name
companies[available_statuses] (array) the statuses that are available to the company
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[badge_salt] (string) badge salt for TimeClock
companies[theme] (string) the currently selected theme color for the company
companies[super_company] (object) id and name of the super-company
companies[created_at] (integer) epoch time the company was created

Estado

201

Encabezados

ETag: W/"3ef6c0871c7ebd802cb725ece81684dc"

Cuerpo

{
  "companies": {
    "id": "46",
    "announcements_enabled": true,
    "available_statuses": [
      "in",
      "remote",
      "busy",
      "break",
      "out",
      "sick",
      "vacation"
    ],
    "name": "My Company",
    "scheduled_statuses": true,
    "default_role_id": "183",
    "logo_url": null,
    "created_at": 1747100611
  },
  "meta": {
    "last_updated_at": {
      "announcements": 0,
      "beacons": 0,
      "desktop_presences": 0,
      "favorites": 0,
      "fences": 0,
      "groups": 0,
      "networks": 0,
      "roles": 1747100611,
      "settings": 1747100611
    },
    "emergency": null,
    "update_available": false
  }
}

Create/Update company badge salt

Creates a new badge salt. If a badge salt already exists, this will overwrite it with a new one. Users must have a role that permits managing the company to create a new badge salt.

Punto de llegada

POST /api/v4/companies/my/badges

Parametros

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

Solicitud

Ruta

POST /api/v4/companies/my/badges

Encabezados

Content-Type: application/json
Authorization: Bearer c5qx9ZSzQcgBnLWmDRxU3nBYYIIF_Ev9sPuAD7__s_c

cURL

curl "https://www.simpleinout.com/api/v4/companies/my/badges" -d '' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer c5qx9ZSzQcgBnLWmDRxU3nBYYIIF_Ev9sPuAD7__s_c"

Respuesta

Simulated Response

Campos de respuesta

Name Description
companies (object) the newly updated company attributes

Estado

200

Encabezados

ETag: W/"2c26384deede5f07a6a896f7fca4b023"

Cuerpo

{
  "companies": {
    "id": "44",
    "announcements_enabled": true,
    "available_statuses": [
      "in",
      "out"
    ],
    "name": "Senger Inc",
    "scheduled_statuses": true,
    "default_role_id": "175",
    "logo_url": null,
    "created_at": 1747100611,
    "badge_salt": "41af05361ad582d8890bf1da2284ffa4",
    "theme": "blue",
    "super_company": null
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1742175811,
      "beacons": 1747100611,
      "desktop_presences": 1743299011,
      "favorites": 1746409411,
      "fences": 1742175811,
      "groups": 1738809811,
      "networks": 1744681411,
      "roles": 1747100611,
      "settings": 1747100611
    },
    "emergency": null,
    "update_available": false
  }
}

Create/Update company favorites

Creates company-wide favorites. If company favorites exist, they will be overwritten by the new ones. Users must have a role that permits managing the company to create favorites. Companies are limited to 50 favorites.

Punto de llegada

POST /api/v4/companies/my/favorites

Parametros

Name Description
favorites requerido (array) array of objects consisting of 'status' and 'comment'
expand (string) comma-delimited list of extra information to include in the response, possibilities include: 'announcements', 'announcements.user', 'billing', 'beacons', 'desktop_presences', 'fences', 'groups', 'favorites', 'networks', 'roles'

Solicitud

Ruta

POST /api/v4/companies/my/favorites

Encabezados

Content-Type: application/json
Authorization: Bearer gPCI2BMmsbTIrvqP65la8dJgXhyYQ96JJPPbinmjggM

Cuerpo

{
  "favorites": [
    {
      "status": "in",
      "comment": "At Work"
    },
    {
      "status": "out",
      "comment": "On Vacation"
    }
  ],
  "expand": "favorites"
}

cURL

curl "https://www.simpleinout.com/api/v4/companies/my/favorites" -d '{"favorites":[{"status":"in","comment":"At Work"},{"status":"out","comment":"On Vacation"}],"expand":"favorites"}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer gPCI2BMmsbTIrvqP65la8dJgXhyYQ96JJPPbinmjggM"

Respuesta

Simulated Response

Campos de respuesta

Name Description
companies (object) the updated company attributes

Estado

200

Encabezados

ETag: W/"0d173a1ba73f639fec0f6c4f44d5e185"

Cuerpo

{
  "companies": {
    "id": "43",
    "announcements_enabled": true,
    "available_statuses": [
      "in",
      "out"
    ],
    "name": "Hoppe LLC",
    "scheduled_statuses": true,
    "default_role_id": "171",
    "logo_url": null,
    "created_at": 1747100611,
    "badge_salt": null,
    "theme": "blue",
    "super_company": null,
    "favorites": [
      {
        "status": "in",
        "comment": "At Work"
      },
      {
        "status": "out",
        "comment": "On Vacation"
      }
    ]
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1746841411,
      "beacons": 1744335811,
      "desktop_presences": 1745459011,
      "favorites": 1747100611,
      "fences": 1742607811,
      "groups": 1741830211,
      "networks": 1739501011,
      "roles": 1747100611,
      "settings": 1747100611
    },
    "emergency": null,
    "update_available": false
  }
}

Retrieve the current company

Return the company the authorized user belongs to.

Punto de llegada

GET /api/v4/companies/my

Parametros

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

Solicitud

Ruta

GET /api/v4/companies/my

Encabezados

Content-Type: application/json
Authorization: Bearer HJw6x2ceMIHuKG2PPZKEhLypLDIvOm4-Icl8E7idkYw

cURL

curl -g "https://www.simpleinout.com/api/v4/companies/my" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer HJw6x2ceMIHuKG2PPZKEhLypLDIvOm4-Icl8E7idkYw"

Respuesta

Simulated Response

Campos de respuesta

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[available_statuses] (array) the statuses that are available to the company
companies[badge_salt] (string) badge salt for TimeClock
companies[theme] (string) the currently selected theme color for the company
companies[super_company] (object) id and name of the super-company
companies[created_at] (integer) epoch time the company was created

Estado

200

Encabezados

ETag: W/"0afa9dff8a65ebf5bb3150a72e40951d"
Last-Modified: Tue, 13 May 2025 01:43:31 GMT

Cuerpo

{
  "companies": {
    "id": "47",
    "announcements_enabled": true,
    "available_statuses": [
      "in",
      "out"
    ],
    "name": "Kessler-Gutkowski",
    "scheduled_statuses": true,
    "default_role_id": "187",
    "logo_url": null,
    "created_at": 1747100611,
    "badge_salt": null,
    "theme": "blue",
    "super_company": null
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1742867011,
      "beacons": 1741056211,
      "desktop_presences": 1739933011,
      "favorites": 1739933011,
      "fences": 1746236611,
      "groups": 1746755011,
      "networks": 1739414611,
      "roles": 1747100611,
      "settings": 1747100611
    },
    "emergency": null,
    "update_available": false
  }
}

Desktop Presences

Create a desktop presence

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

Punto de llegada

POST /api/v4/desktop_presences

Parametros

Name Description
desktop_presence[name] requerido (string) the name of the desktop presences, no longer than 44 characters
desktop_presence[comment_on_entry] (string) the comment applied to status updates on entry, defaults to 'In at {name}'
desktop_presence[comment_on_exit] (string) the comment applied to status updates on exit, defaults to 'Left {name}'
desktop_presence[status_on_entry] (string) the status to apply on entry: 'in', 'remote', 'busy', 'break', 'out', 'sick', 'vacation', or 'off', defaults to 'in'
desktop_presence[status_on_exit] (string) the status to apply on exit: 'in', 'remote', 'busy', 'break', 'out', 'sick', 'vacation', or 'off', defaults to 'out'

Solicitud

Ruta

POST /api/v4/desktop_presences

Encabezados

Content-Type: application/json
Authorization: Bearer 27A7b_X4DJeN-3gdwM3LI8k63zIQuQQU_zjuFs0ZNoQ

Cuerpo

{
  "desktop_presence": {
    "name": "Home"
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/desktop_presences" -d '{"desktop_presence":{"name":"Home"}}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer 27A7b_X4DJeN-3gdwM3LI8k63zIQuQQU_zjuFs0ZNoQ"

Respuesta

Simulated Response

Campos de respuesta

Name Description
desktop_presences (object) the newly created desktop presence attributes

Estado

201

Encabezados

ETag: W/"fa96d8cd64ff32a25206f478957e0c09"

Cuerpo

{
  "desktop_presences": {
    "id": "1",
    "name": "Home",
    "comment_on_entry": "In at Home",
    "comment_on_exit": "Left Home",
    "idle_time": 10,
    "status_on_entry": "in",
    "status_on_exit": "out",
    "created_at": 1747100611,
    "updated_at": 1747100611
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1741315411,
      "beacons": 1740624211,
      "desktop_presences": 1747100611,
      "favorites": 1745891011,
      "fences": 1742521411,
      "groups": 1742953411,
      "networks": 1745804611,
      "roles": 1747100611,
      "settings": 1747100611
    },
    "emergency": null
  }
}

Delete a desktop presence

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

Punto de llegada

DELETE /api/v4/desktop_presences/:id

Solicitud

Ruta

DELETE /api/v4/desktop_presences/5

Encabezados

Content-Type: application/json
Authorization: Bearer tViMx5qZptJhW2IRLYhUItnmV57sISzudmCj1A7TulI

cURL

curl "https://www.simpleinout.com/api/v4/desktop_presences/5" -d '' -X DELETE \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer tViMx5qZptJhW2IRLYhUItnmV57sISzudmCj1A7TulI"

Respuesta

Simulated Response

Estado

204

List all desktop presences

Return a list of all the desktop presences belonging to the company.

Punto de llegada

GET /api/v4/desktop_presences

Parametros

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

Solicitud

Ruta

GET /api/v4/desktop_presences

Encabezados

Content-Type: application/json
Authorization: Bearer q5tweBIYvQNWS6nf-34fzoMijLv0LvavxoS0SZQrwRA

cURL

curl -g "https://www.simpleinout.com/api/v4/desktop_presences" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer q5tweBIYvQNWS6nf-34fzoMijLv0LvavxoS0SZQrwRA"

Respuesta

Simulated Response

Campos de respuesta

Name Description
desktop_presences (array) an array of desktop presences

Estado

200

Encabezados

ETag: W/"ee49c3a38dffefa8ddc25726a6eebb09"
Last-Modified: Tue, 13 May 2025 01:43:31 GMT

Cuerpo

{
  "desktop_presences": [
    {
      "id": "3",
      "name": "2 - Lake Kent",
      "comment_on_entry": "In at 2 - Lake Kent",
      "comment_on_exit": "Left 2 - Lake Kent",
      "idle_time": 10,
      "status_on_entry": "in",
      "status_on_exit": "out",
      "created_at": 1747100611,
      "updated_at": 1747100611
    },
    {
      "id": "4",
      "name": "3 - New Cliff",
      "comment_on_entry": "In at 3 - New Cliff",
      "comment_on_exit": "Left 3 - New Cliff",
      "idle_time": 10,
      "status_on_entry": "in",
      "status_on_exit": "out",
      "created_at": 1747100611,
      "updated_at": 1747100611
    }
  ],
  "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/desktop_presences",
      "last_href": "http://example.org/api/v4/desktop_presences",
      "previous_href": null,
      "next_href": null
    },
    "last_updated_at": {
      "announcements": 1740451411,
      "beacons": 1742607811,
      "desktop_presences": 1747100611,
      "favorites": 1741571011,
      "fences": 1745891011,
      "groups": 1744249411,
      "networks": 1744854211,
      "roles": 1747100611,
      "settings": 1747100611
    },
    "emergency": null
  }
}

Update a desktop presence

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

Punto de llegada

PATCH /api/v4/desktop_presences/:id

Parametros

Name Description
desktop_presence[name] (string) the name of the desktop presence, no longer than 44 characters
desktop_presence[comment_on_entry] (string) the comment applied to status updates on entry, defaults to 'In at {name}'
desktop_presence[comment_on_exit] (string) the comment applied to status updates on exit, defaults to 'Left {name}'
desktop_presence[status_on_entry] (string) the status to apply on entry: 'in', 'remote', 'busy', 'break', 'out', 'sick', 'vacation', or 'off', defaults to 'in'
desktop_presence[status_on_exit] (string) the status to apply on exit: 'in', 'remote', 'busy', 'break', 'out', 'sick', 'vacation', or 'off', defaults to 'out'

Solicitud

Ruta

PATCH /api/v4/desktop_presences/2

Encabezados

Content-Type: application/json
Authorization: Bearer i2Gp6aXTHDo_4yiKBuF5WtvWp5Dh51M2ov_Y5xvMYDI

Cuerpo

{
  "desktop_presence": {
    "name": "Home"
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/desktop_presences/2" -d '{"desktop_presence":{"name":"Home"}}' -X PATCH \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer i2Gp6aXTHDo_4yiKBuF5WtvWp5Dh51M2ov_Y5xvMYDI"

Respuesta

Simulated Response

Campos de respuesta

Name Description
desktop_presences (object) the newly updated desktop presence attributes

Estado

200

Encabezados

ETag: W/"446dba1381c83e6dfa24f56b14e197a2"

Cuerpo

{
  "desktop_presences": {
    "id": "2",
    "name": "Home",
    "comment_on_entry": "In at 1 - Hilpertside",
    "comment_on_exit": "Left 1 - Hilpertside",
    "idle_time": 10,
    "status_on_entry": "in",
    "status_on_exit": "out",
    "created_at": 1747100611,
    "updated_at": 1747100611
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1743903811,
      "beacons": 1739760211,
      "desktop_presences": 1747100611,
      "favorites": 1740710611,
      "fences": 1739587411,
      "groups": 1739673811,
      "networks": 1740278611,
      "roles": 1747100611,
      "settings": 1747100611
    },
    "emergency": null
  }
}

Devices

Create a device

Creates a new device.

Punto de llegada

POST /api/v4/devices

Parametros

Name Description
device[os] requerido (string) the platform this device operates within, must be either 'ios', 'android', 'mac', or 'windows'
device[token] requerido (string) the unique identifier provided by the platform for notifications
device[location_token] (string) the unique identifier provided by iOS for location notifications, only allowed for ios devices and location pushes will start (or stop if set to null) within 5 minutes
device[notifications_enabled] (boolean) whether any notifications should be sent, defaults to true
device[on_reminder] (boolean) whether any reminder notifications should be sent, defaults to true
device[deliver_status_notifications] (boolean) whether automatic status update notifications should be sent, defaults to true
device[active_time_attributes][enabled] (boolean) whether active time is enabled, defaults to false
device[active_time_attributes][time_range] (string) time range in 24h time with .. delimiter (example: 6:00..17:00), required if enabled is true
device[active_time_attributes][time_zone] (string) one of our supported time zone strings, required if enabled is true
device[active_time_attributes][wdays] (string) days that are active for start time in the format '0123456', which each number equal to a weekday (0=Sunday, 1=Monday, etc), required if enabled is true
device[active_time_attributes][on_push] (boolean) whether active time is used for followed user notifications, defaults to true
device[active_time_attributes][on_reminder] (boolean) whether active time is used for reminder notifications, defaults to true
device[active_time_attributes][on_safety] (boolean) whether active time is used for safety notifications, defaults to true
device[active_time_attributes][on_update] (boolean) whether active time is used for automatic updates, defaults to true

Solicitud

Ruta

POST /api/v4/devices

Encabezados

Content-Type: application/json
Authorization: Bearer tmpzcF7u8B2v5vHH4lELOn6CAQDMDpLjkTfNlEWgQJE

Cuerpo

{
  "device": {
    "os": "ios",
    "token": "BC76C774-B0C6-4537-B055-F2606E5A7ADD",
    "notifications_enabled": true,
    "active_time_attributes": {
      "enabled": false
    }
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/devices" -d '{"device":{"os":"ios","token":"BC76C774-B0C6-4537-B055-F2606E5A7ADD","notifications_enabled":true,"active_time_attributes":{"enabled":false}}}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer tmpzcF7u8B2v5vHH4lELOn6CAQDMDpLjkTfNlEWgQJE"

Respuesta

Simulated Response

Campos de respuesta

Name Description
devices (object) the newly created device attributes

Estado

201

Encabezados

ETag: W/"5049831bb794c4111c5c57f6722d64cb"

Cuerpo

{
  "devices": {
    "id": "10",
    "token": "BC76C774-B0C6-4537-B055-F2606E5A7ADD",
    "location_token": null,
    "os": "ios",
    "notifications_enabled": true,
    "on_announcement": true,
    "on_reminder": true,
    "deliver_status_notifications": true,
    "follow_everyone": false,
    "follow_users": [

    ],
    "active_time": {
      "enabled": false,
      "on_announcement": true,
      "on_push": true,
      "on_reminder": true,
      "on_safety": true,
      "on_update": true,
      "wdays": null,
      "time_range": null,
      "time_zone": null
    },
    "created_at": 1747100612,
    "updated_at": 1747100612
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1741315412,
      "beacons": 1743644612,
      "desktop_presences": 1741315412,
      "favorites": 1741916612,
      "fences": 1745545412,
      "groups": 1746323012,
      "networks": 1739673812,
      "roles": 1747100612,
      "settings": 1747100612
    },
    "emergency": null,
    "update_available": false
  }
}

Delete a device

Deletes an existing device.

Punto de llegada

DELETE /api/v4/devices/:id

Solicitud

Ruta

DELETE /api/v4/devices/12

Encabezados

Content-Type: application/json
Authorization: Bearer eMllav3Vra6Y9mQihFrsvLCXH2efF7wvWb0KlGt54Ts

cURL

curl "https://www.simpleinout.com/api/v4/devices/12" -d '' -X DELETE \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer eMllav3Vra6Y9mQihFrsvLCXH2efF7wvWb0KlGt54Ts"

Respuesta

Simulated Response

Estado

204

Delete a heart beat

Deletes the device’s heart beat to prevent status updates after automatic updates are disabled.

Punto de llegada

DELETE /api/v4/devices/:device_id/heart_beat

Solicitud

Ruta

DELETE /api/v4/devices/13/heart_beat

Encabezados

Content-Type: application/json
Authorization: Bearer pe1gVewpRNxY62gTpD0YNSgcJEc2-hEr4Qt5SwbflOs

cURL

curl "https://www.simpleinout.com/api/v4/devices/13/heart_beat" -d '' -X DELETE \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer pe1gVewpRNxY62gTpD0YNSgcJEc2-hEr4Qt5SwbflOs"

Respuesta

Simulated Response

Estado

204

Follow a specific user

Receive notifications on this device for all users in the company. Users must have a role that permits following users, and the company must be on a plan that allows for followed user notifications.

Punto de llegada

POST /api/v4/devices/:id/follow/users/:user_id

Solicitud

Ruta

POST /api/v4/devices/18/follow/users/128

Encabezados

Content-Type: application/json
Authorization: Bearer ReCoZDWPN1STwDcUAtsr2pdom4ocvOD0N4ENOt0Bl4M

cURL

curl "https://www.simpleinout.com/api/v4/devices/18/follow/users/128" -d '' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer ReCoZDWPN1STwDcUAtsr2pdom4ocvOD0N4ENOt0Bl4M"

Respuesta

Simulated Response

Campos de respuesta

Name Description
devices (object) the device attributes

Estado

200

Encabezados

ETag: W/"05cd791fc773bd32c67cd30b33d793c6"

Cuerpo

{
  "devices": {
    "id": "18",
    "token": "0BE7921F-F93D-42C8-9282-E0F1EDF69D2C",
    "location_token": null,
    "os": "ios",
    "notifications_enabled": true,
    "on_announcement": true,
    "on_reminder": true,
    "deliver_status_notifications": true,
    "follow_everyone": false,
    "follow_users": [
      "128"
    ],
    "active_time": {
      "enabled": false,
      "on_announcement": true,
      "on_push": true,
      "on_reminder": true,
      "on_safety": true,
      "on_update": true,
      "wdays": "12345",
      "time_range": "6:00..19:00",
      "time_zone": "America/Chicago"
    },
    "created_at": 1747100613,
    "updated_at": 1747100613
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1746668613,
      "beacons": 1741830213,
      "desktop_presences": 1744508613,
      "favorites": 1744681413,
      "fences": 1740105813,
      "groups": 1742262213,
      "networks": 1744940613,
      "roles": 1747100613,
      "settings": 1747100613
    },
    "emergency": null,
    "update_available": false
  }
}

Follow all users

Punto de llegada

POST /api/v4/devices/:id/follow/all

Solicitud

Ruta

POST /api/v4/devices/17/follow/all

Encabezados

Content-Type: application/json
Authorization: Bearer xL4_n4DT8Fy5rHUq07s3Gz8Qx4HGFT8pw9kfus4ug1E

cURL

curl "https://www.simpleinout.com/api/v4/devices/17/follow/all" -d '' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer xL4_n4DT8Fy5rHUq07s3Gz8Qx4HGFT8pw9kfus4ug1E"

Respuesta

Simulated Response

Campos de respuesta

Name Description
devices (object) the newly created device attributes

Estado

200

Encabezados

ETag: W/"e2b99f203a530e385d0ed241c0a664c1"

Cuerpo

{
  "devices": {
    "id": "17",
    "token": "6297C09F-04B4-4386-9F85-C5C761A9C719",
    "location_token": null,
    "os": "ios",
    "notifications_enabled": true,
    "on_announcement": true,
    "on_reminder": true,
    "deliver_status_notifications": true,
    "follow_everyone": true,
    "follow_users": [

    ],
    "active_time": {
      "enabled": false,
      "on_announcement": true,
      "on_push": true,
      "on_reminder": true,
      "on_safety": true,
      "on_update": true,
      "wdays": "12345",
      "time_range": "6:00..19:00",
      "time_zone": "America/Chicago"
    },
    "created_at": 1747100613,
    "updated_at": 1747100613
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1739328213,
      "beacons": 1740192213,
      "desktop_presences": 1742607813,
      "favorites": 1739587413,
      "fences": 1739328213,
      "groups": 1746409413,
      "networks": 1744163013,
      "roles": 1747100613,
      "settings": 1747100613
    },
    "emergency": null,
    "update_available": false
  }
}

Follow specific users

Receive notifications on this device for all users passed in. This allows for several users to be able to be followed individually within one API call. Please note you can only follow a user once, otherwise you will receive a taken validation error. Users must have a role that permits following users, and the company must be on a plan that allows for followed user notifications.

Punto de llegada

POST /api/v4/devices/:id/follow/users

Parametros

Name Description
user_ids (array) list of user ids within the authorized user's company (cannot be the authorized user's id)

Solicitud

Ruta

POST /api/v4/devices/7/follow/users

Encabezados

Content-Type: application/json
Authorization: Bearer v50ZGW9qszykqg6rbeCpi_8KS-SlM4umHPLutTcrUlY

Cuerpo

{
  "user_ids": [
    108,
    109
  ]
}

cURL

curl "https://www.simpleinout.com/api/v4/devices/7/follow/users" -d '{"user_ids":[108,109]}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer v50ZGW9qszykqg6rbeCpi_8KS-SlM4umHPLutTcrUlY"

Respuesta

Simulated Response

Campos de respuesta

Name Description
devices (object) the device attributes

Estado

200

Encabezados

ETag: W/"99ba058cb43e560d5a32a25771686845"

Cuerpo

{
  "devices": {
    "id": "7",
    "token": "A16DFB79-3342-4DA3-BE8D-DBE321F968BD",
    "location_token": null,
    "os": "ios",
    "notifications_enabled": true,
    "on_announcement": true,
    "on_reminder": true,
    "deliver_status_notifications": true,
    "follow_everyone": false,
    "follow_users": [
      "108",
      "109"
    ],
    "active_time": {
      "enabled": false,
      "on_announcement": true,
      "on_push": true,
      "on_reminder": true,
      "on_safety": true,
      "on_update": true,
      "wdays": "12345",
      "time_range": "6:00..19:00",
      "time_zone": "America/Chicago"
    },
    "created_at": 1747100612,
    "updated_at": 1747100612
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1743558212,
      "beacons": 1745459012,
      "desktop_presences": 1745113412,
      "favorites": 1742953412,
      "fences": 1745891012,
      "groups": 1746150212,
      "networks": 1745631812,
      "roles": 1747100612,
      "settings": 1747100612
    },
    "emergency": null,
    "update_available": false
  }
}

Retrieve a device

Retrieves an existing device.

Punto de llegada

GET /api/v4/devices/:id

Solicitud

Ruta

GET /api/v4/devices/8

Encabezados

Content-Type: application/json
Authorization: Bearer Y1bampa3WmYElNyu9E93EtPixEbrZIeEeNRJokM1UZc
If-None-Match: 

cURL

curl -g "https://www.simpleinout.com/api/v4/devices/8" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer Y1bampa3WmYElNyu9E93EtPixEbrZIeEeNRJokM1UZc" \
	-H "If-None-Match: "

Respuesta

Simulated Response

Campos de respuesta

Name Description
devices (object) the retrieved device

Estado

200

Encabezados

ETag: W/"72c13331d8475df79fea5a2f6838d7e3"

Cuerpo

{
  "devices": {
    "id": "8",
    "token": "1CE35D4A-B7B0-43F2-8E0D-E7CA9A69FE16",
    "location_token": null,
    "os": "ios",
    "notifications_enabled": true,
    "on_announcement": true,
    "on_reminder": true,
    "deliver_status_notifications": true,
    "follow_everyone": false,
    "follow_users": [

    ],
    "active_time": {
      "enabled": false,
      "on_announcement": true,
      "on_push": true,
      "on_reminder": true,
      "on_safety": true,
      "on_update": true,
      "wdays": "12345",
      "time_range": "6:00..19:00",
      "time_zone": "America/Chicago"
    },
    "created_at": 1747100612,
    "updated_at": 1747100612
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1744508612,
      "beacons": 1740451412,
      "desktop_presences": 1738723412,
      "favorites": 1743385412,
      "fences": 1740624212,
      "groups": 1746409412,
      "networks": 1746495812,
      "roles": 1747100612,
      "settings": 1747100612
    },
    "emergency": null,
    "update_available": false
  }
}

Retrieve followed users

Retrieves an array of users that this device follows. This list always contains only the ‘id’ and ‘name’ of the user in alphabetic order according to name.

Punto de llegada

GET /api/v4/devices/:id/follow/users/followed

Solicitud

Ruta

GET /api/v4/devices/6/follow/users/followed

Encabezados

Content-Type: application/json
Authorization: Bearer melH8ofM98ahUDzpsBxhfYmTfc-Pu0fwane7nwXz_kE

cURL

curl -g "https://www.simpleinout.com/api/v4/devices/6/follow/users/followed" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer melH8ofM98ahUDzpsBxhfYmTfc-Pu0fwane7nwXz_kE"

Respuesta

Simulated Response

Campos de respuesta

Name Description
users (object) the retrieved users, only including their 'id' and 'name' fields

Estado

200

Encabezados

ETag: W/"5b72e7f92fe86aaa866b460be053f168"

Cuerpo

{
  "users": [
    {
      "id": "106",
      "name": "Hipolito O'Connell"
    },
    {
      "id": "104",
      "name": "Lai Tillman"
    },
    {
      "id": "105",
      "name": "Mason Hettinger"
    },
    {
      "id": "103",
      "name": "Osvaldo Gerlach"
    }
  ],
  "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/devices/6/follow/users/followed?id=6",
      "last_href": "http://example.org/api/v4/devices/6/follow/users/followed?id=6",
      "previous_href": null,
      "next_href": null
    },
    "last_updated_at": {
      "announcements": 1742175812,
      "beacons": 1741056212,
      "desktop_presences": 1738723412,
      "favorites": 1743817412,
      "fences": 1743126212,
      "groups": 1743126212,
      "networks": 1741056212,
      "roles": 1747100612,
      "settings": 1747100612
    },
    "emergency": null,
    "update_available": false
  }
}

Retrieve unfollowed users

Retrieves an array of users that this device does not yet follow. This list always contains only the ‘id’ and ‘name’ of the user in alphabetic order according to name.

Punto de llegada

GET /api/v4/devices/:id/follow/users/available

Solicitud

Ruta

GET /api/v4/devices/11/follow/users/available

Encabezados

Content-Type: application/json
Authorization: Bearer 6VpIeQPhWHXKD4Uh-wjpyqBIwxyeapMlryAuBBbBZdM

cURL

curl -g "https://www.simpleinout.com/api/v4/devices/11/follow/users/available" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer 6VpIeQPhWHXKD4Uh-wjpyqBIwxyeapMlryAuBBbBZdM"

Respuesta

Simulated Response

Campos de respuesta

Name Description
users (object) the retrieved users, only including their 'id' and 'name' fields

Estado

200

Encabezados

ETag: W/"e0cf73c265d3abc072240f54d500bf28"

Cuerpo

{
  "users": [
    {
      "id": "116",
      "name": "Esmeralda Runte"
    },
    {
      "id": "117",
      "name": "Nicholas Emard"
    },
    {
      "id": "115",
      "name": "Percy Lang"
    },
    {
      "id": "114",
      "name": "Tracey Grimes"
    }
  ],
  "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/devices/11/follow/users/available?id=11",
      "last_href": "http://example.org/api/v4/devices/11/follow/users/available?id=11",
      "previous_href": null,
      "next_href": null
    },
    "last_updated_at": {
      "announcements": 1744681412,
      "beacons": 1746841412,
      "desktop_presences": 1741142612,
      "favorites": 1745199812,
      "fences": 1742780612,
      "groups": 1742348612,
      "networks": 1739414612,
      "roles": 1747100612,
      "settings": 1747100612
    },
    "emergency": null,
    "update_available": false
  }
}

Unfollow a specific user

Stop receiving notifications on this device for all users in the company. Users must have a role that permits following users, and the company must be on a plan that allows for followed user notifications.

Punto de llegada

DELETE /api/v4/devices/:id/follow/users/:user_id

Solicitud

Ruta

DELETE /api/v4/devices/14/follow/users/121

Encabezados

Content-Type: application/json
Authorization: Bearer 36YHXJBOvA1BuxbS-c7z8k92siT-3jdMoRFqB53J2rM

cURL

curl "https://www.simpleinout.com/api/v4/devices/14/follow/users/121" -d '' -X DELETE \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer 36YHXJBOvA1BuxbS-c7z8k92siT-3jdMoRFqB53J2rM"

Respuesta

Simulated Response

Campos de respuesta

Name Description
devices (object) the device attributes

Estado

200

Encabezados

ETag: W/"726b53ad3419b3daccd4c4ccb5e57ae9"

Cuerpo

{
  "devices": {
    "id": "14",
    "token": "90C3DD5E-1E89-495F-A9E5-3AAE2F06EE03",
    "location_token": null,
    "os": "ios",
    "notifications_enabled": true,
    "on_announcement": true,
    "on_reminder": true,
    "deliver_status_notifications": true,
    "follow_everyone": false,
    "follow_users": [

    ],
    "active_time": {
      "enabled": false,
      "on_announcement": true,
      "on_push": true,
      "on_reminder": true,
      "on_safety": true,
      "on_update": true,
      "wdays": "12345",
      "time_range": "6:00..19:00",
      "time_zone": "America/Chicago"
    },
    "created_at": 1747100613,
    "updated_at": 1747100613
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1742953413,
      "beacons": 1744595013,
      "desktop_presences": 1739501013,
      "favorites": 1746841413,
      "fences": 1743471813,
      "groups": 1742435013,
      "networks": 1738896213,
      "roles": 1747100613,
      "settings": 1747100613
    },
    "emergency": null,
    "update_available": false
  }
}

Unfollow all users

Stop receiving notifications on this device for all users in the company. Users must have a role that permits following users, and the company must be on a plan that allows for followed user notifications.

Punto de llegada

DELETE /api/v4/devices/:id/follow/all

Solicitud

Ruta

DELETE /api/v4/devices/9/follow/all

Encabezados

Content-Type: application/json
Authorization: Bearer 7zXoFSOhYsN8gMACNOBqmEbRhEBLqXlsZG0jZTUt6SA

cURL

curl "https://www.simpleinout.com/api/v4/devices/9/follow/all" -d '' -X DELETE \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer 7zXoFSOhYsN8gMACNOBqmEbRhEBLqXlsZG0jZTUt6SA"

Respuesta

Simulated Response

Estado

200

Encabezados

ETag: W/"1e72dfd64a7f8d2ac5b0adccb00146f1"

Cuerpo

{
  "devices": {
    "id": "9",
    "token": "435C08A8-504A-4F46-A534-B72AF5F424E3",
    "location_token": null,
    "os": "ios",
    "notifications_enabled": true,
    "on_announcement": true,
    "on_reminder": true,
    "deliver_status_notifications": true,
    "follow_everyone": false,
    "follow_users": [

    ],
    "active_time": {
      "enabled": false,
      "on_announcement": true,
      "on_push": true,
      "on_reminder": true,
      "on_safety": true,
      "on_update": true,
      "wdays": "12345",
      "time_range": "6:00..19:00",
      "time_zone": "America/Chicago"
    },
    "created_at": 1747100612,
    "updated_at": 1747100612
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1745027012,
      "beacons": 1744163012,
      "desktop_presences": 1740537812,
      "favorites": 1742867012,
      "fences": 1745286212,
      "groups": 1738550612,
      "networks": 1743126212,
      "roles": 1747100612,
      "settings": 1747100612
    },
    "emergency": null,
    "update_available": false
  }
}

Unfollow specific users

Exclude notifications on this device for all users passed in. This allows for several users to be able to be unfollowed individually within one API call. Users must have a role that permits following users, and the company must be on a plan that allows for followed user notifications.

Punto de llegada

DELETE /api/v4/devices/:id/follow/users

Parametros

Name Description
user_ids (array) list of user ids within the authorized user's company (cannot be the authorized user's id)

Solicitud

Ruta

DELETE /api/v4/devices/16/follow/users

Encabezados

Content-Type: application/json
Authorization: Bearer XQ9zqHbCLx77i57SGvVpwfZqeJF-Abyh0dHKp9gAGL0

Cuerpo

{
  "user_ids": [
    124,
    125
  ]
}

cURL

curl "https://www.simpleinout.com/api/v4/devices/16/follow/users" -d '{"user_ids":[124,125]}' -X DELETE \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer XQ9zqHbCLx77i57SGvVpwfZqeJF-Abyh0dHKp9gAGL0"

Respuesta

Simulated Response

Campos de respuesta

Name Description
devices (object) the device attributes

Estado

200

Encabezados

ETag: W/"365fd69788262dde197baa8b30822f2b"

Cuerpo

{
  "devices": {
    "id": "16",
    "token": "DFAE9D44-2FAB-4C37-9CBE-97A12B5ACA18",
    "location_token": null,
    "os": "ios",
    "notifications_enabled": true,
    "on_announcement": true,
    "on_reminder": true,
    "deliver_status_notifications": true,
    "follow_everyone": false,
    "follow_users": [

    ],
    "active_time": {
      "enabled": false,
      "on_announcement": true,
      "on_push": true,
      "on_reminder": true,
      "on_safety": true,
      "on_update": true,
      "wdays": "12345",
      "time_range": "6:00..19:00",
      "time_zone": "America/Chicago"
    },
    "created_at": 1747100613,
    "updated_at": 1747100613
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1746668613,
      "beacons": 1739673813,
      "desktop_presences": 1743731013,
      "favorites": 1739414613,
      "fences": 1741401813,
      "groups": 1743299013,
      "networks": 1739501013,
      "roles": 1747100613,
      "settings": 1747100613
    },
    "emergency": null,
    "update_available": false
  }
}

Update a device

Updates an existing device. If the device token is removed with an update, all the users that this device was following for notifications will also be removed.

Punto de llegada

PATCH /api/v4/devices/:id

Parametros

Name Description
device[token] (string) the unique identifier provided by the platform for notifications
device[location_token] (string) the unique identifier provided by iOS for location notifications, only allowed for ios devices and location pushes will start (or stop if set to null) within 5 minutes
device[notifications_enabled] (boolean) whether any notifications should be sent
device[on_reminder] (boolean) whether any reminder notifications should be sent
device[deliver_status_notifications] (boolean) whether automatic status update notifications should be sent
device[active_time_attributes][enabled] (boolean) whether active time is enabled, defaults to false
device[active_time_attributes][time_range] (string) time range in 24h time with .. delimiter (example: 6:00..17:00), required if enabled is true
device[active_time_attributes][time_zone] (string) one of our supported time zone strings, required if enabled is true
device[active_time_attributes][wdays] (string) days that are active for start time in the format '0123456', which each number equal to a weekday (0=Sunday, 1=Monday, etc), required if enabled is true
device[active_time_attributes][on_push] (boolean) whether active time is used for followed user notifications, defaults to true
device[active_time_attributes][on_reminder] (boolean) whether active time is used for reminder notifications, defaults to true
device[active_time_attributes][on_safety] (boolean) whether active time is used for safety notifications, defaults to true
device[active_time_attributes][on_update] (boolean) whether active time is used for automatic updates, defaults to true

Solicitud

Ruta

PATCH /api/v4/devices/15

Encabezados

Content-Type: application/json
Authorization: Bearer CLI_hSjBFfeY9Dnyefck6MTXLZZnEMOxG_2GgIyQLAQ

Cuerpo

{
  "device": {
    "notifications_enabled": true
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/devices/15" -d '{"device":{"notifications_enabled":true}}' -X PATCH \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer CLI_hSjBFfeY9Dnyefck6MTXLZZnEMOxG_2GgIyQLAQ"

Respuesta

Simulated Response

Campos de respuesta

Name Description
devices (object) the newly created device attributes

Estado

200

Encabezados

ETag: W/"a5dd30b57e671395dfc9b1def14420b4"

Cuerpo

{
  "devices": {
    "id": "15",
    "token": "D7BBB29D-B02F-4C77-B94F-044F79AD5453",
    "location_token": null,
    "os": "ios",
    "notifications_enabled": true,
    "on_announcement": true,
    "on_reminder": true,
    "deliver_status_notifications": true,
    "follow_everyone": false,
    "follow_users": [

    ],
    "active_time": {
      "enabled": false,
      "on_announcement": true,
      "on_push": true,
      "on_reminder": true,
      "on_safety": true,
      "on_update": true,
      "wdays": "12345",
      "time_range": "6:00..19:00",
      "time_zone": "America/Chicago"
    },
    "created_at": 1747100613,
    "updated_at": 1747100613
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1744422213,
      "beacons": 1742175813,
      "desktop_presences": 1740797013,
      "favorites": 1746495813,
      "fences": 1740624213,
      "groups": 1739846613,
      "networks": 1743903813,
      "roles": 1747100613,
      "settings": 1747100613
    },
    "emergency": null,
    "update_available": false
  }
}

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.

Punto de llegada

DELETE /api/v4/futures/:id

Solicitud

Ruta

DELETE /api/v4/futures/7

Encabezados

Content-Type: application/json
Authorization: Bearer pvtmOjYl3gMVu7F1XxxWqEnQ3eiRVJ9Z5QP14LXGeGs

cURL

curl "https://www.simpleinout.com/api/v4/futures/7" -d '' -X DELETE \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer pvtmOjYl3gMVu7F1XxxWqEnQ3eiRVJ9Z5QP14LXGeGs"

Respuesta

Simulated Response

Estado

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.

Punto de llegada

GET /api/v4/futures

Parametros

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: 'in', 'remote', 'busy', 'break', 'out', 'sick', or 'vacation'
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'

Solicitud

Ruta

GET /api/v4/futures

Encabezados

Content-Type: application/json
Authorization: Bearer 1tBX3SD2nteHlWsZuCwuHnOFXm4oXMlW1I7d3ACqYdY

cURL

curl -g "https://www.simpleinout.com/api/v4/futures" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer 1tBX3SD2nteHlWsZuCwuHnOFXm4oXMlW1I7d3ACqYdY"

Respuesta

Simulated Response

Campos de respuesta

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

Estado

200

Encabezados

ETag: W/"8f41cc0fddc98a9a91461c468a75d3e4"
Last-Modified: Tue, 13 May 2025 01:43:33 GMT

Cuerpo

{
  "futures": [
    {
      "id": "8",
      "status": "out",
      "comment": "On Vacation, back Monday",
      "completed": false,
      "apply_at": 1749776400,
      "end_at": 1749949200,
      "user_id": "139",
      "changed_by_user_id": null
    },
    {
      "id": "9",
      "status": "out",
      "comment": "At the conference this week",
      "completed": false,
      "apply_at": 1762999200,
      "end_at": null,
      "user_id": "139",
      "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": {
      "announcements": 1746495813,
      "beacons": 1743558213,
      "desktop_presences": 1744335813,
      "favorites": 1740883413,
      "fences": 1744767813,
      "groups": 1745113413,
      "networks": 1745804613,
      "roles": 1747100613,
      "settings": 1747100613
    },
    "emergency": null
  }
}

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.

Punto de llegada

POST /api/v4/fences

Parametros

Name Description
fence[name] requerido (string) the name of the fence
fence[latitude] requerido (float) the latitude of the center point of the fence
fence[longitude] requerido (float) the longitude of the center point of the fence
fence[radius] requerido (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', 'remote', 'busy', 'break', 'out', 'sick', 'vacation', or 'off', defaults to 'in'
fence[status_on_exit] (string) the status to apply on exit: 'in', 'remote', 'busy', 'break', 'out', 'sick', 'vacation', or 'off', defaults to 'out'

Solicitud

Ruta

POST /api/v4/fences

Encabezados

Content-Type: application/json
Authorization: Bearer C8uD4C1cZM_GUqctBcN3FJbPxiUQs46JUnCgtRYyvUk

Cuerpo

{
  "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 "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer C8uD4C1cZM_GUqctBcN3FJbPxiUQs46JUnCgtRYyvUk"

Respuesta

Simulated Response

Campos de respuesta

Name Description
fences (object) the newly created fence attributes

Estado

201

Encabezados

ETag: W/"efd553ccb96bb8d4d9ea3c3f074bc6ec"

Cuerpo

{
  "fences": {
    "id": "3",
    "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": 1747100611,
    "updated_at": 1747100611
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1741916611,
      "beacons": 1740797011,
      "desktop_presences": 1741657411,
      "favorites": 1743990211,
      "fences": 1747100611,
      "groups": 1746409411,
      "networks": 1741056211,
      "roles": 1747100611,
      "settings": 1747100611
    },
    "emergency": null
  }
}

Delete a fence

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

Punto de llegada

DELETE /api/v4/fences/:id

Solicitud

Ruta

DELETE /api/v4/fences/5

Encabezados

Content-Type: application/json
Authorization: Bearer XN-70a3RJ27HyWMIU4Kq8_z8bpfYHz_ZpFm3uUpK6KQ

cURL

curl "https://www.simpleinout.com/api/v4/fences/5" -d '' -X DELETE \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer XN-70a3RJ27HyWMIU4Kq8_z8bpfYHz_ZpFm3uUpK6KQ"

Respuesta

Simulated Response

Estado

204

List all fences

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

Punto de llegada

GET /api/v4/fences

Parametros

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

Solicitud

Ruta

GET /api/v4/fences

Encabezados

Content-Type: application/json
Authorization: Bearer iJwfWmrxsx89sSvYs2mPcyR0BGf6LQY7WuK1nfOQBpk

cURL

curl -g "https://www.simpleinout.com/api/v4/fences" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer iJwfWmrxsx89sSvYs2mPcyR0BGf6LQY7WuK1nfOQBpk"

Respuesta

Simulated Response

Campos de respuesta

Name Description
fences (array) an array of fences

Estado

200

Encabezados

ETag: W/"f1dd220ba930dfc27586cf64d83c01c6"
Last-Modified: Tue, 13 May 2025 01:43:31 GMT

Cuerpo

{
  "fences": [
    {
      "id": "1",
      "name": "1 - Purdyshire",
      "latitude": "-48.8388985968",
      "longitude": "-6.2912072113",
      "radius": 2391,
      "comment_on_entry": "In at 1 - Purdyshire",
      "comment_on_exit": "Left 1 - Purdyshire",
      "entry": true,
      "exit": true,
      "status_on_entry": "in",
      "status_on_exit": "out",
      "created_at": 1747100611,
      "updated_at": 1747100611
    },
    {
      "id": "2",
      "name": "2 - New Madaline",
      "latitude": "-2.0564690477",
      "longitude": "-33.7555725409",
      "radius": 4283,
      "comment_on_entry": "In at 2 - New Madaline",
      "comment_on_exit": "Left 2 - New Madaline",
      "entry": true,
      "exit": true,
      "status_on_entry": "in",
      "status_on_exit": "out",
      "created_at": 1747100611,
      "updated_at": 1747100611
    }
  ],
  "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": {
      "announcements": 1739760211,
      "beacons": 1740192211,
      "desktop_presences": 1744508611,
      "favorites": 1746063811,
      "fences": 1747100611,
      "groups": 1744681411,
      "networks": 1738809811,
      "roles": 1747100611,
      "settings": 1747100611
    },
    "emergency": null
  }
}

Update a fence

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

Punto de llegada

PATCH /api/v4/fences/:id

Parametros

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', 'remote', 'busy', 'break', 'out', 'sick', 'vacation', or 'off', defaults to 'in'
fence[status_on_exit] (string) the status to apply on exit: 'in', 'remote', 'busy', 'break', 'out', 'sick', 'vacation', or 'off', defaults to 'out'

Solicitud

Ruta

PATCH /api/v4/fences/4

Encabezados

Content-Type: application/json
Authorization: Bearer tQcDnwZWvznFqgkDSImgfiN8xvLMXzpW_km19Skrbf8

Cuerpo

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

cURL

curl "https://www.simpleinout.com/api/v4/fences/4" -d '{"fence":{"name":"My Renamed Geofence"}}' -X PATCH \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer tQcDnwZWvznFqgkDSImgfiN8xvLMXzpW_km19Skrbf8"

Respuesta

Simulated Response

Campos de respuesta

Name Description
fences (object) the newly updated fence attributes

Estado

200

Encabezados

ETag: W/"914b3692fedb5b14cf69dc19b67fc99d"

Cuerpo

{
  "fences": {
    "id": "4",
    "name": "My Renamed Geofence",
    "latitude": "78.7926563503",
    "longitude": "61.0726524109",
    "radius": 17893,
    "comment_on_entry": "In at 3 - Billiemouth",
    "comment_on_exit": "Left 3 - Billiemouth",
    "entry": true,
    "exit": true,
    "status_on_entry": "in",
    "status_on_exit": "out",
    "created_at": 1747100611,
    "updated_at": 1747100611
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1743212611,
      "beacons": 1743039811,
      "desktop_presences": 1746063811,
      "favorites": 1746063811,
      "fences": 1747100611,
      "groups": 1739587411,
      "networks": 1743644611,
      "roles": 1747100611,
      "settings": 1747100611
    },
    "emergency": null
  }
}

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.

Punto de llegada

POST /api/v4/groups

Parametros

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

Solicitud

Ruta

POST /api/v4/groups

Encabezados

Content-Type: application/json
Authorization: Bearer ZTcM0NJpdEV1NvYprNRhZAuYq6-uteFAuFmKYadOUFY

Cuerpo

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

cURL

curl "https://www.simpleinout.com/api/v4/groups" -d '{"group":{"name":"New Department"}}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer ZTcM0NJpdEV1NvYprNRhZAuYq6-uteFAuFmKYadOUFY"

Respuesta

Simulated Response

Campos de respuesta

Name Description
groups (object) the newly created group attributes

Estado

201

Encabezados

ETag: W/"865ed8aef9c7fbe924649aaa74b0aa46"

Cuerpo

{
  "groups": {
    "id": "9",
    "name": "New Department"
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1746582213,
      "beacons": 1741488213,
      "desktop_presences": 1746927813,
      "favorites": 1743558213,
      "fences": 1745545413,
      "groups": 1747100613,
      "networks": 1741315413,
      "roles": 1747100613,
      "settings": 1747100613
    },
    "emergency": null
  }
}

Delete a group

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

Punto de llegada

DELETE /api/v4/groups/:id

Solicitud

Ruta

DELETE /api/v4/groups/8

Encabezados

Content-Type: application/json
Authorization: Bearer ZmfDx_a-IKC39SbLDgFG-J4fw1utlsBY7Wv5PdsmUDo

cURL

curl "https://www.simpleinout.com/api/v4/groups/8" -d '' -X DELETE \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer ZmfDx_a-IKC39SbLDgFG-J4fw1utlsBY7Wv5PdsmUDo"

Respuesta

Simulated Response

Estado

204

List all groups

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

Punto de llegada

GET /api/v4/groups

Parametros

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

Solicitud

Ruta

GET /api/v4/groups

Encabezados

Content-Type: application/json
Authorization: Bearer 9vQ9bZgBqiRXc_ws_KzCL1u3nEavYB5ssOdztbvqRGs

cURL

curl -g "https://www.simpleinout.com/api/v4/groups" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer 9vQ9bZgBqiRXc_ws_KzCL1u3nEavYB5ssOdztbvqRGs"

Respuesta

Simulated Response

Campos de respuesta

Name Description
groups (array) an array of groups

Estado

200

Encabezados

ETag: W/"323dc254de19db09d1bbc660bd6fcda2"
Last-Modified: Tue, 13 May 2025 01:43:33 GMT

Cuerpo

{
  "groups": [
    {
      "id": "11",
      "name": "Hahn LLC10"
    },
    {
      "id": "12",
      "name": "Lesch, Kuhlman and D'Amore11"
    }
  ],
  "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": {
      "announcements": 1742262213,
      "beacons": 1746841413,
      "desktop_presences": 1742003013,
      "favorites": 1742175813,
      "fences": 1741229013,
      "groups": 1747100613,
      "networks": 1745113413,
      "roles": 1747100613,
      "settings": 1747100613
    },
    "emergency": null
  }
}

Update a group

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

Punto de llegada

PATCH /api/v4/groups/:id

Parametros

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

Solicitud

Ruta

PATCH /api/v4/groups/10

Encabezados

Content-Type: application/json
Authorization: Bearer fcFUn1kAJh8OMt9PACSQvBUfa5BdSijv9duK7ltDA2M

Cuerpo

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

cURL

curl "https://www.simpleinout.com/api/v4/groups/10" -d '{"group":{"name":"Renamed Department"}}' -X PATCH \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer fcFUn1kAJh8OMt9PACSQvBUfa5BdSijv9duK7ltDA2M"

Respuesta

Simulated Response

Campos de respuesta

Name Description
groups (object) the newly updated group attributes

Estado

200

Encabezados

ETag: W/"935b75c26f17b0da8232c903450984ff"

Cuerpo

{
  "groups": {
    "id": "10",
    "name": "Renamed Department"
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1745459013,
      "beacons": 1744335813,
      "desktop_presences": 1742867013,
      "favorites": 1739414613,
      "fences": 1746841413,
      "groups": 1747100613,
      "networks": 1747014213,
      "roles": 1747100613,
      "settings": 1747100613
    },
    "emergency": null
  }
}

Keys

List all keys

Retrieve the secret API keys needed for the authorized application. This API can be accessed with user credentials or user-less client credentials, and you must have executive scope (Simply Made Apps only).

Punto de llegada

GET /api/v4/keys

Solicitud

Ruta

GET /api/v4/keys

Encabezados

Content-Type: application/json
Authorization: Bearer 7ooIvoZloizeDBu4GjwIZ7FxfABR8ui_vuZd0ZKwb2M

cURL

curl -g "https://www.simpleinout.com/api/v4/keys" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer 7ooIvoZloizeDBu4GjwIZ7FxfABR8ui_vuZd0ZKwb2M"

Respuesta

Simulated Response

Estado

200

Encabezados

ETag: W/"6c2d7c231405feecdfd70774e47b5535"

Cuerpo

{
  "keys": {
    "MY_SECRET_KEY": "abc1234567",
    "ANOTHER_KEY": "xyz0987654321"
  }
}

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.

Punto de llegada

POST /api/v4/networks

Parametros

Name Description
network[name] requerido (string) the name of the network, no longer than 44 characters
network[ssid] requerido (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', 'remote', 'busy', 'break', 'out', 'sick', 'vacation', or 'off', defaults to 'in'
network[status_on_exit] (string) the status to apply on exit: 'in', 'remote', 'busy', 'break', 'out', 'sick', 'vacation', or 'off', defaults to 'out'

Solicitud

Ruta

POST /api/v4/networks

Encabezados

Content-Type: application/json
Authorization: Bearer pgoqj15Vyqgb2sSwd8ibw6aXOUG86ntZkOERf9yvxPg

Cuerpo

{
  "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 "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer pgoqj15Vyqgb2sSwd8ibw6aXOUG86ntZkOERf9yvxPg"

Respuesta

Simulated Response

Campos de respuesta

Name Description
networks (object) the newly created network attributes

Estado

201

Encabezados

ETag: W/"9991c45ee009f4f9da7b2733f59118d5"

Cuerpo

{
  "networks": {
    "id": "1",
    "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": 1747100611,
    "updated_at": 1747100611
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1745891011,
      "beacons": 1743126211,
      "desktop_presences": 1739846611,
      "favorites": 1738723411,
      "fences": 1743903811,
      "groups": 1746927811,
      "networks": 1747100611,
      "roles": 1747100611,
      "settings": 1747100611
    },
    "emergency": null
  }
}

Delete a network

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

Punto de llegada

DELETE /api/v4/networks/:id

Solicitud

Ruta

DELETE /api/v4/networks/5

Encabezados

Content-Type: application/json
Authorization: Bearer TEHDVvxv6uNWuq5T19Aoq1EAbFE0gTdBCs5_Ga-FA1g

cURL

curl "https://www.simpleinout.com/api/v4/networks/5" -d '' -X DELETE \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer TEHDVvxv6uNWuq5T19Aoq1EAbFE0gTdBCs5_Ga-FA1g"

Respuesta

Simulated Response

Estado

204

List all networks

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

Punto de llegada

GET /api/v4/networks

Parametros

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

Solicitud

Ruta

GET /api/v4/networks

Encabezados

Content-Type: application/json
Authorization: Bearer lTkKsb2OHY-ipMBM3LPdWBAa-v_OKHc6oncHXRV2m5w

cURL

curl -g "https://www.simpleinout.com/api/v4/networks" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer lTkKsb2OHY-ipMBM3LPdWBAa-v_OKHc6oncHXRV2m5w"

Respuesta

Simulated Response

Campos de respuesta

Name Description
networks (array) an array of networks

Estado

200

Encabezados

ETag: W/"95dafb1bf9616cbcef7c2be55d19c77e"
Last-Modified: Tue, 13 May 2025 01:43:31 GMT

Cuerpo

{
  "networks": [
    {
      "id": "2",
      "name": "1 - New Harry",
      "ssid": "0kx73s1g8j7jzwzgiooinfv6kr3cags2",
      "comment_on_entry": "In at 1 - New Harry",
      "comment_on_exit": "Left 1 - New Harry",
      "entry": true,
      "exit": true,
      "status_on_entry": "in",
      "status_on_exit": "out",
      "created_at": 1747100611,
      "updated_at": 1747100611
    },
    {
      "id": "3",
      "name": "2 - Heaneyhaven",
      "ssid": "gj5vgeagh1vki9psdhb8rezz294bu9zd",
      "comment_on_entry": "In at 2 - Heaneyhaven",
      "comment_on_exit": "Left 2 - Heaneyhaven",
      "entry": true,
      "exit": true,
      "status_on_entry": "in",
      "status_on_exit": "out",
      "created_at": 1747100611,
      "updated_at": 1747100611
    }
  ],
  "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": {
      "announcements": 1743990211,
      "beacons": 1742521411,
      "desktop_presences": 1746323011,
      "favorites": 1742089411,
      "fences": 1740883411,
      "groups": 1741830211,
      "networks": 1747100611,
      "roles": 1747100611,
      "settings": 1747100611
    },
    "emergency": null
  }
}

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.

Punto de llegada

PATCH /api/v4/networks/:id

Parametros

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', 'remote', 'busy', 'break', 'out', 'sick', 'vacation', or 'off', defaults to 'in'
network[status_on_exit] (string) the status to apply on exit: 'in', 'remote', 'busy', 'break', 'out', 'sick', 'vacation', or 'off', defaults to 'out'

Solicitud

Ruta

PATCH /api/v4/networks/4

Encabezados

Content-Type: application/json
Authorization: Bearer cLFJgjQkZQn5GvdZzv3yEp7SomhLjVKqyf05CaRMYWY

Cuerpo

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

cURL

curl "https://www.simpleinout.com/api/v4/networks/4" -d '{"network":{"name":"My Renamed Office"}}' -X PATCH \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer cLFJgjQkZQn5GvdZzv3yEp7SomhLjVKqyf05CaRMYWY"

Respuesta

Simulated Response

Campos de respuesta

Name Description
networks (object) the newly updated network attributes

Estado

200

Encabezados

ETag: W/"adca11a9927d686dd2c9de770d3bcd4e"

Cuerpo

{
  "networks": {
    "id": "4",
    "name": "My Renamed Office",
    "ssid": "hxdlq2nfjy448yc9tphuzv5xwrtmn0yl",
    "comment_on_entry": "In at 3 - South Pasquale",
    "comment_on_exit": "Left 3 - South Pasquale",
    "entry": true,
    "exit": true,
    "status_on_entry": "in",
    "status_on_exit": "out",
    "created_at": 1747100611,
    "updated_at": 1747100611
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1745977411,
      "beacons": 1739846611,
      "desktop_presences": 1743385411,
      "favorites": 1738982611,
      "fences": 1744681411,
      "groups": 1741488211,
      "networks": 1747100611,
      "roles": 1747100611,
      "settings": 1747100611
    },
    "emergency": null
  }
}

Ok

Make sure things are Ok

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

Punto de llegada

GET /api/v4/ok

Parametros

Name Description
meta (string) if any value included, will return meta information instead of a 204 No Content response

Solicitud

Ruta

GET /api/v4/ok

Encabezados

Content-Type: application/json
Authorization: Bearer 3xgie5X82L_-L0TKjzRvW7gbacl20yslXORZwiwjvE0

cURL

curl -g "https://www.simpleinout.com/api/v4/ok" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer 3xgie5X82L_-L0TKjzRvW7gbacl20yslXORZwiwjvE0"

Respuesta

Simulated Response

Estado

204

Passwords

Reset a password

Sends the password reset instructions email if a matching user is found. The response status will be 404 (not found) if there is no user with the email address. This API requires a user-less Client Credential grant, and you must have executive scope (Simply Made Apps only).

Punto de llegada

POST /api/v4/passwords

Parametros

Name Description
email requerido (string) the email of the user

Solicitud

Ruta

POST /api/v4/passwords

Encabezados

Content-Type: application/json
Authorization: Bearer 0ArHyESuXb-O9YrZ2uzT-XLmhQAO6vH4QZ26s7SSbJk

Cuerpo

{
  "email": "sterling@simplymadeapps.com"
}

cURL

curl "https://www.simpleinout.com/api/v4/passwords" -d '{"email":"sterling@simplymadeapps.com"}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer 0ArHyESuXb-O9YrZ2uzT-XLmhQAO6vH4QZ26s7SSbJk"

Respuesta

Simulated Response

Estado

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.

Punto de llegada

POST /api/v4/roles

Parametros

Name Description
role[name] requerido (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 all other users and their current status.
role[manage_all_announcements] (boolean) these users can manage all announcements.
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 all others by adding and deleting status updates.
role[manage_others_futures] (boolean) these users can schedule future status updates for all other users.
role[manage_others_status] (boolean) these users can change the current status of all 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_all_announcements] (boolean) these users can view all announcements.
role[view_others_archives] (boolean) these users can view the past status updates made by all other users.
role[view_others_futures] (boolean) these users can view the scheduled status updates for all users.
role[view_others_reports] (boolean) these users can run reports on the status history of all other users.
role[view_user_board_updated_at] (boolean) these users can view the time that status updates were made on the board.
role[member_board] (boolean) these users can see other users within the same groups and their current status.
role[manage_member_announcements] (boolean) these users can manage announcements within the same groups.
role[manage_member_archives] (boolean) these users can change the past statuses of users within the same groups by adding and deleting status updates.
role[manage_member_futures] (boolean) these users can schedule future status updates for users within the same groups.
role[manage_member_status] (boolean) these users can change the current status of users within the same groups.
role[view_member_announcements] (boolean) these users can view announcements for everyone and the groups they belong to.
role[view_member_archives] (boolean) these users can view the past status updates made by users within the same groups.
role[view_member_futures] (boolean) these users can view the scheduled status updates for users within the same groups.
role[view_member_reports] (boolean) these users can run reports on the status history of users within the same groups.

Solicitud

Ruta

POST /api/v4/roles

Encabezados

Content-Type: application/json
Authorization: Bearer w3l6ApkSQ2fxslzFvUh4zJEuN7ZIRHcv_pcy8DbW3YI

Cuerpo

{
  "role": {
    "name": "Billing Role",
    "billing": true,
    "followed_users": false,
    "reminders": false,
    "safeties": false,
    "user_board": false,
    "manage_all_announcements": 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_all_announcements": true,
    "view_others_archives": false,
    "view_others_futures": false,
    "view_others_reports": false,
    "view_user_board_updated_at": false,
    "member_board": false,
    "manage_member_announcements": false,
    "manage_member_archives": false,
    "manage_member_futures": false,
    "manage_member_status": false,
    "view_member_announcements": false,
    "view_member_archives": false,
    "view_member_futures": false,
    "view_member_reports": 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_all_announcements":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_all_announcements":true,"view_others_archives":false,"view_others_futures":false,"view_others_reports":false,"view_user_board_updated_at":false,"member_board":false,"manage_member_announcements":false,"manage_member_archives":false,"manage_member_futures":false,"manage_member_status":false,"view_member_announcements":false,"view_member_archives":false,"view_member_futures":false,"view_member_reports":false}}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer w3l6ApkSQ2fxslzFvUh4zJEuN7ZIRHcv_pcy8DbW3YI"

Respuesta

Simulated Response

Campos de respuesta

Name Description
roles (object) the newly created role attributes

Estado

201

Encabezados

ETag: W/"1f0c03ecadbc2af28085c1022ee0bd83"

Cuerpo

{
  "roles": {
    "id": "224",
    "name": "Billing Role",
    "billing": true,
    "followed_users": false,
    "reminders": false,
    "safeties": false,
    "user_board": false,
    "manage_all_announcements": false,
    "manage_company_and_users": false,
    "manage_groups_and_memberships": false,
    "manage_member_announcements": 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_all_announcements": true,
    "view_member_announcements": false,
    "view_others_archives": false,
    "view_others_futures": false,
    "view_others_reports": false,
    "member_board": false,
    "manage_member_archives": false,
    "manage_member_futures": false,
    "manage_member_status": false,
    "view_member_archives": false,
    "view_member_futures": false,
    "view_member_reports": false,
    "view_user_board_updated_at": false,
    "created_at": 1747100612,
    "updated_at": 1747100612
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1742521412,
      "beacons": 1739760212,
      "desktop_presences": 1744854212,
      "favorites": 1741657412,
      "fences": 1739760212,
      "groups": 1744422212,
      "networks": 1742003012,
      "roles": 1747100612,
      "settings": 1747100612
    },
    "emergency": null
  }
}

Delete a role

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

Punto de llegada

DELETE /api/v4/roles/:id

Solicitud

Ruta

DELETE /api/v4/roles/214

Encabezados

Content-Type: application/json
Authorization: Bearer b7QAIjWkzvguMlxINQR8JZRvde_B4ZJDNfoB3N6reQ8

cURL

curl "https://www.simpleinout.com/api/v4/roles/214" -d '' -X DELETE \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer b7QAIjWkzvguMlxINQR8JZRvde_B4ZJDNfoB3N6reQ8"

Respuesta

Simulated Response

Estado

204

List all roles

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

Punto de llegada

GET /api/v4/roles

Parametros

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

Solicitud

Ruta

GET /api/v4/roles

Encabezados

Content-Type: application/json
Authorization: Bearer kuu_QLDtSRO7H2_rnq_HjACU6p-nDaCCR-PqXmT3QiI

cURL

curl -g "https://www.simpleinout.com/api/v4/roles" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer kuu_QLDtSRO7H2_rnq_HjACU6p-nDaCCR-PqXmT3QiI"

Respuesta

Simulated Response

Campos de respuesta

Name Description
roles (array) an array of roles

Estado

200

Encabezados

ETag: W/"0f618a4f07bfd0d2e3374b72729c2489"
Last-Modified: Tue, 13 May 2025 01:43:32 GMT

Cuerpo

{
  "roles": [
    {
      "id": "225",
      "name": "Administrator",
      "billing": true,
      "followed_users": true,
      "reminders": true,
      "safeties": true,
      "user_board": true,
      "manage_all_announcements": true,
      "manage_company_and_users": true,
      "manage_groups_and_memberships": true,
      "manage_member_announcements": false,
      "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_all_announcements": true,
      "view_member_announcements": false,
      "view_others_archives": true,
      "view_others_futures": true,
      "view_others_reports": true,
      "member_board": false,
      "manage_member_archives": false,
      "manage_member_futures": false,
      "manage_member_status": false,
      "view_member_archives": false,
      "view_member_futures": false,
      "view_member_reports": false,
      "view_user_board_updated_at": true,
      "created_at": 1747100612,
      "updated_at": 1747100612
    },
    {
      "id": "226",
      "name": "Manager",
      "billing": false,
      "followed_users": false,
      "reminders": false,
      "safeties": false,
      "user_board": true,
      "manage_all_announcements": true,
      "manage_company_and_users": false,
      "manage_groups_and_memberships": false,
      "manage_member_announcements": 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_all_announcements": true,
      "view_member_announcements": false,
      "view_others_archives": true,
      "view_others_futures": true,
      "view_others_reports": true,
      "member_board": false,
      "manage_member_archives": false,
      "manage_member_futures": false,
      "manage_member_status": false,
      "view_member_archives": false,
      "view_member_futures": false,
      "view_member_reports": false,
      "view_user_board_updated_at": true,
      "created_at": 1747100612,
      "updated_at": 1747100612
    },
    {
      "id": "227",
      "name": "Regular User",
      "billing": false,
      "followed_users": false,
      "reminders": false,
      "safeties": false,
      "user_board": true,
      "manage_all_announcements": false,
      "manage_company_and_users": false,
      "manage_groups_and_memberships": false,
      "manage_member_announcements": 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_all_announcements": true,
      "view_member_announcements": false,
      "view_others_archives": true,
      "view_others_futures": true,
      "view_others_reports": false,
      "member_board": false,
      "manage_member_archives": false,
      "manage_member_futures": false,
      "manage_member_status": false,
      "view_member_archives": false,
      "view_member_futures": false,
      "view_member_reports": false,
      "view_user_board_updated_at": true,
      "created_at": 1747100612,
      "updated_at": 1747100612
    },
    {
      "id": "228",
      "name": "Limited User",
      "billing": false,
      "followed_users": false,
      "reminders": false,
      "safeties": false,
      "user_board": true,
      "manage_all_announcements": false,
      "manage_company_and_users": false,
      "manage_groups_and_memberships": false,
      "manage_member_announcements": 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_all_announcements": true,
      "view_member_announcements": false,
      "view_others_archives": true,
      "view_others_futures": true,
      "view_others_reports": false,
      "member_board": false,
      "manage_member_archives": false,
      "manage_member_futures": false,
      "manage_member_status": false,
      "view_member_archives": false,
      "view_member_futures": false,
      "view_member_reports": false,
      "view_user_board_updated_at": true,
      "created_at": 1747100612,
      "updated_at": 1747100612
    }
  ],
  "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": {
      "announcements": 1742607812,
      "beacons": 1744940612,
      "desktop_presences": 1744854212,
      "favorites": 1739414612,
      "fences": 1741657412,
      "groups": 1744508612,
      "networks": 1744854212,
      "roles": 1747100612,
      "settings": 1747100612
    },
    "emergency": null
  }
}

Retrieve a role

Retrieve an existing role.

Punto de llegada

GET /api/v4/roles/:id

Solicitud

Ruta

GET /api/v4/roles/219

Encabezados

Content-Type: application/json
Authorization: Bearer QqdGB0m8e-3EGw0uNaJgYI_KQif2fR7APvh80Z9IqxQ

cURL

curl -g "https://www.simpleinout.com/api/v4/roles/219" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer QqdGB0m8e-3EGw0uNaJgYI_KQif2fR7APvh80Z9IqxQ"

Respuesta

Simulated Response

Campos de respuesta

Name Description
roles (object) the role attributes

Estado

200

Encabezados

ETag: W/"0d24ac1534ca7ec805834162e429f6df"
Last-Modified: Tue, 13 May 2025 01:43:32 GMT

Cuerpo

{
  "roles": {
    "id": "219",
    "name": "Raynor-Quitzon",
    "billing": false,
    "followed_users": false,
    "reminders": false,
    "safeties": false,
    "user_board": false,
    "manage_all_announcements": false,
    "manage_company_and_users": false,
    "manage_groups_and_memberships": false,
    "manage_member_announcements": 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_all_announcements": true,
    "view_member_announcements": false,
    "view_others_archives": false,
    "view_others_futures": false,
    "view_others_reports": false,
    "member_board": false,
    "manage_member_archives": false,
    "manage_member_futures": false,
    "manage_member_status": false,
    "view_member_archives": false,
    "view_member_futures": false,
    "view_member_reports": false,
    "view_user_board_updated_at": false,
    "created_at": 1747100612,
    "updated_at": 1747100612
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1742348612,
      "beacons": 1738896212,
      "desktop_presences": 1739933012,
      "favorites": 1743817412,
      "fences": 1745545412,
      "groups": 1740969812,
      "networks": 1744508612,
      "roles": 1747100612,
      "settings": 1747100612
    },
    "emergency": null,
    "update_available": false
  }
}

Update a role

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

Punto de llegada

PATCH /api/v4/roles/:id

Parametros

Name Description
role[name] requerido (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 all other users and their current status.
role[manage_all_announcements] (boolean) these users can manage all announcements.
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 all others by adding and deleting status updates.
role[manage_others_futures] (boolean) these users can schedule future status updates for all other users.
role[manage_others_status] (boolean) these users can change the current status of all 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_all_announcements] (boolean) these users can view all announcements.
role[view_others_archives] (boolean) these users can view the past status updates made by all other users.
role[view_others_futures] (boolean) these users can view the scheduled status updates for all users.
role[view_others_reports] (boolean) these users can run reports on the status history of all other users.
role[view_user_board_updated_at] (boolean) these users can view the time that status updates were made on the board.
role[member_board] (boolean) these users can see other users within the same groups and their current status.
role[manage_member_announcements] (boolean) these users can manage announcements within the same groups.
role[manage_member_archives] (boolean) these users can change the past statuses of users within the same groups by adding and deleting status updates.
role[manage_member_futures] (boolean) these users can schedule future status updates for users within the same groups.
role[manage_member_status] (boolean) these users can change the current status of users within the same groups.
role[view_member_announcements] (boolean) these users can view announcements for everyone and the groups they belong to.
role[view_member_archives] (boolean) these users can view the past status updates made by users within the same groups.
role[view_member_futures] (boolean) these users can view the scheduled status updates for users within the same groups.
role[view_member_reports] (boolean) these users can run reports on the status history of users within the same groups.

Solicitud

Ruta

PATCH /api/v4/roles/209

Encabezados

Content-Type: application/json
Authorization: Bearer ngVA2UyEZEUlg5FqbPFyL5irEQVEWl2zuQNlJyvKnEc

Cuerpo

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

cURL

curl "https://www.simpleinout.com/api/v4/roles/209" -d '{"role":{"name":"My Renamed Role","billing":false,"view_others_archives":true,"view_others_futures":true}}' -X PATCH \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer ngVA2UyEZEUlg5FqbPFyL5irEQVEWl2zuQNlJyvKnEc"

Respuesta

Simulated Response

Campos de respuesta

Name Description
roles (object) the newly updated role attributes

Estado

200

Encabezados

ETag: W/"65de07f1971572d3afbb964dc6f8b9ac"

Cuerpo

{
  "roles": {
    "id": "209",
    "name": "My Renamed Role",
    "billing": false,
    "followed_users": false,
    "reminders": false,
    "safeties": false,
    "user_board": false,
    "manage_all_announcements": false,
    "manage_company_and_users": false,
    "manage_groups_and_memberships": false,
    "manage_member_announcements": 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_all_announcements": true,
    "view_member_announcements": false,
    "view_others_archives": true,
    "view_others_futures": true,
    "view_others_reports": false,
    "member_board": false,
    "manage_member_archives": false,
    "manage_member_futures": false,
    "manage_member_status": false,
    "view_member_archives": false,
    "view_member_futures": false,
    "view_member_reports": false,
    "view_user_board_updated_at": false,
    "created_at": 1747100611,
    "updated_at": 1747100612
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1739587411,
      "beacons": 1743126211,
      "desktop_presences": 1739673811,
      "favorites": 1739328211,
      "fences": 1745113411,
      "groups": 1742953411,
      "networks": 1739241811,
      "roles": 1747100612,
      "settings": 1747100611
    },
    "emergency": null
  }
}

Safeties

Create a safety

Creates a new safety. Two types of safeties can be created. If ‘run_time’ is given, the notification will go out if there are any users with the matching status at the given time. If ‘unsafe_after’ is given, a notification will go out any time a user is in the given status for the given length of time. Users must have a role that permits using safety notifications to create safeties, and the company must be on a plan that allows for safety notifications.

Punto de llegada

POST /api/v4/safeties

Parametros

Name Description
safety[device_id] requerido (string) the ID of the device that will receive notifications
safety[group_id] (string) the ID of the group to observe, the entire company will be observed if no group is assigned
safety[name] requerido (string) the label to apply to the safety
safety[run_time] (string) the time to check for unsafe users in 24-hour format at 5 minute intervals, run_time or unsafe_after is required
safety[run_time_zone] requerido (string) the time zone of the run time, required if run_time is given
safety[status] requerido (string) the status that determines if a user is unsafe: 'in', 'remote', 'busy', 'break', 'out', 'sick', or 'vacation'
safety[unsafe_after] (integer) the length of time, in hours, for a user with the matching status to be considered unsafe, run_time or unsafe_after is required
safety[wdays] requerido (string) days that safety notifications are enabled in the format '0123456', which each number equal to a weekday (0=Sunday, 1=Monday, etc)

Solicitud

Ruta

POST /api/v4/safeties

Encabezados

Content-Type: application/json
Authorization: Bearer P_5nNzEGc70iX768MaZpgbpSAcxUpB30YQ8p_5UD_hk

Cuerpo

{
  "safety": {
    "device_id": 3,
    "name": "Safety Alert",
    "run_time": "17:00",
    "run_time_zone": "America/Chicago",
    "status": "in",
    "wdays": "12345"
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/safeties" -d '{"safety":{"device_id":3,"name":"Safety Alert","run_time":"17:00","run_time_zone":"America/Chicago","status":"in","wdays":"12345"}}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer P_5nNzEGc70iX768MaZpgbpSAcxUpB30YQ8p_5UD_hk"

Respuesta

Simulated Response

Campos de respuesta

Name Description
safeties (object) the newly created safety attributes

Estado

201

Encabezados

ETag: W/"50569f6bb68760c0afb92ddc8cfc8141"

Cuerpo

{
  "safeties": {
    "id": "4",
    "device_id": "3",
    "group_id": null,
    "name": "Safety Alert",
    "run_time": "17:00",
    "run_time_zone": "America/Chicago",
    "status": "in",
    "unsafe_after": null,
    "wdays": "12345",
    "created_at": 1747100612,
    "updated_at": 1747100612
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1742521412,
      "beacons": 1743299012,
      "desktop_presences": 1744508612,
      "favorites": 1745199812,
      "fences": 1740451412,
      "groups": 1746495812,
      "networks": 1744335812,
      "roles": 1747100612,
      "settings": 1747100612
    },
    "emergency": null,
    "update_available": false
  }
}

Delete a safety

Deletes an existing safety. Users must have a role that permits using safety notifications to delete safeties, and the company must be on a plan that allows for safety notifications.

Punto de llegada

DELETE /api/v4/safeties/:id

Solicitud

Ruta

DELETE /api/v4/safeties/3

Encabezados

Content-Type: application/json
Authorization: Bearer cPGs3XJ59KQFNGBLdVqpTBASAlk0Pf-Rsu-vT9QQgkU

cURL

curl "https://www.simpleinout.com/api/v4/safeties/3" -d '' -X DELETE \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer cPGs3XJ59KQFNGBLdVqpTBASAlk0Pf-Rsu-vT9QQgkU"

Respuesta

Simulated Response

Estado

204

List all safeties

Return a list of all safeties belonging to the device. Users must have a role that permits using safety notifications to list safeties, and the company must be on a plan that allows for safety notifications.

Punto de llegada

GET /api/v4/safeties

Parametros

Name Description
device_id requerido (string) the unique ID of the device
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

Solicitud

Ruta

GET /api/v4/safeties?device_id=1

Encabezados

Content-Type: application/json
Authorization: Bearer gTmRNtZB1ZRUuFFy24r5VicDKm2hEmxXSPtw7bCRtz0

Parámetros de la consulta

device_id=1

cURL

curl -g "https://www.simpleinout.com/api/v4/safeties?device_id=1" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer gTmRNtZB1ZRUuFFy24r5VicDKm2hEmxXSPtw7bCRtz0"

Respuesta

Simulated Response

Campos de respuesta

Name Description
safeties (array) an array of safety notification settings

Estado

200

Encabezados

ETag: W/"7bf6d5eb62e86c4b041949670d924a4a"
Last-Modified: Tue, 13 May 2025 01:43:32 GMT

Cuerpo

{
  "safeties": [
    {
      "id": "1",
      "device_id": "1",
      "group_id": null,
      "name": "Safety Alert",
      "run_time": "22:00",
      "run_time_zone": "America/Chicago",
      "status": "out",
      "unsafe_after": null,
      "wdays": "0123456",
      "created_at": 1747100612,
      "updated_at": 1747100612
    },
    {
      "id": "2",
      "device_id": "1",
      "group_id": null,
      "name": "Safety Alert",
      "run_time": null,
      "run_time_zone": "America/Chicago",
      "status": "out",
      "unsafe_after": 5,
      "wdays": "0123456",
      "created_at": 1747100612,
      "updated_at": 1747100612
    }
  ],
  "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/safeties?device_id=1",
      "last_href": "http://example.org/api/v4/safeties?device_id=1",
      "previous_href": null,
      "next_href": null
    },
    "last_updated_at": {
      "announcements": 1741229012,
      "beacons": 1743212612,
      "desktop_presences": 1740883412,
      "favorites": 1739414612,
      "fences": 1739673812,
      "groups": 1739155412,
      "networks": 1739241812,
      "roles": 1747100612,
      "settings": 1747100612
    },
    "emergency": null,
    "update_available": false
  }
}

Retrieve a safety

Retrieve an existing safety. Users must have a role that permits using safety notifications to retrieve safeties, and the company must be on a plan that allows for safety notifications.

Punto de llegada

GET /api/v4/safeties/:id

Parametros

Name Description
expand (string) set to 'users' to include the unsafe users

Solicitud

Ruta

GET /api/v4/safeties/5?expand=users

Encabezados

Content-Type: application/json
Authorization: Bearer -SKv4Hsof4MBuyZOkSU4CXJtOAQYFxjlJ90f_nyfeI0

Parámetros de la consulta

expand=users

cURL

curl -g "https://www.simpleinout.com/api/v4/safeties/5?expand=users" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer -SKv4Hsof4MBuyZOkSU4CXJtOAQYFxjlJ90f_nyfeI0"

Respuesta

Simulated Response

Campos de respuesta

Name Description
safeties (object) the safety attributes
users (array) an array of users considered unsafe

Estado

200

Encabezados

ETag: W/"0bfb6ccf55c26db14eb347b0e7c22a4e"
Last-Modified: Tue, 13 May 2025 01:43:32 GMT

Cuerpo

{
  "safeties": {
    "id": "5",
    "device_id": "4",
    "group_id": null,
    "name": "Safety Alert",
    "run_time": null,
    "run_time_zone": "America/Chicago",
    "status": "in",
    "unsafe_after": 5,
    "wdays": "0123456",
    "created_at": 1747100612,
    "updated_at": 1747100612
  },
  "users": [
    {
      "id": "95",
      "name": "Homer Kub"
    },
    {
      "id": "94",
      "name": "Lissa Roob"
    }
  ],
  "meta": {
    "last_updated_at": {
      "announcements": 1743385412,
      "beacons": 1747014212,
      "desktop_presences": 1738982612,
      "favorites": 1742694212,
      "fences": 1744767812,
      "groups": 1744595012,
      "networks": 1740278612,
      "roles": 1747100612,
      "settings": 1747100612
    },
    "emergency": null,
    "update_available": false
  }
}

Update a safety

Updates an existing safety. Users must have a role that permits using safety notifications to update safeties, and the company must be on a plan that allows for safety notifications.

Punto de llegada

PATCH /api/v4/safeties/:id

Parametros

Name Description
safety[device_id] (string) the ID of the device that will receive notifications
safety[group_id] (string) the ID of the group to observe, send null to remove the group and use the entire company
safety[name] (string) the label to apply to the safety
safety[run_time] (string) the time to check for unsafe users in 24-hour format at 5 minute intervals, run_time or unsafe_after is required
safety[run_time_zone] (string) the time zone of the run time, required if run_time is given
safety[status] (string) the status that determines if a user is unsafe: 'in', 'remote', 'busy', 'break', 'out', 'sick', or 'vacation'
safety[unsafe_after] (integer) the length of time, in hours, for a user with the matching status to be considered unsafe, run_time or unsafe_after is required
safety[wdays] (string) days that safety notifications are enabled in the format '0123456', which each number equal to a weekday (0=Sunday, 1=Monday, etc)

Solicitud

Ruta

PATCH /api/v4/safeties/6

Encabezados

Content-Type: application/json
Authorization: Bearer v-zw84_-GoKn_-p5yHBjIsQ31BQXENx2o-f0oRDKqtY

Cuerpo

{
  "safety": {
    "name": "Renamed Safety Notice"
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/safeties/6" -d '{"safety":{"name":"Renamed Safety Notice"}}' -X PATCH \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer v-zw84_-GoKn_-p5yHBjIsQ31BQXENx2o-f0oRDKqtY"

Respuesta

Simulated Response

Campos de respuesta

Name Description
safeties (object) the newly updated safety attributes

Estado

200

Encabezados

ETag: W/"3f3eddc73d1339f8c41cc77a4559abaf"

Cuerpo

{
  "safeties": {
    "id": "6",
    "device_id": "5",
    "group_id": null,
    "name": "Renamed Safety Notice",
    "run_time": "22:00",
    "run_time_zone": "America/Chicago",
    "status": "out",
    "unsafe_after": null,
    "wdays": "0123456",
    "created_at": 1747100612,
    "updated_at": 1747100612
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1740624212,
      "beacons": 1741657412,
      "desktop_presences": 1742780612,
      "favorites": 1747014212,
      "fences": 1746582212,
      "groups": 1746927812,
      "networks": 1739587412,
      "roles": 1747100612,
      "settings": 1747100612
    },
    "emergency": null,
    "update_available": false
  }
}

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.

Punto de llegada

GET /api/v4/statuses

Parametros

Name Description
page_size (integer) number of results to return per page, defaults to 25
page (integer) page number of results
created_at requerido (string) a date range string for the time the status was created
status (string) the status: 'in', 'remote', 'busy', 'break', 'out', 'sick', or 'vacation'
comment (string) the comment, case sensitive, included with the status change
automatic (boolean) only find automatic statuses
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', 'automatic'
expand (string) comma-delimited list of extra information to include in the response, possibilities include: 'user', 'user.favorites', 'user.latest', 'user.memberships', 'user.memberships.group', 'user.phones', 'user.recents', 'changed_by_user', 'application'

Solicitud

Ruta

GET /api/v4/statuses?created_at=1746421200..1746680399

Encabezados

Content-Type: application/json
Authorization: Bearer Xkd5bOdv-M1MZNtJyNJcGrZcS-xHf_9kaCMQ2dcb6mE

Parámetros de la consulta

created_at=1746421200..1746680399

cURL

curl -g "https://www.simpleinout.com/api/v4/statuses?created_at=1746421200..1746680399" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer Xkd5bOdv-M1MZNtJyNJcGrZcS-xHf_9kaCMQ2dcb6mE"

Respuesta

Simulated Response

Campos de respuesta

Name Description
statuses (array) an array of matching statuses

Estado

200

Encabezados

ETag: W/"39c47659b6d28d168d857b035a2bf3dd"
Last-Modified: Tue, 06 May 2025 14:00:00 GMT

Cuerpo

{
  "statuses": [
    {
      "status": "in",
      "comment": "At Work",
      "automatic": false,
      "user_id": "98",
      "changed_by_user_id": null,
      "created_at": 1746428400
    },
    {
      "status": "out",
      "comment": "Left Work",
      "automatic": true,
      "user_id": "98",
      "changed_by_user_id": null,
      "created_at": 1746442800
    },
    {
      "status": "in",
      "comment": "At Work",
      "automatic": false,
      "user_id": "98",
      "changed_by_user_id": null,
      "created_at": 1746446400
    },
    {
      "status": "out",
      "comment": "Left Work",
      "automatic": false,
      "user_id": "98",
      "changed_by_user_id": null,
      "created_at": 1746464400
    },
    {
      "status": "in",
      "comment": "At Work",
      "automatic": true,
      "user_id": "98",
      "changed_by_user_id": null,
      "created_at": 1746514800
    },
    {
      "status": "out",
      "comment": "Left Work",
      "automatic": true,
      "user_id": "98",
      "changed_by_user_id": null,
      "created_at": 1746536400
    },
    {
      "status": "out",
      "comment": "On Vacation",
      "automatic": false,
      "user_id": "98",
      "changed_by_user_id": "99",
      "created_at": 1746540000
    }
  ],
  "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=1746421200..1746680399",
      "last_href": "http://example.org/api/v4/statuses?created_at=1746421200..1746680399",
      "previous_href": null,
      "next_href": null
    },
    "last_updated_at": {
      "announcements": 1743990212,
      "beacons": 1743039812,
      "desktop_presences": 1741229012,
      "favorites": 1740624212,
      "fences": 1740192212,
      "groups": 1744249412,
      "networks": 1747100612,
      "roles": 1747100612,
      "settings": 1747100612
    },
    "emergency": null
  }
}

Trials

Create a new trial

Create a new Simple In/Out trial company/user. This results in a HTTP 302 redirect to simpleinout.com. There, Simple In/Out will ask the user for their new company/user information and create them. Simple In/Out will send a request to your redirect_uri with a code that you will use in the Authorization Code grant to create access and refresh tokens to access the API.

Punto de llegada

GET /api/v4/trials/new

Parametros

Name Description
response_type requerido (string) the type of authorization to use, in this case always 'code'
client_id requerido (string) your API client key
redirect_uri requerido (string) the URI to return the user to after authenticating, must match those registered with Simple In/Out
scope requerido (string) requested scope, always 'executive'
locale (string) the language of your device, all values accepted

Solicitud

Ruta

GET /api/v4/trials/new?response_type=code&client_id=PLACE_YOUR_API_CLIENT_ID_HERE&redirect_uri=https%3A%2F%2Fwww.simplymadeapps.com%2Fredirect%2Furl&scope=executive&locale=en

Encabezados

Content-Type: application/json

Parámetros de la consulta

response_type=code
client_id=PLACE_YOUR_API_CLIENT_ID_HERE
redirect_uri=https://www.simplymadeapps.com/redirect/url
scope=executive
locale=en

cURL

curl -g "https://www.simpleinout.com/api/v4/trials/new?response_type=code&client_id=PLACE_YOUR_API_CLIENT_ID_HERE&redirect_uri=https%3A%2F%2Fwww.simplymadeapps.com%2Fredirect%2Furl&scope=executive&locale=en" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json"

Respuesta

Simulated Response

Estado

302

Users

Archive a user

Archives an existing user. Users must have a role that permits managing users.

Punto de llegada

POST /api/v4/users/:id/archive

Solicitud

Ruta

POST /api/v4/users/143/archive

Encabezados

Content-Type: application/json
Authorization: Bearer FUCMOQ_BQPUIygQkdr_dTqHUYpTJrbGDsr5WW3CC2fY

cURL

curl "https://www.simpleinout.com/api/v4/users/143/archive" -d '' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer FUCMOQ_BQPUIygQkdr_dTqHUYpTJrbGDsr5WW3CC2fY"

Respuesta

Simulated Response

Estado

204

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.

Punto de llegada

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

Parametros

Name Description
future[status] requerido (string) must be 'in', 'remote', 'busy', 'break', 'out', 'sick', or 'vacation'
future[apply_at] requerido (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
future[end_at] (integer) epoch time to end the scheduled status, must be after apply_at, have minutes within (00, 15, 30, 45), and seconds of 0
expand (string) comma-delimited list of extra information to include in the response, possibilities include: 'user', 'changed_by_user'

Solicitud

Ruta

POST /api/v4/users/4/futures

Encabezados

Content-Type: application/json
Authorization: Bearer LygewelvaqtAlEhsQGyTRZ5sQ39AHKggaGb2vkpQSZE

Cuerpo

{
  "future": {
    "status": "out",
    "apply_at": 1752368400,
    "comment": "On Vacation",
    "end_at": 1752627600
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/users/4/futures" -d '{"future":{"status":"out","apply_at":1752368400,"comment":"On Vacation","end_at":1752627600}}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer LygewelvaqtAlEhsQGyTRZ5sQ39AHKggaGb2vkpQSZE"

Respuesta

Simulated Response

Campos de respuesta

Name Description
futures (object) the newly created future object

Estado

201

Encabezados

ETag: W/"13696c3aa41b3c27b8ca002faaffa455"

Cuerpo

{
  "futures": {
    "id": "1",
    "status": "out",
    "comment": "On Vacation",
    "completed": false,
    "apply_at": 1752368400,
    "end_at": 1752627600,
    "user_id": "4",
    "changed_by_user_id": "3"
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1746150210,
      "beacons": 1738637010,
      "desktop_presences": 1742435010,
      "favorites": 1744335810,
      "fences": 1742607810,
      "groups": 1746927810,
      "networks": 1746841410,
      "roles": 1747100610,
      "settings": 1747100610
    },
    "emergency": null
  }
}

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.

Punto de llegada

POST /api/v4/users/my/futures

Parametros

Name Description
future[status] requerido (string) must be 'in', 'remote', 'busy', 'break', 'out', 'sick', or 'vacation'
future[apply_at] requerido (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
future[end_at] (integer) epoch time to end the scheduled status, must be after apply_at, have minutes within (00, 15, 30, 45), and seconds of 0
expand (string) comma-delimited list of extra information to include in the response, possibilities include: 'user', 'changed_by_user'

Solicitud

Ruta

POST /api/v4/users/my/futures

Encabezados

Content-Type: application/json
Authorization: Bearer YnPYUzp_H5O5zLX5RM6jDYIPqKdoZySYEbms2Lz4NWg

Cuerpo

{
  "future": {
    "status": "out",
    "apply_at": 1752368400,
    "comment": "On Vacation",
    "end_at": 1752627600
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/users/my/futures" -d '{"future":{"status":"out","apply_at":1752368400,"comment":"On Vacation","end_at":1752627600}}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer YnPYUzp_H5O5zLX5RM6jDYIPqKdoZySYEbms2Lz4NWg"

Respuesta

Simulated Response

Campos de respuesta

Name Description
futures (object) the newly created future object

Estado

201

Encabezados

ETag: W/"e0c3332fed9f5b1405029c9f93c1611e"

Cuerpo

{
  "futures": {
    "id": "6",
    "status": "out",
    "comment": "On Vacation",
    "completed": false,
    "apply_at": 1752368400,
    "end_at": 1752627600,
    "user_id": "48",
    "changed_by_user_id": null
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1742780610,
      "beacons": 1742867010,
      "desktop_presences": 1740883410,
      "favorites": 1743471810,
      "fences": 1740451410,
      "groups": 1744335810,
      "networks": 1745804610,
      "roles": 1747100611,
      "settings": 1747100611
    },
    "emergency": null
  }
}

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.

Punto de llegada

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

Parametros

Name Description
status[status] requerido (string) must be 'in', 'remote', 'busy', 'break', 'out', 'sick', or 'vacation'
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 parameter 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.favorites', 'user.latest', 'user.memberships', 'user.phones', 'user.recents', 'changed_by_user', 'application'

Solicitud

Ruta

POST /api/v4/users/6/statuses

Encabezados

Content-Type: application/json
Authorization: Bearer SWi8QR8NIZD2V87Qvu4Up46FMzBJhpsIPVSUHi0sS6c

Cuerpo

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

cURL

curl "https://www.simpleinout.com/api/v4/users/6/statuses" -d '{"status":{"status":"in","comment":"In at HQ"}}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer SWi8QR8NIZD2V87Qvu4Up46FMzBJhpsIPVSUHi0sS6c"

Respuesta

Simulated Response

Campos de respuesta

Name Description
statuses (object) the newly created status object

Estado

201

Encabezados

ETag: W/"873390e3c536319c6970df6bfade2488"

Cuerpo

{
  "statuses": {
    "status": "in",
    "comment": "In at HQ",
    "automatic": false,
    "user_id": "6",
    "changed_by_user_id": "5",
    "created_at": 1747100610
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1743903810,
      "beacons": 1744076610,
      "desktop_presences": 1744508610,
      "favorites": 1739155410,
      "fences": 1744854210,
      "groups": 1741571010,
      "networks": 1746582210,
      "roles": 1747100610,
      "settings": 1747100610
    },
    "emergency": null
  }
}

Create a status update for a user without attribution

Changes a user’s status, but does so without populating the admin that did it. The user that is authenticated must have a role that’s permitted to set up tablet access.

Punto de llegada

POST /api/v4/users/:id/statuses_without_fingerprint

Parametros

Name Description
status[status] requerido (string) must be 'in', 'remote', 'busy', 'break', 'out', 'sick', 'vacation', or 'toggle'
status[comment] (string/hash) string is up to 50 character description of the status update, hash would contain values for 'in' and 'out' for toggle, and the API will choose the appropriate one
expand (string) comma-delimited list of extra information to include in the response, possibilities include: 'user', 'user.favorites', 'user.latest', 'user.memberships', 'user.phones', 'user.recents', 'changed_by_user', 'application'

Solicitud

Ruta

POST /api/v4/users/30/statuses_without_fingerprint

Encabezados

Content-Type: application/json
Authorization: Bearer hz5PcI-G7kfXOv6wjONQd9K5ll81nO4re4yZLVNyTAU

Cuerpo

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

cURL

curl "https://www.simpleinout.com/api/v4/users/30/statuses_without_fingerprint" -d '{"status":{"status":"in","comment":"In at HQ"}}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer hz5PcI-G7kfXOv6wjONQd9K5ll81nO4re4yZLVNyTAU"

Respuesta

Simulated Response

Campos de respuesta

Name Description
statuses (object) the newly created status object

Estado

201

Encabezados

ETag: W/"c7aa480467c803942d1178db23dc17c7"

Cuerpo

{
  "statuses": {
    "status": "in",
    "comment": "In at HQ",
    "automatic": false,
    "user_id": "30",
    "changed_by_user_id": null,
    "created_at": 1747100610
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1741315410,
      "beacons": 1741229010,
      "desktop_presences": 1743299010,
      "favorites": 1741488210,
      "fences": 1746927810,
      "groups": 1743471810,
      "networks": 1739501010,
      "roles": 1747100610,
      "settings": 1747100610
    },
    "emergency": null,
    "update_available": false
  }
}

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.

Punto de llegada

POST /api/v4/users/my/statuses

Parametros

Name Description
status[status] requerido (string) must be 'in', 'remote', 'busy', 'break', 'out', 'sick', or 'vacation'
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 parameter 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.favorites', 'user.latest', 'user.memberships', 'user.phones', 'user.recents', 'changed_by_user', 'application'

Solicitud

Ruta

POST /api/v4/users/my/statuses

Encabezados

Content-Type: application/json
Authorization: Bearer tQWSnM0MQsK1qkfKom7JlyzDY3slupT2TDLpLebJz1o

Cuerpo

{
  "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 "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer tQWSnM0MQsK1qkfKom7JlyzDY3slupT2TDLpLebJz1o"

Respuesta

Simulated Response

Campos de respuesta

Name Description
statuses (object) the newly created status object

Estado

201

Encabezados

ETag: W/"e0a096116b698797afcf41685681e211"

Cuerpo

{
  "statuses": {
    "status": "in",
    "comment": "In at HQ",
    "automatic": false,
    "user_id": "24",
    "changed_by_user_id": null,
    "created_at": 1747100610
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1741488210,
      "beacons": 1743126210,
      "desktop_presences": 1738982610,
      "favorites": 1743471810,
      "fences": 1744335810,
      "groups": 1741916610,
      "networks": 1742867010,
      "roles": 1747100610,
      "settings": 1747100610
    },
    "emergency": null
  }
}

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.

Punto de llegada

POST /api/v4/users

Parametros

Name Description
user[email] requerido (string) new user's email address
user[name] requerido (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 en, en-au, en-ca, en-gb, de, es, fr, fr-ca
user[image_url] (string) url of an image for the user, must be an https url
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] requerido (string) the ID of the role to assign to the user
user[skip_confirmation_email] (boolean) whether to send a welcome email for the new user to choose their password, defaults to false which makes certain the email is sent
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: 'badge', 'favorites', 'latest', 'memberships', 'memberships.group', 'permissions', 'phones', 'status', 'status.application', 'status.changed_by_user', 'recents', 'role'

Solicitud

Ruta

POST /api/v4/users

Encabezados

Content-Type: application/json
Authorization: Bearer _RV1xHnH7i7odeaNhusGYi-kpkTgQ5JnDRt7C9RFMNQ

Cuerpo

{
  "user": {
    "email": "bojack@simplymadeapps.com",
    "name": "Bojack Horseman",
    "details": "Lead Actor",
    "lang": "en",
    "image_url": "https://placehold.it/350x150",
    "phones_attributes": [
      {
        "number": "(769) 425-2711 x8421"
      }
    ],
    "memberships_attributes": [
      {
        "group_id": 5
      }
    ],
    "role_id": "57"
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/users" -d '{"user":{"email":"bojack@simplymadeapps.com","name":"Bojack Horseman","details":"Lead Actor","lang":"en","image_url":"https://placehold.it/350x150","phones_attributes":[{"number":"(769) 425-2711 x8421"}],"memberships_attributes":[{"group_id":5}],"role_id":"57"}}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer _RV1xHnH7i7odeaNhusGYi-kpkTgQ5JnDRt7C9RFMNQ"

Respuesta

Simulated Response

Campos de respuesta

Name Description
users (object) the newly created user object

Estado

201

Encabezados

ETag: W/"a8e4960b6b8034560283c2d6d3872aa2"

Cuerpo

{
  "users": {
    "id": "28",
    "name": "Bojack Horseman",
    "email": "bojack@simplymadeapps.com",
    "details": "Lead Actor",
    "lang": "en",
    "image_url": "https://simpleinout.s3.amazonaws.com/image_none.png",
    "role_id": "57",
    "announcements_read_at": 0,
    "created_at": 1747100610,
    "updated_at": 1747100610,
    "cached_at": "1747100610.644212000"
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1745891010,
      "beacons": 1743990210,
      "desktop_presences": 1746323010,
      "favorites": 1739241810,
      "fences": 1742175810,
      "groups": 1747100610,
      "networks": 1740192210,
      "roles": 1747100610,
      "settings": 1747100610
    },
    "emergency": null,
    "update_available": false
  }
}

Create/Update user favorites

Creates user favorites (Quick Picks). If user favorites exist, they will be overwritten by the new ones. Users are limited to 10 favorites.

Punto de llegada

POST /api/v4/users/my/favorites

Parametros

Name Description
favorites requerido (array) array of objects consisting of 'status' and 'comment'
expand (string) comma-delimited list of extra information to include in the response, possibilities include: 'badge', 'favorites', 'latest', 'memberships', 'memberships.group', 'permissions', 'phones', 'status', 'status.application', 'status.changed_by_user', 'recents', 'role'
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'

Solicitud

Ruta

POST /api/v4/users/my/favorites

Encabezados

Content-Type: application/json
Authorization: Bearer 8JyU9oJpoRbN3J2G9UWodwMyTepaAuVy_te8HotkNko

Cuerpo

{
  "favorites": [
    {
      "status": "in",
      "comment": "At Work"
    },
    {
      "status": "out",
      "comment": "On Vacation"
    }
  ],
  "expand": "favorites"
}

cURL

curl "https://www.simpleinout.com/api/v4/users/my/favorites" -d '{"favorites":[{"status":"in","comment":"At Work"},{"status":"out","comment":"On Vacation"}],"expand":"favorites"}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer 8JyU9oJpoRbN3J2G9UWodwMyTepaAuVy_te8HotkNko"

Respuesta

Simulated Response

Campos de respuesta

Name Description
users (object) the newly updated user attributes

Estado

200

Encabezados

ETag: W/"f158a8e2fe473a237181b9aa9923fc40"

Cuerpo

{
  "users": {
    "id": "18",
    "name": "Sterling Archer",
    "email": "sterling@simplymadeapps.com",
    "details": "Minus atque voluptas.",
    "lang": "en",
    "image_url": "https://simpleinout.s3.amazonaws.com/image_none.png",
    "favorites": [
      {
        "status": "in",
        "comment": "At Work"
      },
      {
        "status": "out",
        "comment": "On Vacation"
      }
    ],
    "role_id": "35",
    "announcements_read_at": 0,
    "created_at": 1747100610,
    "updated_at": 1747100610,
    "cached_at": "1747100610.408776000"
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1739414610,
      "beacons": 1747100610,
      "desktop_presences": 1739328210,
      "favorites": 1741830210,
      "fences": 1746755010,
      "groups": 1741571010,
      "networks": 1744508610,
      "roles": 1747100610,
      "settings": 1747100610
    },
    "emergency": null
  }
}

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.

Punto de llegada

DELETE /api/v4/users/:id

Solicitud

Ruta

DELETE /api/v4/users/34

Encabezados

Content-Type: application/json
Authorization: Bearer Aqa48gO4XynoR_YHbEPOPaUAP1fW3MzmEVyiSSydcK4

cURL

curl "https://www.simpleinout.com/api/v4/users/34" -d '' -X DELETE \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer Aqa48gO4XynoR_YHbEPOPaUAP1fW3MzmEVyiSSydcK4"

Respuesta

Simulated Response

Estado

204

Favorite a status for the current user

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

Punto de llegada

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

Parametros

Name Description
status[status] requerido (string) must be 'in', 'remote', 'busy', 'break', 'out', 'sick', or 'vacation'
status[comment] (string) up to 50 character description of the status update

Solicitud

Ruta

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

Encabezados

Content-Type: application/json
Authorization: Bearer -mPO4iMzcOMYAlc7JbFDQO_RV7eg1QyY1tXO40eoYS8

Cuerpo

{
  "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 "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer -mPO4iMzcOMYAlc7JbFDQO_RV7eg1QyY1tXO40eoYS8"

Respuesta

Simulated Response

Estado

204

Hide a status for the current user

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

Punto de llegada

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

Parametros

Name Description
status[status] requerido (string) must be 'in', 'remote', 'busy', 'break', 'out', 'sick', or 'vacation'
status[comment] (string) up to 50 character description of the status update

Solicitud

Ruta

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

Encabezados

Content-Type: application/json
Authorization: Bearer w_xtZTLTs3BeDQGfENiYX0lprs3U8nP_YtU9SGJ2iSw

Cuerpo

{
  "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 "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer w_xtZTLTs3BeDQGfENiYX0lprs3U8nP_YtU9SGJ2iSw"

Respuesta

Simulated Response

Estado

204

List all archived users

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

Punto de llegada

GET /api/v4/users?archived=true

Solicitud

Ruta

GET /api/v4/users?archived=true

Encabezados

Content-Type: application/json
Authorization: Bearer TQkZOgkAYlYgBisVuEgIeFJEAvJz8V3eVsMOEZ1aN8k

Parámetros de la consulta

archived=true

cURL

curl -g "https://www.simpleinout.com/api/v4/users?archived=true" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer TQkZOgkAYlYgBisVuEgIeFJEAvJz8V3eVsMOEZ1aN8k"

Respuesta

Simulated Response

Estado

200

Encabezados

ETag: W/"288e61f383f4abcb659c5b221de84909"
Last-Modified: Tue, 13 May 2025 01:43:33 GMT

Cuerpo

{
  "users": [
    {
      "id": "141",
      "name": "Raul Botsford",
      "email": null,
      "details": "Autem voluptatem commodi.",
      "lang": "en",
      "image_url": "https://simpleinout.s3.amazonaws.com/image_none.png",
      "role_id": null,
      "announcements_read_at": 0,
      "created_at": 1747100613,
      "updated_at": 1747100613,
      "cached_at": "1747100613.558536000"
    }
  ],
  "meta": {
    "paging": {
      "page": 1,
      "page_size": 25,
      "page_count": 1,
      "count": 1,
      "previous_page": null,
      "next_page": null,
      "first_href": "http://example.org/api/v4/users?archived=true",
      "last_href": "http://example.org/api/v4/users?archived=true",
      "previous_href": null,
      "next_href": null
    },
    "last_updated_at": {
      "announcements": 1745631813,
      "beacons": 1743299013,
      "desktop_presences": 1744335813,
      "favorites": 1745718213,
      "fences": 1741657413,
      "groups": 1746927813,
      "networks": 1745804613,
      "roles": 1747100613,
      "settings": 1747100613
    },
    "emergency": null,
    "trusted_cached_at": "1747100598.565678100"
  }
}

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.

Punto de llegada

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

Parametros

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

Solicitud

Ruta

GET /api/v4/users/7/futures

Encabezados

Content-Type: application/json
Authorization: Bearer Gk1Y3Bu_pjFy55xgvRJJGhDokLk1r_U9xIabft1Q-2E

cURL

curl -g "https://www.simpleinout.com/api/v4/users/7/futures" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer Gk1Y3Bu_pjFy55xgvRJJGhDokLk1r_U9xIabft1Q-2E"

Respuesta

Simulated Response

Campos de respuesta

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

Estado

200

Encabezados

ETag: W/"3593067c0e42c465690911ddbfdd8051"
Last-Modified: Tue, 13 May 2025 01:43:30 GMT

Cuerpo

{
  "futures": [
    {
      "id": "2",
      "status": "out",
      "comment": "Offsite Meeting",
      "completed": false,
      "apply_at": 1747638000,
      "end_at": null,
      "user_id": "7",
      "changed_by_user_id": null
    },
    {
      "id": "3",
      "status": "out",
      "comment": "Gone Fishing",
      "completed": false,
      "apply_at": 1753095600,
      "end_at": 1753268400,
      "user_id": "7",
      "changed_by_user_id": "8"
    }
  ],
  "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/7/futures?user_id=7",
      "last_href": "http://example.org/api/v4/users/7/futures?user_id=7",
      "previous_href": null,
      "next_href": null
    },
    "last_updated_at": {
      "announcements": 1745631810,
      "beacons": 1746150210,
      "desktop_presences": 1738809810,
      "favorites": 1745113410,
      "fences": 1738723410,
      "groups": 1739414610,
      "networks": 1746495810,
      "roles": 1747100610,
      "settings": 1747100610
    },
    "emergency": null
  }
}

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.

Punto de llegada

GET /api/v4/users/my/futures

Parametros

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

Solicitud

Ruta

GET /api/v4/users/my/futures

Encabezados

Content-Type: application/json
Authorization: Bearer E8_PIYx61Rb-uCIKMCq9P-qGWKteiwYYOAJ0AXSCxEM

cURL

curl -g "https://www.simpleinout.com/api/v4/users/my/futures" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer E8_PIYx61Rb-uCIKMCq9P-qGWKteiwYYOAJ0AXSCxEM"

Respuesta

Simulated Response

Campos de respuesta

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

Estado

200

Encabezados

ETag: W/"546d2d0bb09a9d6469fab09590194f57"
Last-Modified: Tue, 13 May 2025 01:43:30 GMT

Cuerpo

{
  "futures": [
    {
      "id": "4",
      "status": "out",
      "comment": "Offsite Meeting",
      "completed": false,
      "apply_at": 1747638000,
      "end_at": null,
      "user_id": "40",
      "changed_by_user_id": null
    },
    {
      "id": "5",
      "status": "out",
      "comment": "Gone Fishing",
      "completed": false,
      "apply_at": 1753095600,
      "end_at": 1753268400,
      "user_id": "40",
      "changed_by_user_id": "41"
    }
  ],
  "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=40",
      "last_href": "http://example.org/api/v4/users/my/futures?user_id=40",
      "previous_href": null,
      "next_href": null
    },
    "last_updated_at": {
      "announcements": 1739933010,
      "beacons": 1738809810,
      "desktop_presences": 1741229010,
      "favorites": 1743299010,
      "fences": 1742089410,
      "groups": 1745891010,
      "networks": 1746927810,
      "roles": 1747100610,
      "settings": 1747100610
    },
    "emergency": null
  }
}

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.

Punto de llegada

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

Parametros

Name Description
created_at requerido (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.favorites', 'user.latest', '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

Solicitud

Ruta

GET /api/v4/users/21/statuses?created_at=1746421200..1746680399

Encabezados

Content-Type: application/json
Authorization: Bearer M6hql5Cs4v80lbQDWla8pzpuOhL0bvmjaG9LY3WmsLo

Parámetros de la consulta

created_at=1746421200..1746680399

cURL

curl -g "https://www.simpleinout.com/api/v4/users/21/statuses?created_at=1746421200..1746680399" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer M6hql5Cs4v80lbQDWla8pzpuOhL0bvmjaG9LY3WmsLo"

Respuesta

Simulated Response

Campos de respuesta

Name Description
statuses (array) an array of matching statuses

Estado

200

Encabezados

ETag: W/"35ec2295cc52eabe167aad606dc6fdf8"
Last-Modified: Tue, 06 May 2025 14:00:00 GMT

Cuerpo

{
  "statuses": [
    {
      "status": "in",
      "comment": "At Work",
      "automatic": false,
      "user_id": "21",
      "changed_by_user_id": null,
      "created_at": 1746428400
    },
    {
      "status": "out",
      "comment": "Left Work",
      "automatic": false,
      "user_id": "21",
      "changed_by_user_id": null,
      "created_at": 1746442800
    },
    {
      "status": "in",
      "comment": "At Work",
      "automatic": false,
      "user_id": "21",
      "changed_by_user_id": null,
      "created_at": 1746446400
    },
    {
      "status": "out",
      "comment": "Left Work",
      "automatic": false,
      "user_id": "21",
      "changed_by_user_id": null,
      "created_at": 1746464400
    },
    {
      "status": "in",
      "comment": "At Work",
      "automatic": false,
      "user_id": "21",
      "changed_by_user_id": null,
      "created_at": 1746514800
    },
    {
      "status": "out",
      "comment": "Left Work",
      "automatic": false,
      "user_id": "21",
      "changed_by_user_id": null,
      "created_at": 1746536400
    },
    {
      "status": "out",
      "comment": "Vacation",
      "automatic": false,
      "user_id": "21",
      "changed_by_user_id": "22",
      "created_at": 1746540000
    }
  ],
  "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/21/statuses?created_at=1746421200..1746680399&user_id=21",
      "last_href": "http://example.org/api/v4/users/21/statuses?created_at=1746421200..1746680399&user_id=21",
      "previous_href": null,
      "next_href": null
    },
    "last_updated_at": {
      "announcements": 1739673810,
      "beacons": 1743039810,
      "desktop_presences": 1743471810,
      "favorites": 1738723410,
      "fences": 1741488210,
      "groups": 1744767810,
      "networks": 1739328210,
      "roles": 1747100610,
      "settings": 1747100610
    },
    "emergency": null
  }
}

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.

Punto de llegada

GET /api/v4/users/my/statuses

Parametros

Name Description
created_at requerido (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.favorites', 'user.latest', '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

Solicitud

Ruta

GET /api/v4/users/my/statuses?created_at=1746421200..1746680399

Encabezados

Content-Type: application/json
Authorization: Bearer V2ETemZ16Q5buBAXamAdL8fxPI03JOeUaxyGE32EU84

Parámetros de la consulta

created_at=1746421200..1746680399

cURL

curl -g "https://www.simpleinout.com/api/v4/users/my/statuses?created_at=1746421200..1746680399" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer V2ETemZ16Q5buBAXamAdL8fxPI03JOeUaxyGE32EU84"

Respuesta

Simulated Response

Campos de respuesta

Name Description
statuses (array) an array of matching statuses

Estado

200

Encabezados

ETag: W/"0a9570397781965090baa566ec581f0c"
Last-Modified: Tue, 06 May 2025 14:00:00 GMT

Cuerpo

{
  "statuses": [
    {
      "status": "in",
      "comment": "At Work",
      "automatic": false,
      "user_id": "10",
      "changed_by_user_id": null,
      "created_at": 1746428400
    },
    {
      "status": "out",
      "comment": "Left Work",
      "automatic": false,
      "user_id": "10",
      "changed_by_user_id": null,
      "created_at": 1746442800
    },
    {
      "status": "in",
      "comment": "At Work",
      "automatic": false,
      "user_id": "10",
      "changed_by_user_id": null,
      "created_at": 1746446400
    },
    {
      "status": "out",
      "comment": "Left Work",
      "automatic": false,
      "user_id": "10",
      "changed_by_user_id": null,
      "created_at": 1746464400
    },
    {
      "status": "in",
      "comment": "At Work",
      "automatic": false,
      "user_id": "10",
      "changed_by_user_id": null,
      "created_at": 1746514800
    },
    {
      "status": "out",
      "comment": "Left Work",
      "automatic": false,
      "user_id": "10",
      "changed_by_user_id": null,
      "created_at": 1746536400
    },
    {
      "status": "out",
      "comment": "Vacation",
      "automatic": false,
      "user_id": "10",
      "changed_by_user_id": "11",
      "created_at": 1746540000
    }
  ],
  "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=1746421200..1746680399&user_id=10",
      "last_href": "http://example.org/api/v4/users/my/statuses?created_at=1746421200..1746680399&user_id=10",
      "previous_href": null,
      "next_href": null
    },
    "last_updated_at": {
      "announcements": 1742003010,
      "beacons": 1740192210,
      "desktop_presences": 1744595010,
      "favorites": 1739760210,
      "fences": 1738637010,
      "groups": 1744767810,
      "networks": 1740451410,
      "roles": 1747100610,
      "settings": 1747100610
    },
    "emergency": null
  }
}

List all users

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

Punto de llegada

GET /api/v4/users

Parametros

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: 'badge', 'favorites', 'latest', 'memberships', 'memberships.group', 'permissions', 'phones', 'status', 'status.application', 'status.changed_by_user', 'recents', 'role'

Solicitud

Ruta

GET /api/v4/users

Encabezados

Content-Type: application/json
Authorization: Bearer pkQZZfIw_bAuaQBhoa2OK7UT03J-uMvMXH2YkjYoM4A

cURL

curl -g "https://www.simpleinout.com/api/v4/users" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer pkQZZfIw_bAuaQBhoa2OK7UT03J-uMvMXH2YkjYoM4A"

Respuesta

Simulated Response

Campos de respuesta

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

Estado

200

Encabezados

ETag: W/"55a395cbb32c225868d59f34967f8274"
Last-Modified: Tue, 13 May 2025 01:43:30 GMT

Cuerpo

{
  "users": [
    {
      "id": "42",
      "name": "Malory Archer",
      "email": "malory@simplymadeapps.com",
      "details": "Modi sit dicta.",
      "lang": "en",
      "image_url": "https://simpleinout.s3.amazonaws.com/image_none.png",
      "role_id": "85",
      "announcements_read_at": 0,
      "created_at": 1747100610,
      "updated_at": 1747100610,
      "cached_at": "1747100610.931798000"
    },
    {
      "id": "43",
      "name": "Sterling Archer",
      "email": "sterling@simplymadeapps.com",
      "details": "Ut dolores odit.",
      "lang": "en",
      "image_url": "https://simpleinout.s3.amazonaws.com/image_none.png",
      "role_id": "87",
      "announcements_read_at": 0,
      "created_at": 1747100610,
      "updated_at": 1747100610,
      "cached_at": "1747100610.936643100"
    },
    {
      "id": "44",
      "name": "Lana Kane",
      "email": "lana@simplymadeapps.com",
      "details": "Vero voluptatem saepe.",
      "lang": "en",
      "image_url": "https://simpleinout.s3.amazonaws.com/image_none.png",
      "role_id": "87",
      "announcements_read_at": 0,
      "created_at": 1747100610,
      "updated_at": 1747100610,
      "cached_at": "1747100610.942260000"
    },
    {
      "id": "45",
      "name": "Ray Gillette",
      "email": "ray@simplymadeapps.com",
      "details": "Molestias ea tenetur.",
      "lang": "en",
      "image_url": "https://simpleinout.s3.amazonaws.com/image_none.png",
      "role_id": "87",
      "announcements_read_at": 0,
      "created_at": 1747100610,
      "updated_at": 1747100610,
      "cached_at": "1747100610.946899000"
    }
  ],
  "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": {
      "announcements": 1742607810,
      "beacons": 1738982610,
      "desktop_presences": 1739414610,
      "favorites": 1742607810,
      "fences": 1742003010,
      "groups": 1744249410,
      "networks": 1741657410,
      "roles": 1747100610,
      "settings": 1747100610
    },
    "emergency": null,
    "trusted_cached_at": "1747100595.953744000"
  }
}

Mark announcements as read

Marks announcements beforehand as read. If an epoch time from the future is passed in, it will become the current time.

Punto de llegada

POST /api/v4/users/my/announcements/read

Parametros

Name Description
read_at requerido (integer) epoch time denoting all announcements before this time have been read

Solicitud

Ruta

POST /api/v4/users/my/announcements/read

Encabezados

Content-Type: application/json
Authorization: Bearer heP80e8wlyMnMPTv1pm6UiJkSfdMIzxL9EBELAZTnc0

cURL

curl "https://www.simpleinout.com/api/v4/users/my/announcements/read" -d '' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer heP80e8wlyMnMPTv1pm6UiJkSfdMIzxL9EBELAZTnc0"

Respuesta

Simulated Response

Campos de respuesta

Name Description
users (object) the newly updated user attributes

Estado

204

Retrieve a user

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

Punto de llegada

GET /api/v4/users/:id

Parametros

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: 'badge', 'favorites', 'latest', 'memberships', 'memberships.group', 'permissions', 'phones', 'status', 'status.application', 'status.changed_by_user', 'recents', 'role'

Solicitud

Ruta

GET /api/v4/users/38

Encabezados

Content-Type: application/json
Authorization: Bearer JCaAV0br2peLUDzd9HRropkTjMxnXWFPYH9HeD8-Ja4

cURL

curl -g "https://www.simpleinout.com/api/v4/users/38" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer JCaAV0br2peLUDzd9HRropkTjMxnXWFPYH9HeD8-Ja4"

Respuesta

Simulated Response

Campos de respuesta

Name Description
users (object) a user object

Estado

200

Encabezados

ETag: W/"2d39cbf69bd875b8d7720b3537cf4e2a"
Last-Modified: Tue, 13 May 2025 01:43:30 GMT

Cuerpo

{
  "users": {
    "id": "38",
    "name": "Sterling Archer",
    "email": "sterling@simplymadeapps.com",
    "details": "Alias adipisci aliquid.",
    "lang": "en",
    "image_url": "https://simpleinout.s3.amazonaws.com/image_none.png",
    "role_id": "79",
    "announcements_read_at": 0,
    "created_at": 1747100610,
    "updated_at": 1747100610,
    "cached_at": "1747100610.864307000"
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1739155410,
      "beacons": 1739587410,
      "desktop_presences": 1742953410,
      "favorites": 1739933010,
      "fences": 1742607810,
      "groups": 1741056210,
      "networks": 1741916610,
      "roles": 1747100610,
      "settings": 1747100610
    },
    "emergency": null
  }
}

Retrieve the current user

Retrieve the current user who is authorized.

Punto de llegada

GET /api/v4/users/my

Parametros

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: 'badge', 'favorites', 'latest', 'memberships', 'memberships.group', 'permissions', 'phones', 'status', 'status.application', 'status.changed_by_user', 'recents', 'role'

Solicitud

Ruta

GET /api/v4/users/my

Encabezados

Content-Type: application/json
Authorization: Bearer _yWpUBeFXo06sQnwKsZGr4AE-DmKkmgiWtTZ965U-R8

cURL

curl -g "https://www.simpleinout.com/api/v4/users/my" -X GET \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer _yWpUBeFXo06sQnwKsZGr4AE-DmKkmgiWtTZ965U-R8"

Respuesta

Simulated Response

Campos de respuesta

Name Description
users (object) a user object

Estado

200

Encabezados

ETag: W/"9f272d0bb8359b2dadea6dc643456daa"
Last-Modified: Tue, 13 May 2025 01:43:30 GMT

Cuerpo

{
  "users": {
    "id": "2",
    "name": "Sterling Archer",
    "email": "sterling@simplymadeapps.com",
    "details": "Cupiditate iure eaque.",
    "lang": "en",
    "image_url": "https://simpleinout.s3.amazonaws.com/image_none.png",
    "role_id": "3",
    "announcements_read_at": 0,
    "created_at": 1747100610,
    "updated_at": 1747100610,
    "cached_at": "1747100610.014313000"
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1745199809,
      "beacons": 1739328209,
      "desktop_presences": 1743212609,
      "favorites": 1739933009,
      "fences": 1738550609,
      "groups": 1745286209,
      "networks": 1743299009,
      "roles": 1747100609,
      "settings": 1747100609
    },
    "emergency": null
  }
}

Unarchive a user

Unarchives an archived user. Users must have a role that permits managing users.

Punto de llegada

POST /api/v4/users/:id/unarchive

Parametros

Name Description
user[email] requerido (string) the user's email address
user[name] (string) the 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 en, en-au, en-ca, en-gb, de, es, fr, fr-ca
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] requerido (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: 'badge', 'favorites', 'latest', 'memberships', 'memberships.group', 'permissions', 'phones', 'status', 'status.application', 'status.changed_by_user', 'recents', 'role'

Solicitud

Ruta

POST /api/v4/users/101/unarchive

Encabezados

Content-Type: application/json
Authorization: Bearer Y_T09q16QdLWLzw-6a7w9_M3mhVSO87bBmeTj_O2yZ0

Cuerpo

{
  "user": {
    "email": "bojack@simplymadeapps.com",
    "role_id": "253"
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/users/101/unarchive" -d '{"user":{"email":"bojack@simplymadeapps.com","role_id":"253"}}' -X POST \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer Y_T09q16QdLWLzw-6a7w9_M3mhVSO87bBmeTj_O2yZ0"

Respuesta

Simulated Response

Estado

200

Encabezados

ETag: W/"cfdf793d903c15dcd0d9144fc3697022"

Cuerpo

{
  "users": {
    "id": "101",
    "name": "Heriberto Fadel",
    "email": "bojack@simplymadeapps.com",
    "details": "Maiores voluptas minima.",
    "lang": "en",
    "image_url": "https://simpleinout.s3.amazonaws.com/image_none.png",
    "role_id": "253",
    "created_at": 1747100612,
    "updated_at": 1747100612,
    "cached_at": "1747100612.410651000"
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1745977412,
      "beacons": 1743558212,
      "desktop_presences": 1743990212,
      "favorites": 1741916612,
      "fences": 1746841412,
      "groups": 1746495812,
      "networks": 1741657412,
      "roles": 1747100612,
      "settings": 1747100612
    },
    "emergency": null
  }
}

Unfavorite a status for the current user

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

Punto de llegada

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

Parametros

Name Description
status[status] requerido (string) must be 'in', 'remote', 'busy', 'break', 'out', 'sick', or 'vacation'
status[comment] (string) up to 50 character description of the status update

Solicitud

Ruta

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

Encabezados

Content-Type: application/json
Authorization: Bearer yOMMChALcxZ6lfJr-klc2uSZovFw_QEjy7GbGZaDhEQ

Cuerpo

{
  "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 "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Authorization: Bearer yOMMChALcxZ6lfJr-klc2uSZovFw_QEjy7GbGZaDhEQ"

Respuesta

Simulated Response

Estado

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.

Punto de llegada

PATCH /api/v4/users/:id

Parametros

Name Description
user[email] (string) new user's email address
user[name] (string) new user's full name
user[image_url] (string) url of an image for the user, must be an https url
user[details] (string) additional text information about the user
user[lang] (string) preferred locale of the user, can be en, en-au, en-ca, en-gb, de, es, fr, fr-ca
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: 'badge', 'favorites', 'latest', 'memberships', 'memberships.group', 'permissions', 'phones', 'status', 'status.application', 'status.changed_by_user', 'recents', 'role'

Solicitud

Ruta

PATCH /api/v4/users/32

Encabezados

Content-Type: application/json
Authorization: Bearer USRWpprgvMP3NisySFnGaBMDXsZruWFLohBsmE47eok

Cuerpo

{
  "user": {
    "phones_attributes": [
      {
        "number": "600.775.5342 x9362"
      }
    ],
    "memberships_attributes": [
      {
        "group_id": 6
      }
    ]
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/users/32" -d '{"user":{"phones_attributes":[{"number":"600.775.5342 x9362"}],"memberships_attributes":[{"group_id":6}]}}' -X PATCH \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer USRWpprgvMP3NisySFnGaBMDXsZruWFLohBsmE47eok"

Respuesta

Simulated Response

Campos de respuesta

Name Description
users (object) the newly updated user attributes

Estado

200

Encabezados

ETag: W/"064b4534c766be4b41f82ab171e5fe3d"

Cuerpo

{
  "users": {
    "id": "32",
    "name": "Sterling Archer",
    "email": "sterling@simplymadeapps.com",
    "details": "Autem est quas.",
    "lang": "en",
    "image_url": "https://simpleinout.s3.amazonaws.com/image_none.png",
    "role_id": "67",
    "announcements_read_at": 0,
    "created_at": 1747100610,
    "updated_at": 1747100610,
    "cached_at": "1747100610.713598000"
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1739933010,
      "beacons": 1743039810,
      "desktop_presences": 1739069010,
      "favorites": 1740624210,
      "fences": 1738637010,
      "groups": 1747100610,
      "networks": 1745199810,
      "roles": 1747100610,
      "settings": 1747100610
    },
    "emergency": null,
    "update_available": false
  }
}

Update the current user

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

Punto de llegada

PATCH /api/v4/users/my

Parametros

Name Description
user[email] (string) new user's email address
user[name] (string) new user's full name
user[image_url] (string) url of an image for the user, must be an https url
user[details] (string) additional text information about the user
user[lang] (string) preferred locale of the user, can be en, en-au, en-ca, en-gb, de, es, fr, fr-ca
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: 'badge', 'favorites', 'latest', 'memberships', 'memberships.group', 'permissions', 'phones', 'status', 'status.application', 'status.changed_by_user', 'recents', 'role'

Solicitud

Ruta

PATCH /api/v4/users/my

Encabezados

Content-Type: application/json
Authorization: Bearer OkhSYivpV86WX5-xBBbZQlzvKJpQ_Hq_tgSbx5WcUTM

Cuerpo

{
  "user": {
    "phones_attributes": [
      {
        "number": "1-445-203-6239 x5873"
      }
    ],
    "memberships_attributes": [
      {
        "group_id": 1
      }
    ]
  }
}

cURL

curl "https://www.simpleinout.com/api/v4/users/my" -d '{"user":{"phones_attributes":[{"number":"1-445-203-6239 x5873"}],"memberships_attributes":[{"group_id":1}]}}' -X PATCH \
	-H "Version: HTTP/1.0" \
	-H "Content-Type: application/json" \
	-H "Sio-Version: 1.0.0" \
	-H "Authorization: Bearer OkhSYivpV86WX5-xBBbZQlzvKJpQ_Hq_tgSbx5WcUTM"

Respuesta

Simulated Response

Campos de respuesta

Name Description
users (object) the newly updated user attributes

Estado

200

Encabezados

ETag: W/"c208922246c5af21458b56bedfa52d15"

Cuerpo

{
  "users": {
    "id": "12",
    "name": "Erika Jenkins",
    "email": "mallory@simplymadeapps.com",
    "details": "Blanditiis eligendi quis.",
    "lang": "en",
    "image_url": "https://simpleinout.s3.amazonaws.com/image_none.png",
    "role_id": "21",
    "announcements_read_at": 0,
    "created_at": 1747100610,
    "updated_at": 1747100610,
    "cached_at": "1747100610.308589000"
  },
  "meta": {
    "last_updated_at": {
      "announcements": 1745891010,
      "beacons": 1746927810,
      "desktop_presences": 1746150210,
      "favorites": 1743126210,
      "fences": 1743817410,
      "groups": 1747100610,
      "networks": 1746409410,
      "roles": 1747100610,
      "settings": 1747100610
    },
    "emergency": null,
    "update_available": false
  }
}