{ "uuid": "072fbb33-8761-4d28-a1ee-9f500071a3bd", "lastMigration": 29, "name": "Orbit API", "endpointPrefix": "api/v1", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "77259d4a-9f92-4f7e-93b4-66de1eeccac6", "documentation": "Get info about the current user", "method": "get", "endpoint": "user", "responses": [ { "uuid": "e129ba27-8293-40ed-8d2a-2c1d3ceb3cc8", "body": "", "latency": 0, "statusCode": 200, "label": "success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0e5f2e33-8935-4798-ae7f-fe00196888a0", "documentation": "Get all workspaces for the current user", "method": "get", "endpoint": "workspaces", "responses": [ { "uuid": "f5d5fc28-ad13-4def-933f-99368b1ec48f", "body": "", "latency": 0, "statusCode": 200, "label": "success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c0098487-bf9c-434a-a01b-05fd6413d07a", "documentation": "Get a workspace", "method": "get", "endpoint": "workspaces/:workspace_id", "responses": [ { "uuid": "5fa60fe9-38cc-4ccb-8e1d-eac4f8e79fc7", "body": "", "latency": 0, "statusCode": 200, "label": "success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "dc919d86-5fe6-4c00-964d-1975299bf995", "documentation": "List activities for a workspace", "method": "get", "endpoint": ":workspace_id/activities", "responses": [ { "uuid": "1a0dd17b-435d-4bac-8955-8fd7de5fa8a5", "body": "", "latency": 0, "statusCode": 200, "label": "success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "99147037-4d1e-425b-bbde-ea0cfd21a893", "documentation": "Create a Custom or a Content activity for a new or existing member", "method": "post", "endpoint": ":workspace_id/activities", "responses": [ { "uuid": "dd7aeddb-1e89-4996-877f-fa264cd424c5", "body": "", "latency": 0, "statusCode": 201, "label": "success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "18053b77-0528-4c78-a5fe-cb84996e1d33", "body": "", "latency": 0, "statusCode": 422, "label": "unprocessible", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c204a96c-42b6-46e9-8409-301f0fd8ec73", "documentation": "Get an activity in the workspace", "method": "get", "endpoint": ":workspace_id/activities/:id", "responses": [ { "uuid": "491b9759-f8bb-49ed-b93d-70fdf9a33504", "body": "", "latency": 0, "statusCode": 200, "label": "success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9a5edd8a-2301-48d2-8864-e7044d64b029", "documentation": "List all activity types for a workspace", "method": "get", "endpoint": ":workspace_id/activity_types", "responses": [ { "uuid": "005ce3c2-9418-46e3-bf78-cdc496ef06dc", "body": "", "latency": 0, "statusCode": 200, "label": "success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0530e65d-644d-475e-b7d6-8e442e68b387", "documentation": "List members in a workspace", "method": "get", "endpoint": ":workspace_id/members", "responses": [ { "uuid": "442c908a-93e2-441b-b0dd-704de0e9d67b", "body": "", "latency": 0, "statusCode": 200, "label": "success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8cde98d7-6917-4ec8-bba9-2acd3cf8fcdd", "documentation": "Create or update a member", "method": "post", "endpoint": ":workspace_id/members", "responses": [ { "uuid": "9c903554-d3f0-401a-84e6-cd4faff633c2", "body": "", "latency": 0, "statusCode": 200, "label": "success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4e2d0b29-a72a-4001-a77e-2bdd3605e598", "body": "", "latency": 0, "statusCode": 201, "label": "created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ed1a40db-24f5-4492-ad7e-8f80169ce4f7", "body": "", "latency": 0, "statusCode": 422, "label": "unprocessable", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4b6cfdfb-8a38-4345-b767-696390908735", "documentation": "Find a member by an identity", "method": "get", "endpoint": ":workspace_id/members/find", "responses": [ { "uuid": "9a3c52f0-dd27-42f7-833a-3fb88f07726b", "body": "", "latency": 0, "statusCode": 200, "label": "success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "95098407-fa9b-4aef-b772-2a0e87a87f63", "body": "", "latency": 0, "statusCode": 404, "label": "Not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b01d206a-1e89-4cf5-bef0-8e0b57b57aaf", "documentation": "Delete a member", "method": "delete", "endpoint": ":workspace_id/members/:id", "responses": [ { "uuid": "dae8aad8-e7b0-49ec-85da-4a8b9338961a", "body": "", "latency": 0, "statusCode": 204, "label": "member deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "18662b16-b1af-407f-a817-84d374cc821c", "documentation": "Get a member", "method": "get", "endpoint": ":workspace_id/members/:id", "responses": [ { "uuid": "690c176d-0f6c-48e5-975f-ee092e7e2a96", "body": "", "latency": 0, "statusCode": 200, "label": "success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2226023c-fe73-45b5-8a1b-86377b975148", "documentation": "Update a member", "method": "put", "endpoint": ":workspace_id/members/:id", "responses": [ { "uuid": "409c16f0-5344-47ee-9822-e2da32ace873", "body": "", "latency": 0, "statusCode": 204, "label": "member updated", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "39309588-2e10-4c2f-b66b-d616c589fa31", "documentation": "List activities for a member", "method": "get", "endpoint": ":workspace_id/members/:member_id/activities", "responses": [ { "uuid": "f19f27bf-5fe9-4202-b0f3-a0ffec2a437b", "body": "", "latency": 0, "statusCode": 200, "label": "success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2c309393-c0eb-414d-9f94-f2cd2aaa1b54", "documentation": "Create a Custom or a Content activity for a member", "method": "post", "endpoint": ":workspace_id/members/:member_id/activities", "responses": [ { "uuid": "36a00985-bc9c-40b8-a269-2ec0cbaa92aa", "body": "", "latency": 0, "statusCode": 201, "label": "success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "fcdcf1c0-b807-4df8-8617-3666321ff92e", "body": "", "latency": 0, "statusCode": 422, "label": "unprocessable entity", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "4318e84f-519c-4fd3-bfe1-4d628f5ea3ee", "documentation": "Delete a post activity", "method": "delete", "endpoint": ":workspace_id/members/:member_id/activities/:id", "responses": [ { "uuid": "140b533d-ac17-4766-8f17-9205a46f41f3", "body": "", "latency": 0, "statusCode": 204, "label": "activity deleted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d0e96c29-fc50-45c9-b1bb-f9fe02a6c6f3", "documentation": "Update a custom activity for a member", "method": "put", "endpoint": ":workspace_id/members/:member_id/activities/:id", "responses": [ { "uuid": "fc85a31e-9814-43cc-a6a9-c9c5ef8a5cd6", "body": "", "latency": 0, "statusCode": 204, "label": "activity updated", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b7df3d6f-e27e-4870-afb6-d3685451ba6b", "body": "", "latency": 0, "statusCode": 422, "label": "unprocessable entity", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2bc34038-8fd1-4f65-b607-fea91f883340", "documentation": "Remove identity from a member", "method": "delete", "endpoint": ":workspace_id/members/:member_id/identities", "responses": [ { "uuid": "0c16236c-8db7-4258-8212-7dd8895ccae4", "body": "", "latency": 0, "statusCode": 204, "label": "success; no content", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "6f39553a-0f98-45ed-91dc-d6b4c08b5425", "body": "", "latency": 0, "statusCode": 422, "label": "identity is invalid or not attached to member", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "38f8e322-b99f-4ddc-8297-d53c8d954792", "documentation": "Add identity to a member", "method": "post", "endpoint": ":workspace_id/members/:member_id/identities", "responses": [ { "uuid": "96f4b7ed-74e4-44b8-8a67-6ca84b8d4c19", "body": "", "latency": 0, "statusCode": 201, "label": "success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a9591e3d-fc8b-4551-afbd-a5e105274abb", "body": "", "latency": 0, "statusCode": 422, "label": "identity is invalid", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c9521e3d-a7da-4845-bd17-4f7813d9670c", "documentation": "Get the member's notes", "method": "get", "endpoint": ":workspace_id/members/:member_id/notes", "responses": [ { "uuid": "c792be8a-ff26-4994-8954-f2e3f745d67a", "body": "", "latency": 0, "statusCode": 200, "label": "success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a35db4c6-bd91-423f-a9de-7451c35c4bff", "documentation": "Create a note", "method": "post", "endpoint": ":workspace_id/members/:member_id/notes", "responses": [ { "uuid": "14dd1e71-c6d5-45fc-b5d3-7ee0c3173211", "body": "", "latency": 0, "statusCode": 201, "label": "note created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "833d4086-cb8e-4ee3-a672-0d755b5aa79b", "documentation": "Update a note", "method": "put", "endpoint": ":workspace_id/members/:member_id/notes/:id", "responses": [ { "uuid": "abf9fcea-4383-460f-90c7-1c938a839d71", "body": "", "latency": 0, "statusCode": 204, "label": "note updated", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6bcc5d1a-9749-4bce-8afa-dc6072882f4f", "documentation": "Get a workspace stats", "method": "get", "endpoint": ":workspace_id/reports", "responses": [ { "uuid": "4e029b46-956b-4c7b-9d4e-716dbec95129", "body": "", "latency": 0, "statusCode": 200, "label": "success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "77259d4a-9f92-4f7e-93b4-66de1eeccac6" }, { "type": "route", "uuid": "0e5f2e33-8935-4798-ae7f-fe00196888a0" }, { "type": "route", "uuid": "c0098487-bf9c-434a-a01b-05fd6413d07a" }, { "type": "route", "uuid": "dc919d86-5fe6-4c00-964d-1975299bf995" }, { "type": "route", "uuid": "99147037-4d1e-425b-bbde-ea0cfd21a893" }, { "type": "route", "uuid": "c204a96c-42b6-46e9-8409-301f0fd8ec73" }, { "type": "route", "uuid": "9a5edd8a-2301-48d2-8864-e7044d64b029" }, { "type": "route", "uuid": "0530e65d-644d-475e-b7d6-8e442e68b387" }, { "type": "route", "uuid": "8cde98d7-6917-4ec8-bba9-2acd3cf8fcdd" }, { "type": "route", "uuid": "4b6cfdfb-8a38-4345-b767-696390908735" }, { "type": "route", "uuid": "b01d206a-1e89-4cf5-bef0-8e0b57b57aaf" }, { "type": "route", "uuid": "18662b16-b1af-407f-a817-84d374cc821c" }, { "type": "route", "uuid": "2226023c-fe73-45b5-8a1b-86377b975148" }, { "type": "route", "uuid": "39309588-2e10-4c2f-b66b-d616c589fa31" }, { "type": "route", "uuid": "2c309393-c0eb-414d-9f94-f2cd2aaa1b54" }, { "type": "route", "uuid": "4318e84f-519c-4fd3-bfe1-4d628f5ea3ee" }, { "type": "route", "uuid": "d0e96c29-fc50-45c9-b1bb-f9fe02a6c6f3" }, { "type": "route", "uuid": "2bc34038-8fd1-4f65-b607-fea91f883340" }, { "type": "route", "uuid": "38f8e322-b99f-4ddc-8297-d53c8d954792" }, { "type": "route", "uuid": "c9521e3d-a7da-4845-bd17-4f7813d9670c" }, { "type": "route", "uuid": "a35db4c6-bd91-423f-a9de-7451c35c4bff" }, { "type": "route", "uuid": "833d4086-cb8e-4ee3-a672-0d755b5aa79b" }, { "type": "route", "uuid": "6bcc5d1a-9749-4bce-8afa-dc6072882f4f" } ] }