The RedeApp API is built using REST principles. It uses standard HTTP methods and response codes. Request/response bodies are typically in JSON format.
\nAuthentication is provided using an Authorization header with a bearer token. Refer to the authentication section for more details.
\nMany of the GET requests will respond with a paginated list. The query string parameters are \"page\" for the page number, and \"page_size\". For example, GET /api/groups/v1/groups?network_id=89f51460-bb3f-11e7-9b75-0242ac110003&page=2&page_size=20.
For help getting started with the API, visit our Getting Started Guide.
\nPlease send any questions or concerns to support@redeapp.com.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"928355","collectionId":"beab16b0-7cc4-4892-8570-b07dc0f705f5","publishedId":"TzsZq7wa","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"DB1F33"},"publishDate":"2025-02-19T18:52:17.000Z"},"item":[{"name":"Accounts","item":[{"name":"Create new account","id":"3e712dda-4a10-4291-94bd-f07bb9ee324f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"warning":"This is a duplicate header and will be overridden by the Content-Type header generated by Postman.","key":"Content-Type","value":"multipart/form-data","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"user","value":"{\"email\": \"\", \"username\": \"\", \"password\": \"\"}","type":"text"},{"key":"account","value":"{\"first_name\": \"\", \"last_name\": \"\"}","type":"text"}]},"url":"https://secure.redeapp.com/api/accounts/v1/accounts/create_new","description":"All fields are required.\nEmail address must be unique, and must be a valid email address. \nUsername must be between 1-16 characters, must contain at least 1 letter, must begin with a letter or number, and can only contain letters, numbers, underscores, or periods. \nPassword must be at least 8 characters and cannot contain a colon.
\n","urlObject":{"protocol":"https","path":["api","accounts","v1","accounts","create_new"],"host":["secure","redeapp","com"],"query":[],"variable":[]}},"response":[{"id":"b3a0777e-04ef-445c-ac96-c5b642e44ef1","name":"Create new account","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"user","value":"{\"email\":\"bobross+2@redeapp.com\",\"username\":\"bobross2\",\"password\":\"Responds with a list containing the account of the requesting user only.
\n","urlObject":{"protocol":"https","path":["api","accounts","v1","accounts"],"host":["secure","redeapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ca341529-ca9e-4e21-b1bc-a85cf82e47f4"},{"name":"Update account","id":"814830af-4426-4d68-9414-f93fe6253901","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"BearerDevices are unique by push token. As it is unknown whether your current device is already within our system, the same endpoint is used to either insert or update a device.
\n","urlObject":{"protocol":"https","path":["api","accounts","v1","devices","upsert"],"host":["secure","redeapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8a60fbc9-da5d-433a-8b79-2171fe3b401b"}],"id":"c45efbd6-16a5-4d26-82cb-0a783671d179","_postman_id":"c45efbd6-16a5-4d26-82cb-0a783671d179","description":""},{"name":"Analytics","item":[{"name":"Champs export","id":"e1a178c0-1c8c-4000-a4fc-30fb6737963a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"BearerObtain the API token to be used to authenticate all other requests. Please note that if the user's password changes, the token will be regenerated, and the old token value will no longer be able to authenticate.
\n","urlObject":{"protocol":"https","path":["api","auth","v1","bearer","login"],"host":["secure","redeapp","com"],"query":[],"variable":[]}},"response":[{"id":"7fb9f432-782c-439d-bc56-4ce9a3d24a62","name":"Get bearer token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"username\": \"georgesmith\",\n\t\"password\": \"oay5theiNgsi\"\n}","options":{"raw":{"language":"json"}}},"url":"https://secure.redeapp.com/api/auth/v1/bearer/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 03 Aug 2021 15:02:23 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"52"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Vary","value":"Cookie"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"google-site-verification","value":"8RBTV3Jq9Qs0AwcJGZKXD7vo9P37k__AokVAIDgu5XI"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"}],"cookie":[],"responseTime":null,"body":"{\n \"token\": \"b43e371c9d4a53e0cb2bbb58652bf40f6b0a4f5b\"\n}"}],"_postman_id":"0d624351-b93b-48da-885d-abf1bdeeca75"},{"name":"Regenerate bearer token","id":"bb6a7856-a07f-4965-98df-8eadc9500cfd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerObtain a new API token and invalidate the old token.
\n","urlObject":{"protocol":"https","path":["api","auth","v1","bearer","regenerate"],"host":["secure","redeapp","com"],"query":[],"variable":[]}},"response":[{"id":"ac045bef-8e91-43e7-9d3a-0a3a050bbec0","name":"Regenerate bearer token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerMay supply a username or email in the \"username\" field. Generates an email to the address on file for the given username or email, which contains a link with a unique key that is used when resetting password via the \"Confirm password reset\" endpoint.
\n","urlObject":{"protocol":"https","path":["api","auth","v1","users","reset_password"],"host":["secure","redeapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e4cf597d-52c8-474e-bb53-9369d8d6f7cb"},{"name":"Confirm password reset","id":"9e6a1e38-e39c-4b23-8e86-1268243a1979","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"key\": \"\",\n \"password\": \"\"\n}\n"},"url":"https://secure.redeapp.com/api/auth/v1/users/reset_password_confirm","description":"Uses the unique key generated from the \"Request password reset\" endpoint email to reset a user's password.
\n","urlObject":{"protocol":"https","path":["api","auth","v1","users","reset_password_confirm"],"host":["secure","redeapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9e6a1e38-e39c-4b23-8e86-1268243a1979"}],"id":"70ed4b94-c2da-4ceb-bc2d-85facb6ec4bd","_postman_id":"70ed4b94-c2da-4ceb-bc2d-85facb6ec4bd","description":""},{"name":"Auto Sender","item":[{"name":"List message triggers","id":"5658e2b0-a2e1-4467-a72e-09e6c8894499","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"BearerSet up a message to be sent to employees right after they connect to your network (activate their subscription).
\n","urlObject":{"protocol":"https","path":["api","autosender","v1","messagetriggers"],"host":["secure","redeapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5068d8c7-3755-4006-88c1-6e2ee619821c"},{"name":"Create recurring trigger","id":"90cc118b-e363-47e4-a685-fc9df464b5be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"BearerSet up a message to be sent on repeating interval. The frequency format is ISO 8601 repeating time interval.
\n","urlObject":{"protocol":"https","path":["api","autosender","v1","messagetriggers"],"host":["secure","redeapp","com"],"query":[],"variable":[]}},"response":[{"id":"43c8cff7-5ee3-4e50-a34d-b9c1d5adc1e6","name":"Create recurring trigger","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"BearerJust a friendly reminder...
Set up a message to be sent with recipients that match specific criteria. If the criteria uses a list, then the recipient search results will be current as of the latest list file upload.
\n","urlObject":{"protocol":"https","path":["api","autosender","v1","messagetriggers"],"host":["secure","redeapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ec7027f6-8703-4393-8702-71168f601822"},{"name":"Validate search","id":"2ecba298-5792-4eae-9a61-fd146cdb6140","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"BearerAutomate message sending using various trigger types. Each trigger is set up with a template message where the message contents will come from (see template message in the Messaging section).
\nMessages triggers will often contain a list file query, which is designed to set the message recipients according to the employees' row values in the latest list file (in Auto Sync).
\n","_postman_id":"cb069a10-e3e5-40b2-a5a8-4e5d88e4e1e1"},{"name":"Auto Sync","item":[{"name":"Lists","id":"d61bbd66-48e3-4de7-ba0c-ceb62ea81f53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"BearerThis is where employee lists and their associated data generating rules are kept. Each list has one-to-many list files. When employee data changes, a new list file can be uploaded, and the list rules will be processed (typically within a few minutes to an hour).
\n","_postman_id":"54d65b31-362b-4111-a3a1-72f1f193ef95"},{"name":"Contacts","item":[{"name":"List contacts","id":"100fee63-ee37-4e5e-84ed-3df1223035f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"BearerReturns a list of accounts that the user has marked as a \"Favorite\" contact.
\n","urlObject":{"protocol":"https","path":["api","contacts","v1","contacts"],"host":["secure","redeapp","com"],"query":[{"key":"network_id","value":""}],"variable":[]}},"response":[],"_postman_id":"100fee63-ee37-4e5e-84ed-3df1223035f3"},{"name":"Create contact","id":"9074c8cf-40ea-4889-86fd-3cc7817258e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"BearerMarks an account as a \"favorite\" contact.
\n","urlObject":{"protocol":"https","path":["api","contacts","v1","contacts"],"host":["secure","redeapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9074c8cf-40ea-4889-86fd-3cc7817258e5"},{"name":"List contact groups","id":"66ad537f-0943-4d5f-b0a5-7dfd6ccbde4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"BearerContact groups have been largely discontinued within the apps and can no longer be created within the apps. Lists contact groups that have been created from a list of favorite contacts.
\n","urlObject":{"protocol":"https","path":["api","contacts","v1","contactgroups"],"host":["secure","redeapp","com"],"query":[{"key":"network_id","value":""}],"variable":[]}},"response":[],"_postman_id":"66ad537f-0943-4d5f-b0a5-7dfd6ccbde4a"},{"name":"Create contact group","id":"6873bde6-d476-47c6-b443-d6cecda52270","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"BearerContact groups have been largely discontinued within the apps and can no longer be created within the apps. Creates a contact group from the user's favorite contacts. Contact groups are user-created broadcast groups.
\n","urlObject":{"protocol":"https","path":["api","contacts","v1","contactgroups"],"host":["secure","redeapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6873bde6-d476-47c6-b443-d6cecda52270"},{"name":"Update contact group","id":"17852d1b-5435-496e-8f2f-7a2e2322fe1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"BearerAlso known as \"favorites\". These are people found in the network directory that are favorited for quick messaging access.
\n","_postman_id":"91ed55c6-37a6-46fb-9b0e-445b006721c6"},{"name":"Forms","item":[{"name":"List forms folders","id":"75434635-132c-4ef8-be15-75b73c8bc928","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"BearerFirst make a POST request for each attachment file. Each file upload response will provide an object_key to be used in the \"Send message\" request body.
\n","urlObject":{"protocol":"https","path":["api","messaging","v1","messages"],"host":["secure","redeapp","com"],"query":[],"variable":[]}},"response":[{"id":"b159dd40-a583-4d4e-abfc-31c54cac0e7f","name":"01 - Upload attachment","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"multipart/form-data","type":"text"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerWhen a variable_list_id is used, the message contents will be dynamically rendered with the values plugged in from the latest list file, according to each recipient and their corresponding row in the list file.
\n","urlObject":{"protocol":"https","path":["api","messaging","v1","messages"],"host":["secure","redeapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"dbaeff10-8252-4ccc-94e2-88ab84571b46"},{"name":"Create template message","id":"8bfe6e54-3755-4e51-b115-790b87f06423","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerYou got it!
Thanks for the heads up!
Hola margaret!
Hey is anyone available to cover a shift this weekend?
Thanks for the heads up!
All-
\\nBe advised the snow storm has caused dangerous conditions and delays on I-65. We will be running a limited shift in response, please dont worry if you are running late due to this inclement weather.
\\nSTAY SAFE!!
This will remove the message from the corresponding conversation. The message will still remain in other conversations (that may belong to other accounts or the network).
\n","urlObject":{"protocol":"http","path":["api","messaging","v1","notifications","{id}"],"host":["secure","redeapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ad40ee63-d30d-4593-957b-526ec9965930"},{"name":"Message read receipts","id":"13264ecf-fca1-4683-b725-548951d7d5bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"BearerRetracting a message will \"mask\" its contents. This may be used in case of inappropriate content. The sender will still have access to the original contents, but the recipients will only be able to access the masked contents.
\n","urlObject":{"protocol":"http","path":["api","messaging","v1","messages","{id}","retract"],"host":["secure","redeapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ec54b587-606f-4323-bfd5-c63341d46ea7"}],"id":"5985357b-743d-48ca-a78e-08133290468a","description":"Red e App messaging is different than many messaging apps in that a message can belong to one or many conversations.
\nA conversation object has only one owner. A message is delivered to both the sender and recipients' conversations via a notification object. If a notification is deleted, the associated message is removed from only the owner's conversation.
\n","_postman_id":"5985357b-743d-48ca-a78e-08133290468a"},{"name":"Networks","item":[{"name":"List network admins","id":"fefd0885-f9fc-4b46-b236-5c6629052d05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"BearerProvide the requesting user the list of networks for which they are an admin.
\n","urlObject":{"protocol":"https","path":["api","networks","v1","networkadmins","networks"],"host":["secure","redeapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"41f2f8c6-1c60-4c90-882c-1667343723b6"},{"name":"List networks for account","id":"8fbb5afe-9b14-44ed-9fbc-a3e801be3180","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"BearerProvide the requesting user the list of networks for which they are a member.
\n","urlObject":{"protocol":"https","path":["api","networks","v1","accounts","{id}","networks"],"host":["secure","redeapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8fbb5afe-9b14-44ed-9fbc-a3e801be3180"}],"id":"9798fead-9219-46de-a0da-3a49a2ae2c04","_postman_id":"9798fead-9219-46de-a0da-3a49a2ae2c04","description":""},{"name":"Push","item":[{"name":"Badge","id":"146837e8-c786-4c76-a5b7-3036e43fb102","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerLists the shift configurations within the supplied network for which the requesting user is a member.
\n","urlObject":{"protocol":"https","path":["api","shifts","v1","networks","{id}","configurations"],"host":["secure","redeapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"49d75172-68bb-4013-bb94-8b9ab38ec926"},{"name":"List shift approvers","id":"95f2d662-78c4-4a8f-863f-e2ead21a23e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"BearerCreates a shift with a start and end date/time. The user who creates the shift is automatically set as the holder of that shift.
\n","urlObject":{"protocol":"https","path":["api","shifts","v1","shifts"],"host":["secure","redeapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9c544bf5-a6cb-4ada-88ae-0f476fb6602f"},{"name":"List shift announcements","id":"87423768-2495-4ab9-bf59-7e53049f54b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"BearerLists all shift announcements within the supplied network for configurations in which the requesting user is a member. Can filter the results with query parameters is_approved=true for recently-approved shift announcements, and has_pending_request=true for announcements that are awaiting approval.
Creates an announcement for an existing shift (must first create a shift) for the supplied shift configuration. Other members of that shift configuration can then request or pick up the shift, depending on the configuration settings.
\n","urlObject":{"protocol":"https","path":["api","shifts","v1","announcements"],"host":["secure","redeapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4b977252-41a6-404a-a6ad-7c8dbf1d2e65"},{"name":"List shift requests","id":"9b2ec646-17b6-4fca-908b-ed07ac3de048","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"BearerLists all requests for a given shift announcement, including requests that were previously denied. Only one request can be pending at any given time.
\n","urlObject":{"protocol":"https","path":["api","shifts","v1","requests"],"host":["secure","redeapp","com"],"query":[{"key":"announcement_id","value":""}],"variable":[]}},"response":[],"_postman_id":"9b2ec646-17b6-4fca-908b-ed07ac3de048"},{"name":"Create shift request","id":"4ec7e7f2-a25a-4e05-99c9-84ff58f8a2ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"BearerCreates a pick-up request for a supplied shift announcement. If the shift configuration is auto-approve, then the shift will immediately change holders. If the shift configuration requires approval, a message will be sent to the shift approver(s) with the request.
\n","urlObject":{"protocol":"https","path":["api","shifts","v1","requests"],"host":["secure","redeapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4ec7e7f2-a25a-4e05-99c9-84ff58f8a2ea"},{"name":"Approve/deny shift request","id":"458211fc-87ce-425d-a46f-2aaa8b8a6665","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"BearerApproves or denies a shift request. Only used in configurations that require approval.
\n","urlObject":{"protocol":"https","path":["api","shifts","v1","requests","{id}"],"host":["secure","redeapp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"458211fc-87ce-425d-a46f-2aaa8b8a6665"},{"name":"Shift profile","id":"ff7c69ae-8a3b-49c5-b7f8-3b5ad17b22c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"BearerA subscription represents an employee's membership in their employer's company network. An employee must authenticate their pending subscription by either entering their personal employee key, or by a \"magic\" link that their network admin sends them (see onboard invitations).
\n","_postman_id":"48cec691-a187-42ff-a064-6662308c8ba9"}]}