{ "openapi": "3.0.0", "info": { "title": "Onboard API - Complete Specification", "description": "OpenAPI 3.0 specification with some apps and/or paths excluded per the openapi-ignore file.", "version": "1.0.0" }, "servers": [ { "url": "https://dev-rest.onboard.io", "description": "Production server" } ], "paths": { "/companies": { "get": { "summary": "GET /companies", "description": "GET operation for /companies", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeCompanyDetailSerializer" }, "example": { "id": 1, "name": "string", "website": "string", "uuid": "string", "avatar": "string", "logos": "string", "icon": "binary-file-placeholder", "icon_delete": true, "icon_base64": {}, "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "created_by": "string", "external_id": "string", "sf_account_id": "string", "hubspot_company_id": 1, "custom": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } }, "post": { "summary": "POST /companies", "description": "POST operation for /companies", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeCompanyDetailSerializer" }, "example": { "id": 1, "name": "string", "website": "string", "uuid": "string", "avatar": "string", "logos": "string", "icon": "binary-file-placeholder", "icon_delete": true, "icon_base64": {}, "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "created_by": "string", "external_id": "string", "sf_account_id": "string", "hubspot_company_id": 1, "custom": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeCompanyDetailSerializer" }, "example": { "name": "string", "website": "string", "uuid": "string", "icon": "binary-file-placeholder", "icon_delete": true, "icon_base64": {}, "external_id": "string", "sf_account_id": "string", "hubspot_company_id": 1, "custom": "string" } } } } } }, "/companies/{id}": { "get": { "summary": "GET /companies/{id}", "description": "GET operation for /companies/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeCompanyDetailSerializer" }, "example": { "id": 1, "name": "string", "website": "string", "uuid": "string", "avatar": "string", "logos": "string", "icon": "binary-file-placeholder", "icon_delete": true, "icon_base64": {}, "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "created_by": "string", "external_id": "string", "sf_account_id": "string", "hubspot_company_id": 1, "custom": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /companies/{id}", "description": "PUT operation for /companies/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeCompanyDetailSerializer" }, "example": { "id": 1, "name": "string", "website": "string", "uuid": "string", "avatar": "string", "logos": "string", "icon": "binary-file-placeholder", "icon_delete": true, "icon_base64": {}, "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "created_by": "string", "external_id": "string", "sf_account_id": "string", "hubspot_company_id": 1, "custom": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeCompanyDetailSerializer" }, "example": { "name": "string", "website": "string", "uuid": "string", "icon": "binary-file-placeholder", "icon_delete": true, "icon_base64": {}, "external_id": "string", "sf_account_id": "string", "hubspot_company_id": 1, "custom": "string" } } } } }, "delete": { "summary": "DELETE /companies/{id}", "description": "DELETE operation for /companies/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeCompanyDetailSerializer" }, "example": { "id": 1, "name": "string", "website": "string", "uuid": "string", "avatar": "string", "logos": "string", "icon": "binary-file-placeholder", "icon_delete": true, "icon_base64": {}, "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "created_by": "string", "external_id": "string", "sf_account_id": "string", "hubspot_company_id": 1, "custom": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /companies/{id}", "description": "PATCH operation for /companies/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeCompanyDetailSerializer" }, "example": { "id": 1, "name": "string", "website": "string", "uuid": "string", "avatar": "string", "logos": "string", "icon": "binary-file-placeholder", "icon_delete": true, "icon_base64": {}, "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "created_by": "string", "external_id": "string", "sf_account_id": "string", "hubspot_company_id": 1, "custom": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeCompanyDetailSerializer" }, "example": { "name": "string", "website": "string", "uuid": "string", "icon": "binary-file-placeholder", "icon_delete": true, "icon_base64": {}, "external_id": "string", "sf_account_id": "string", "hubspot_company_id": 1, "custom": "string" } } } } } }, "/companies/{id}/members": { "get": { "summary": "GET /companies/{id}/members", "description": "GET operation for /companies/{id}/members", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeUserBasicSerializer" }, "example": { "id": 1, "first_name": "string", "last_name": "string", "name": "string", "email": "string", "avatar": "string", "external_id": "string", "last_login": "string", "created_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /companies/{id}/members", "description": "POST operation for /companies/{id}/members", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeUserBasicSerializer" }, "example": { "id": 1, "first_name": "string", "last_name": "string", "name": "string", "email": "string", "avatar": "string", "external_id": "string", "last_login": "string", "created_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeUserBasicSerializer" }, "example": { "external_id": "string" } } } } } }, "/companies/{id}/members/{id}": { "get": { "summary": "GET /companies/{id}/members/{id}", "description": "GET operation for /companies/{id}/members/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeUserSerializer" }, "example": { "id": 1, "first_name": "string", "last_name": "string", "email": "user@example.com", "avatar": "string", "name": "string", "profile": "string", "created_at": "2021-01-01T00:00:00Z", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "external_id": "string", "role": "string", "last_login": "string", "onboardee_company": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /companies/{id}/members/{id}", "description": "PUT operation for /companies/{id}/members/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeUserSerializer" }, "example": { "id": 1, "first_name": "string", "last_name": "string", "email": "user@example.com", "avatar": "string", "name": "string", "profile": "string", "created_at": "2021-01-01T00:00:00Z", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "external_id": "string", "role": "string", "last_login": "string", "onboardee_company": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeUserSerializer" }, "example": { "first_name": "string", "last_name": "string", "email": "user@example.com", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "external_id": "string", "role": "string" } } } } }, "delete": { "summary": "DELETE /companies/{id}/members/{id}", "description": "DELETE operation for /companies/{id}/members/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeUserSerializer" }, "example": { "id": 1, "first_name": "string", "last_name": "string", "email": "user@example.com", "avatar": "string", "name": "string", "profile": "string", "created_at": "2021-01-01T00:00:00Z", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "external_id": "string", "role": "string", "last_login": "string", "onboardee_company": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /companies/{id}/members/{id}", "description": "PATCH operation for /companies/{id}/members/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeUserSerializer" }, "example": { "id": 1, "first_name": "string", "last_name": "string", "email": "user@example.com", "avatar": "string", "name": "string", "profile": "string", "created_at": "2021-01-01T00:00:00Z", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "external_id": "string", "role": "string", "last_login": "string", "onboardee_company": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeUserSerializer" }, "example": { "first_name": "string", "last_name": "string", "email": "user@example.com", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "external_id": "string", "role": "string" } } } } } }, "/companies/members": { "get": { "summary": "GET /companies/members", "description": "GET operation for /companies/members", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeUserByEmailSerializer" }, "example": { "id": 1, "first_name": "string", "last_name": "string", "email": "string", "avatar": "string", "name": "string", "created_at": "2021-01-01T00:00:00Z", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "external_id": "string", "role": "string", "last_login": "string", "onboardee_company": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/customers": { "get": { "summary": "GET /customers", "description": "GET operation for /customers", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeCompanyDetailSerializer" }, "example": { "id": 1, "name": "string", "website": "string", "uuid": "string", "avatar": "string", "logos": "string", "icon": "binary-file-placeholder", "icon_delete": true, "icon_base64": {}, "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "created_by": "string", "external_id": "string", "sf_account_id": "string", "hubspot_company_id": 1, "custom": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } }, "post": { "summary": "POST /customers", "description": "POST operation for /customers", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeCompanyDetailSerializer" }, "example": { "id": 1, "name": "string", "website": "string", "uuid": "string", "avatar": "string", "logos": "string", "icon": "binary-file-placeholder", "icon_delete": true, "icon_base64": {}, "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "created_by": "string", "external_id": "string", "sf_account_id": "string", "hubspot_company_id": 1, "custom": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeCompanyDetailSerializer" }, "example": { "name": "string", "website": "string", "uuid": "string", "icon": "binary-file-placeholder", "icon_delete": true, "icon_base64": {}, "external_id": "string", "sf_account_id": "string", "hubspot_company_id": 1, "custom": "string" } } } } } }, "/customers/{id}": { "get": { "summary": "GET /customers/{id}", "description": "GET operation for /customers/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeCompanyDetailSerializer" }, "example": { "id": 1, "name": "string", "website": "string", "uuid": "string", "avatar": "string", "logos": "string", "icon": "binary-file-placeholder", "icon_delete": true, "icon_base64": {}, "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "created_by": "string", "external_id": "string", "sf_account_id": "string", "hubspot_company_id": 1, "custom": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /customers/{id}", "description": "PUT operation for /customers/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeCompanyDetailSerializer" }, "example": { "id": 1, "name": "string", "website": "string", "uuid": "string", "avatar": "string", "logos": "string", "icon": "binary-file-placeholder", "icon_delete": true, "icon_base64": {}, "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "created_by": "string", "external_id": "string", "sf_account_id": "string", "hubspot_company_id": 1, "custom": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeCompanyDetailSerializer" }, "example": { "name": "string", "website": "string", "uuid": "string", "icon": "binary-file-placeholder", "icon_delete": true, "icon_base64": {}, "external_id": "string", "sf_account_id": "string", "hubspot_company_id": 1, "custom": "string" } } } } }, "delete": { "summary": "DELETE /customers/{id}", "description": "DELETE operation for /customers/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeCompanyDetailSerializer" }, "example": { "id": 1, "name": "string", "website": "string", "uuid": "string", "avatar": "string", "logos": "string", "icon": "binary-file-placeholder", "icon_delete": true, "icon_base64": {}, "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "created_by": "string", "external_id": "string", "sf_account_id": "string", "hubspot_company_id": 1, "custom": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /customers/{id}", "description": "PATCH operation for /customers/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeCompanyDetailSerializer" }, "example": { "id": 1, "name": "string", "website": "string", "uuid": "string", "avatar": "string", "logos": "string", "icon": "binary-file-placeholder", "icon_delete": true, "icon_base64": {}, "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "created_by": "string", "external_id": "string", "sf_account_id": "string", "hubspot_company_id": 1, "custom": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeCompanyDetailSerializer" }, "example": { "name": "string", "website": "string", "uuid": "string", "icon": "binary-file-placeholder", "icon_delete": true, "icon_base64": {}, "external_id": "string", "sf_account_id": "string", "hubspot_company_id": 1, "custom": "string" } } } } } }, "/customers/{id}/members": { "get": { "summary": "GET /customers/{id}/members", "description": "GET operation for /customers/{id}/members", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeUserBasicSerializer" }, "example": { "id": 1, "first_name": "string", "last_name": "string", "name": "string", "email": "string", "avatar": "string", "external_id": "string", "last_login": "string", "created_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /customers/{id}/members", "description": "POST operation for /customers/{id}/members", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeUserBasicSerializer" }, "example": { "id": 1, "first_name": "string", "last_name": "string", "name": "string", "email": "string", "avatar": "string", "external_id": "string", "last_login": "string", "created_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeUserBasicSerializer" }, "example": { "external_id": "string" } } } } } }, "/customers/{id}/members/{id}": { "get": { "summary": "GET /customers/{id}/members/{id}", "description": "GET operation for /customers/{id}/members/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeUserSerializer" }, "example": { "id": 1, "first_name": "string", "last_name": "string", "email": "user@example.com", "avatar": "string", "name": "string", "profile": "string", "created_at": "2021-01-01T00:00:00Z", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "external_id": "string", "role": "string", "last_login": "string", "onboardee_company": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /customers/{id}/members/{id}", "description": "PUT operation for /customers/{id}/members/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeUserSerializer" }, "example": { "id": 1, "first_name": "string", "last_name": "string", "email": "user@example.com", "avatar": "string", "name": "string", "profile": "string", "created_at": "2021-01-01T00:00:00Z", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "external_id": "string", "role": "string", "last_login": "string", "onboardee_company": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeUserSerializer" }, "example": { "first_name": "string", "last_name": "string", "email": "user@example.com", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "external_id": "string", "role": "string" } } } } }, "delete": { "summary": "DELETE /customers/{id}/members/{id}", "description": "DELETE operation for /customers/{id}/members/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeUserSerializer" }, "example": { "id": 1, "first_name": "string", "last_name": "string", "email": "user@example.com", "avatar": "string", "name": "string", "profile": "string", "created_at": "2021-01-01T00:00:00Z", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "external_id": "string", "role": "string", "last_login": "string", "onboardee_company": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /customers/{id}/members/{id}", "description": "PATCH operation for /customers/{id}/members/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeUserSerializer" }, "example": { "id": 1, "first_name": "string", "last_name": "string", "email": "user@example.com", "avatar": "string", "name": "string", "profile": "string", "created_at": "2021-01-01T00:00:00Z", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "external_id": "string", "role": "string", "last_login": "string", "onboardee_company": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeUserSerializer" }, "example": { "first_name": "string", "last_name": "string", "email": "user@example.com", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "external_id": "string", "role": "string" } } } } } }, "/company-members/{id}": { "get": { "summary": "GET /company-members/{id}", "description": "GET operation for /company-members/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeUserSerializer" }, "example": { "id": 1, "first_name": "string", "last_name": "string", "email": "user@example.com", "avatar": "string", "name": "string", "profile": "string", "created_at": "2021-01-01T00:00:00Z", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "external_id": "string", "role": "string", "last_login": "string", "onboardee_company": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /company-members/{id}", "description": "PUT operation for /company-members/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeUserSerializer" }, "example": { "id": 1, "first_name": "string", "last_name": "string", "email": "user@example.com", "avatar": "string", "name": "string", "profile": "string", "created_at": "2021-01-01T00:00:00Z", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "external_id": "string", "role": "string", "last_login": "string", "onboardee_company": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeUserSerializer" }, "example": { "first_name": "string", "last_name": "string", "email": "user@example.com", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "external_id": "string", "role": "string" } } } } }, "delete": { "summary": "DELETE /company-members/{id}", "description": "DELETE operation for /company-members/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeUserSerializer" }, "example": { "id": 1, "first_name": "string", "last_name": "string", "email": "user@example.com", "avatar": "string", "name": "string", "profile": "string", "created_at": "2021-01-01T00:00:00Z", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "external_id": "string", "role": "string", "last_login": "string", "onboardee_company": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /company-members/{id}", "description": "PATCH operation for /company-members/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeUserSerializer" }, "example": { "id": 1, "first_name": "string", "last_name": "string", "email": "user@example.com", "avatar": "string", "name": "string", "profile": "string", "created_at": "2021-01-01T00:00:00Z", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "external_id": "string", "role": "string", "last_login": "string", "onboardee_company": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeUserSerializer" }, "example": { "first_name": "string", "last_name": "string", "email": "user@example.com", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "external_id": "string", "role": "string" } } } } } }, "/member-requests": { "post": { "summary": "POST /member-requests", "description": "POST operation for /member-requests", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamMemberRequestsSerializer" }, "example": { "id": 1, "first_name": "string", "last_name": "string", "email": "user@example.com", "role": "string", "account_type": "admin", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "external_id": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamMemberRequestsSerializer" }, "example": { "first_name": "string", "last_name": "string", "email": "user@example.com", "role": "string", "account_type": "admin", "external_id": "string" } } } } } }, "/members": { "get": { "summary": "GET /members", "description": "GET operation for /members", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamMemberSerializer" }, "example": { "id": 1, "first_name": "string", "last_name": "string", "name": "string", "email": "user@example.com", "role": "string", "account_type": "admin", "avatar": "string", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "external_id": "string", "last_login": "string", "slack_member_id": "string", "roles": "string", "role_ids": [ "string" ], "features": {}, "fora_id": "string", "meeting_insights": true, "custom": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } }, "post": { "summary": "POST /members", "description": "POST operation for /members", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamMemberSerializer" }, "example": { "id": 1, "first_name": "string", "last_name": "string", "name": "string", "email": "user@example.com", "role": "string", "account_type": "admin", "avatar": "string", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "external_id": "string", "last_login": "string", "slack_member_id": "string", "roles": "string", "role_ids": [ "string" ], "features": {}, "fora_id": "string", "meeting_insights": true, "custom": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamMemberSerializer" }, "example": { "first_name": "string", "last_name": "string", "email": "user@example.com", "role": "string", "account_type": "admin", "external_id": "string", "slack_member_id": "string", "roles": "string", "role_ids": [ "string" ], "features": {}, "meeting_insights": true, "custom": "string" } } } } } }, "/members/{id}": { "get": { "summary": "GET /members/{id}", "description": "GET operation for /members/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamMemberSerializer" }, "example": { "id": 1, "first_name": "string", "last_name": "string", "name": "string", "email": "user@example.com", "role": "string", "account_type": "admin", "avatar": "string", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "external_id": "string", "last_login": "string", "slack_member_id": "string", "roles": "string", "role_ids": [ "string" ], "features": {}, "fora_id": "string", "meeting_insights": true, "custom": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /members/{id}", "description": "PUT operation for /members/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamMemberSerializer" }, "example": { "id": 1, "first_name": "string", "last_name": "string", "name": "string", "email": "user@example.com", "role": "string", "account_type": "admin", "avatar": "string", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "external_id": "string", "last_login": "string", "slack_member_id": "string", "roles": "string", "role_ids": [ "string" ], "features": {}, "fora_id": "string", "meeting_insights": true, "custom": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamMemberSerializer" }, "example": { "first_name": "string", "last_name": "string", "email": "user@example.com", "role": "string", "account_type": "admin", "external_id": "string", "slack_member_id": "string", "roles": "string", "role_ids": [ "string" ], "features": {}, "meeting_insights": true, "custom": "string" } } } } }, "delete": { "summary": "DELETE /members/{id}", "description": "DELETE operation for /members/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamMemberSerializer" }, "example": { "id": 1, "first_name": "string", "last_name": "string", "name": "string", "email": "user@example.com", "role": "string", "account_type": "admin", "avatar": "string", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "external_id": "string", "last_login": "string", "slack_member_id": "string", "roles": "string", "role_ids": [ "string" ], "features": {}, "fora_id": "string", "meeting_insights": true, "custom": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /members/{id}", "description": "PATCH operation for /members/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamMemberSerializer" }, "example": { "id": 1, "first_name": "string", "last_name": "string", "name": "string", "email": "user@example.com", "role": "string", "account_type": "admin", "avatar": "string", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "external_id": "string", "last_login": "string", "slack_member_id": "string", "roles": "string", "role_ids": [ "string" ], "features": {}, "fora_id": "string", "meeting_insights": true, "custom": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamMemberSerializer" }, "example": { "first_name": "string", "last_name": "string", "email": "user@example.com", "role": "string", "account_type": "admin", "external_id": "string", "slack_member_id": "string", "roles": "string", "role_ids": [ "string" ], "features": {}, "meeting_insights": true, "custom": "string" } } } } } }, "/members/{id}/invite": { "post": { "summary": "POST /members/{id}/invite", "description": "POST operation for /members/{id}/invite", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/api-accounts": { "get": { "summary": "GET /api-accounts", "description": "GET operation for /api-accounts", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIMemberSerializer" }, "example": { "id": 1, "first_name": "string", "name": "string", "account_type": "admin", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "token": "string", "regenerate_token": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } }, "post": { "summary": "POST /api-accounts", "description": "POST operation for /api-accounts", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIMemberSerializer" }, "example": { "id": 1, "first_name": "string", "name": "string", "account_type": "admin", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "token": "string", "regenerate_token": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIMemberSerializer" }, "example": { "first_name": "string", "regenerate_token": true } } } } } }, "/api-accounts/{id}": { "get": { "summary": "GET /api-accounts/{id}", "description": "GET operation for /api-accounts/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIMemberSerializer" }, "example": { "id": 1, "first_name": "string", "name": "string", "account_type": "admin", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "token": "string", "regenerate_token": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /api-accounts/{id}", "description": "PUT operation for /api-accounts/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIMemberSerializer" }, "example": { "id": 1, "first_name": "string", "name": "string", "account_type": "admin", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "token": "string", "regenerate_token": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIMemberSerializer" }, "example": { "first_name": "string", "regenerate_token": true } } } } }, "delete": { "summary": "DELETE /api-accounts/{id}", "description": "DELETE operation for /api-accounts/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIMemberSerializer" }, "example": { "id": 1, "first_name": "string", "name": "string", "account_type": "admin", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "token": "string", "regenerate_token": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /api-accounts/{id}", "description": "PATCH operation for /api-accounts/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIMemberSerializer" }, "example": { "id": 1, "first_name": "string", "name": "string", "account_type": "admin", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "invited_at": "2021-01-01T00:00:00Z", "status": "active", "token": "string", "regenerate_token": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIMemberSerializer" }, "example": { "first_name": "string", "regenerate_token": true } } } } } }, "/account": { "get": { "summary": "GET /account", "description": "GET operation for /account", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboarderCompanyAccountSerializer" }, "example": { "id": 1, "company_name": "string", "slug": "string", "domain": "string", "uuid": "string", "is_active": true, "settings": "string", "outboard_logo_img": "binary-file-placeholder", "outboard_logo": "string", "icon": "binary-file-placeholder", "avatar_img": "binary-file-placeholder", "avatar": "string", "logos": "string", "outboard_logo_delete": true, "avatar_delete": true, "is_ai_enabled": true, "auto_update_enabled": true, "stalled_status_threshold": 1, "chatbot_enabled": true, "default_api_key": "string", "created_at": "2021-01-01T00:00:00Z", "first_roadmap_created_at": "string", "address": "string", "has_variables": "string", "has_tasks": "string", "has_project_templates": "string", "has_custom_sending_domain": "string", "has_slack": "string", "payment_subscription_id": "string", "payment_customer_id": "string", "trial_end_date": "2021-01-01", "is_trialing": "string", "terms_acceptance": "string", "outboard_settings": "string", "internal": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } }, "put": { "summary": "PUT /account", "description": "PUT operation for /account", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboarderCompanyAccountSerializer" }, "example": { "id": 1, "company_name": "string", "slug": "string", "domain": "string", "uuid": "string", "is_active": true, "settings": "string", "outboard_logo_img": "binary-file-placeholder", "outboard_logo": "string", "icon": "binary-file-placeholder", "avatar_img": "binary-file-placeholder", "avatar": "string", "logos": "string", "outboard_logo_delete": true, "avatar_delete": true, "is_ai_enabled": true, "auto_update_enabled": true, "stalled_status_threshold": 1, "chatbot_enabled": true, "default_api_key": "string", "created_at": "2021-01-01T00:00:00Z", "first_roadmap_created_at": "string", "address": "string", "has_variables": "string", "has_tasks": "string", "has_project_templates": "string", "has_custom_sending_domain": "string", "has_slack": "string", "payment_subscription_id": "string", "payment_customer_id": "string", "trial_end_date": "2021-01-01", "is_trialing": "string", "terms_acceptance": "string", "outboard_settings": "string", "internal": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboarderCompanyAccountSerializer" }, "example": { "company_name": "string", "slug": "string", "domain": "string", "is_active": true, "settings": "string", "outboard_logo_img": "binary-file-placeholder", "icon": "binary-file-placeholder", "avatar_img": "binary-file-placeholder", "outboard_logo_delete": true, "avatar_delete": true, "is_ai_enabled": true, "auto_update_enabled": true, "stalled_status_threshold": 1, "chatbot_enabled": true, "outboard_settings": "string" } } } } }, "patch": { "summary": "PATCH /account", "description": "PATCH operation for /account", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboarderCompanyAccountSerializer" }, "example": { "id": 1, "company_name": "string", "slug": "string", "domain": "string", "uuid": "string", "is_active": true, "settings": "string", "outboard_logo_img": "binary-file-placeholder", "outboard_logo": "string", "icon": "binary-file-placeholder", "avatar_img": "binary-file-placeholder", "avatar": "string", "logos": "string", "outboard_logo_delete": true, "avatar_delete": true, "is_ai_enabled": true, "auto_update_enabled": true, "stalled_status_threshold": 1, "chatbot_enabled": true, "default_api_key": "string", "created_at": "2021-01-01T00:00:00Z", "first_roadmap_created_at": "string", "address": "string", "has_variables": "string", "has_tasks": "string", "has_project_templates": "string", "has_custom_sending_domain": "string", "has_slack": "string", "payment_subscription_id": "string", "payment_customer_id": "string", "trial_end_date": "2021-01-01", "is_trialing": "string", "terms_acceptance": "string", "outboard_settings": "string", "internal": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboarderCompanyAccountSerializer" }, "example": { "company_name": "string", "slug": "string", "domain": "string", "is_active": true, "settings": "string", "outboard_logo_img": "binary-file-placeholder", "icon": "binary-file-placeholder", "avatar_img": "binary-file-placeholder", "outboard_logo_delete": true, "avatar_delete": true, "is_ai_enabled": true, "auto_update_enabled": true, "stalled_status_threshold": 1, "chatbot_enabled": true, "outboard_settings": "string" } } } } } }, "/account/address": { "get": { "summary": "GET /account/address", "description": "GET operation for /account/address", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboarderCompanyAddressSerializer" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } }, "put": { "summary": "PUT /account/address", "description": "PUT operation for /account/address", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboarderCompanyAddressSerializer" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboarderCompanyAddressSerializer" } } } } }, "patch": { "summary": "PATCH /account/address", "description": "PATCH operation for /account/address", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboarderCompanyAddressSerializer" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboarderCompanyAddressSerializer" } } } } } }, "/defaults": { "get": { "summary": "GET /defaults", "description": "GET operation for /defaults", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/onboarder-user/notifications": { "get": { "summary": "GET /onboarder-user/notifications", "description": "GET operation for /onboarder-user/notifications", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboarderUserNotificationsSerializer" }, "example": { "roadmap_status_updates": true, "task_due_date_changed": true, "task_due_date_reminders": true, "task_overdue": true, "discussion_mentions": true, "discussion_daily_digest": true, "task_summary": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } }, "put": { "summary": "PUT /onboarder-user/notifications", "description": "PUT operation for /onboarder-user/notifications", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboarderUserNotificationsSerializer" }, "example": { "roadmap_status_updates": true, "task_due_date_changed": true, "task_due_date_reminders": true, "task_overdue": true, "discussion_mentions": true, "discussion_daily_digest": true, "task_summary": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboarderUserNotificationsSerializer" }, "example": { "roadmap_status_updates": true, "task_due_date_changed": true, "task_due_date_reminders": true, "task_overdue": true, "discussion_mentions": true, "discussion_daily_digest": true, "task_summary": true } } } } }, "patch": { "summary": "PATCH /onboarder-user/notifications", "description": "PATCH operation for /onboarder-user/notifications", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboarderUserNotificationsSerializer" }, "example": { "roadmap_status_updates": true, "task_due_date_changed": true, "task_due_date_reminders": true, "task_overdue": true, "discussion_mentions": true, "discussion_daily_digest": true, "task_summary": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboarderUserNotificationsSerializer" }, "example": { "roadmap_status_updates": true, "task_due_date_changed": true, "task_due_date_reminders": true, "task_overdue": true, "discussion_mentions": true, "discussion_daily_digest": true, "task_summary": true } } } } } }, "/onboardee-user/notifications": { "get": { "summary": "GET /onboardee-user/notifications", "description": "GET operation for /onboardee-user/notifications", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeUserNotificationsSerializer" }, "example": { "task_due_date_changed": true, "task_due_date_reminders": true, "task_overdue": true, "discussion_mentions": true, "discussion_daily_digest": true, "task_summary_onboardee": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } }, "put": { "summary": "PUT /onboardee-user/notifications", "description": "PUT operation for /onboardee-user/notifications", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeUserNotificationsSerializer" }, "example": { "task_due_date_changed": true, "task_due_date_reminders": true, "task_overdue": true, "discussion_mentions": true, "discussion_daily_digest": true, "task_summary_onboardee": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeUserNotificationsSerializer" }, "example": { "task_due_date_changed": true, "task_due_date_reminders": true, "task_overdue": true, "discussion_mentions": true, "discussion_daily_digest": true, "task_summary_onboardee": true } } } } }, "patch": { "summary": "PATCH /onboardee-user/notifications", "description": "PATCH operation for /onboardee-user/notifications", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeUserNotificationsSerializer" }, "example": { "task_due_date_changed": true, "task_due_date_reminders": true, "task_overdue": true, "discussion_mentions": true, "discussion_daily_digest": true, "task_summary_onboardee": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnboardeeUserNotificationsSerializer" }, "example": { "task_due_date_changed": true, "task_due_date_reminders": true, "task_overdue": true, "discussion_mentions": true, "discussion_daily_digest": true, "task_summary_onboardee": true } } } } } }, "/sso/create": { "post": { "summary": "POST /sso/create", "description": "POST operation for /sso/create", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SSOSettingsSerializer" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SSOSettingsSerializer" } } } } } }, "/sso": { "get": { "summary": "GET /sso", "description": "GET operation for /sso", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SSOSettingsSerializer" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } }, "put": { "summary": "PUT /sso", "description": "PUT operation for /sso", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SSOSettingsSerializer" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SSOSettingsSerializer" } } } } }, "delete": { "summary": "DELETE /sso", "description": "DELETE operation for /sso", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SSOSettingsSerializer" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } }, "patch": { "summary": "PATCH /sso", "description": "PATCH operation for /sso", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SSOSettingsSerializer" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SSOSettingsSerializer" } } } } } }, "/terms-acceptance": { "get": { "summary": "GET /terms-acceptance", "description": "GET operation for /terms-acceptance", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermsAcceptanceSerializer" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } }, "post": { "summary": "POST /terms-acceptance", "description": "POST operation for /terms-acceptance", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermsAcceptanceSerializer" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermsAcceptanceSerializer" } } } } } }, "/roles": { "get": { "summary": "GET /roles", "description": "GET operation for /roles", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "created_at": "2021-01-01T00:00:00Z", "role_type": "internal", "order": 1, "created_by": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } }, "post": { "summary": "POST /roles", "description": "POST operation for /roles", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "created_at": "2021-01-01T00:00:00Z", "role_type": "internal", "order": 1, "created_by": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleSerializer" }, "example": { "name": "string", "description": "string", "role_type": "internal" } } } } } }, "/roles/{id}": { "get": { "summary": "GET /roles/{id}", "description": "GET operation for /roles/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "created_at": "2021-01-01T00:00:00Z", "role_type": "internal", "order": 1, "created_by": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /roles/{id}", "description": "PUT operation for /roles/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "created_at": "2021-01-01T00:00:00Z", "role_type": "internal", "order": 1, "created_by": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleSerializer" }, "example": { "name": "string", "description": "string", "role_type": "internal" } } } } }, "delete": { "summary": "DELETE /roles/{id}", "description": "DELETE operation for /roles/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "created_at": "2021-01-01T00:00:00Z", "role_type": "internal", "order": 1, "created_by": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /roles/{id}", "description": "PATCH operation for /roles/{id}", "tags": [ "Platform" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "created_at": "2021-01-01T00:00:00Z", "role_type": "internal", "order": 1, "created_by": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleSerializer" }, "example": { "name": "string", "description": "string", "role_type": "internal" } } } } } }, "/logz": {}, "/livez": {}, "/readyz": {}, "/openapi.json": {}, "/history/{type}": { "get": { "summary": "GET /history/{type}", "description": "GET operation for /history/{type}", "tags": [ "Activity" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "announcement", "announcement-attachment", "announcement-comment", "announcement-like", "announcement-read", "announcement-type", "calendar-embed-config", "company-webhook-event", "custom-choice", "custom-email-template", "custom-field", "custom-field-map-type", "custom-prompt-report-template", "deal-webhook-event", "default-choice", "default-email-template", "default-permissions", "form", "form-submission", "getting-started-template", "global-prompt-report-template", "integration-app", "integration-app-type", "map-type", "metric-threshold", "onboard-role", "onboardee-company", "onboardee-user", "onboardee-user-notifications", "onboarder-company", "onboarder-company-settings", "onboarder-team", "onboarder-team-members", "onboarder-user", "onboarder-user-notifications", "option", "outboard-settings", "plan", "project-asset", "project-template", "project-template-customer", "project-template-option", "project-template-task", "project-template-task-form", "roadmap", "roadmap-onboardee-user", "roadmap-onboarder-user", "roadmap-option", "roadmap-task", "roadmap-task-form", "s-s-o-settings", "slack-settings", "stream-webhook-event", "table-config", "task", "task-form", "task-option", "task-webhook-event", "terms-acceptance", "training-bot", "training-content", "training-data", "training-document", "training-f-a-q", "training-website", "training-website-page", "tray-account", "tray-custom-solution", "tray-default-solution", "tray-integration-instance", "user", "user-avatar", "user-preferences", "user-profile", "variable", "variable-map-type", "webhook-subscription", "workflow", "workflow-action", "workflow-category", "workflow-event", "workflow-recipe" ] } } ] } }, "/uploads/image/task": { "post": { "summary": "POST /uploads/image/task", "description": "POST operation for /uploads/image/task", "tags": [ "Assets" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskImageSerializer" }, "example": { "link": "binary-file-placeholder", "image": "binary-file-placeholder", "task_id": 1, "onboarder_company_id": 1 } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskImageSerializer" }, "example": { "image": "binary-file-placeholder", "task_id": 1, "onboarder_company_id": 1 } } } } } }, "/uploads/image/roadmap_task": { "post": { "summary": "POST /uploads/image/roadmap_task", "description": "POST operation for /uploads/image/roadmap_task", "tags": [ "Assets" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapTaskImageSerializer" }, "example": { "link": "binary-file-placeholder", "image": "binary-file-placeholder", "roadmap_task_id": 1, "onboarder_company_id": 1 } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapTaskImageSerializer" }, "example": { "image": "binary-file-placeholder", "roadmap_task_id": 1, "onboarder_company_id": 1 } } } } } }, "/uploads/file/task": { "post": { "summary": "POST /uploads/file/task", "description": "POST operation for /uploads/file/task", "tags": [ "Assets" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskFileSerializer" }, "example": { "link": "binary-file-placeholder", "file": "binary-file-placeholder", "task_id": 1, "onboarder_company_id": 1 } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskFileSerializer" }, "example": { "file": "binary-file-placeholder", "task_id": 1, "onboarder_company_id": 1 } } } } } }, "/uploads/file/roadmap_task": { "post": { "summary": "POST /uploads/file/roadmap_task", "description": "POST operation for /uploads/file/roadmap_task", "tags": [ "Assets" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapTaskFileSerializer" }, "example": { "link": "binary-file-placeholder", "file": "binary-file-placeholder", "roadmap_task_id": 1, "onboarder_company_id": 1 } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapTaskFileSerializer" }, "example": { "file": "binary-file-placeholder", "roadmap_task_id": 1, "onboarder_company_id": 1 } } } } } }, "/comments/auth": { "get": { "summary": "GET /comments/auth", "description": "GET operation for /comments/auth", "tags": [ "Comments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StreamTokenSerializer" }, "example": { "stream_token": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/comments/channels/check/{id}": { "get": { "summary": "GET /comments/channels/check/{id}", "description": "GET operation for /comments/channels/check/{id}", "tags": [ "Comments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/comments/channels/fallback": { "post": { "summary": "POST /comments/channels/fallback", "description": "POST operation for /comments/channels/fallback", "tags": [ "Comments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/comments/channel/{channel_id}/image": { "get": { "summary": "GET /comments/channel/{channel_id}/image", "description": "GET operation for /comments/channel/{channel_id}/image", "tags": [ "Comments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/comments/stream-webhook-event/{event_id}": { "post": { "summary": "POST /comments/stream-webhook-event/{event_id}", "description": "POST operation for /comments/stream-webhook-event/{event_id}", "tags": [ "Comments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "event_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/comments/stream-webhook-event/new": { "post": { "summary": "POST /comments/stream-webhook-event/new", "description": "POST operation for /comments/stream-webhook-event/new", "tags": [ "Comments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/comments/recent": { "get": { "summary": "GET /comments/recent", "description": "GET operation for /comments/recent", "tags": [ "Comments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/comments/inbox": { "get": { "summary": "GET /comments/inbox", "description": "GET operation for /comments/inbox", "tags": [ "Comments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentInboxMessageSerializer" }, "example": { "id": 1, "posted_at": "string", "stream_message_id": "string", "text": "string", "html": "string", "author": "string", "mentioned_users": "string", "attachments": "string", "channel_id": "string", "roadmap_id": "string", "task_id": "string", "roadmap_name": "string", "task_name": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/comments/new": { "post": { "summary": "POST /comments/new", "description": "POST operation for /comments/new", "tags": [ "Comments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/comments/attachments": { "get": { "summary": "GET /comments/attachments", "description": "GET operation for /comments/attachments", "tags": [ "Comments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/comments/search": { "get": { "summary": "GET /comments/search", "description": "GET operation for /comments/search", "tags": [ "Comments" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/custom/fields": { "get": { "summary": "GET /custom/fields", "description": "GET operation for /custom/fields", "tags": [ "Custom" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldSerializer" }, "example": { "id": 1, "label": "string", "api_name": "string", "description": "string", "object": "customer", "type": "number", "options": {}, "is_internal": true, "is_active": true, "created_at": "2021-01-01T00:00:00Z", "tables_display_enabled": true, "panels_display_enabled": true, "outboard_display_enabled": true, "map_types": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } }, "post": { "summary": "POST /custom/fields", "description": "POST operation for /custom/fields", "tags": [ "Custom" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldSerializer" }, "example": { "id": 1, "label": "string", "api_name": "string", "description": "string", "object": "customer", "type": "number", "options": {}, "is_internal": true, "is_active": true, "created_at": "2021-01-01T00:00:00Z", "tables_display_enabled": true, "panels_display_enabled": true, "outboard_display_enabled": true, "map_types": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldSerializer" }, "example": { "label": "string", "description": "string", "object": "customer", "type": "number", "options": {}, "is_internal": true, "is_active": true, "tables_display_enabled": true, "panels_display_enabled": true, "outboard_display_enabled": true, "map_types": "string" } } } } } }, "/custom/fields/{id}": { "get": { "summary": "GET /custom/fields/{id}", "description": "GET operation for /custom/fields/{id}", "tags": [ "Custom" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldSerializer" }, "example": { "id": 1, "label": "string", "api_name": "string", "description": "string", "object": "customer", "type": "number", "options": {}, "is_internal": true, "is_active": true, "created_at": "2021-01-01T00:00:00Z", "tables_display_enabled": true, "panels_display_enabled": true, "outboard_display_enabled": true, "map_types": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /custom/fields/{id}", "description": "PUT operation for /custom/fields/{id}", "tags": [ "Custom" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldSerializer" }, "example": { "id": 1, "label": "string", "api_name": "string", "description": "string", "object": "customer", "type": "number", "options": {}, "is_internal": true, "is_active": true, "created_at": "2021-01-01T00:00:00Z", "tables_display_enabled": true, "panels_display_enabled": true, "outboard_display_enabled": true, "map_types": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldSerializer" }, "example": { "label": "string", "description": "string", "object": "customer", "type": "number", "options": {}, "is_internal": true, "is_active": true, "tables_display_enabled": true, "panels_display_enabled": true, "outboard_display_enabled": true, "map_types": "string" } } } } }, "delete": { "summary": "DELETE /custom/fields/{id}", "description": "DELETE operation for /custom/fields/{id}", "tags": [ "Custom" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldSerializer" }, "example": { "id": 1, "label": "string", "api_name": "string", "description": "string", "object": "customer", "type": "number", "options": {}, "is_internal": true, "is_active": true, "created_at": "2021-01-01T00:00:00Z", "tables_display_enabled": true, "panels_display_enabled": true, "outboard_display_enabled": true, "map_types": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /custom/fields/{id}", "description": "PATCH operation for /custom/fields/{id}", "tags": [ "Custom" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldSerializer" }, "example": { "id": 1, "label": "string", "api_name": "string", "description": "string", "object": "customer", "type": "number", "options": {}, "is_internal": true, "is_active": true, "created_at": "2021-01-01T00:00:00Z", "tables_display_enabled": true, "panels_display_enabled": true, "outboard_display_enabled": true, "map_types": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldSerializer" }, "example": { "label": "string", "description": "string", "object": "customer", "type": "number", "options": {}, "is_internal": true, "is_active": true, "tables_display_enabled": true, "panels_display_enabled": true, "outboard_display_enabled": true, "map_types": "string" } } } } } }, "/custom/fields/slugify": { "post": { "summary": "POST /custom/fields/slugify", "description": "POST operation for /custom/fields/slugify", "tags": [ "Custom" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/custom/fields/merge-tags": { "get": { "summary": "GET /custom/fields/merge-tags", "description": "GET operation for /custom/fields/merge-tags", "tags": [ "Custom" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/custom/fields/attachments/{file_name}": { "get": { "summary": "GET /custom/fields/attachments/{file_name}", "description": "GET operation for /custom/fields/attachments/{file_name}", "tags": [ "Custom" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "file_name", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/email/templates/slugify": { "post": { "summary": "POST /email/templates/slugify", "description": "POST operation for /email/templates/slugify", "tags": [ "Email" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/email/templates/{template_type}/send": { "post": { "summary": "POST /email/templates/{template_type}/send", "description": "POST operation for /email/templates/{template_type}/send", "tags": [ "Email" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendEmailTemplatePreviewSerializer" }, "example": { "subject_line": "string", "from_name": "string", "from_email": "user@example.com", "html": "string", "email_address": "user@example.com" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "template_type", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendEmailTemplatePreviewSerializer" }, "example": { "subject_line": "string", "from_name": "string", "from_email": "user@example.com", "html": "string", "email_address": "user@example.com" } } } } } }, "/email/templates/{template_type}": { "get": { "summary": "GET /email/templates/{template_type}", "description": "GET operation for /email/templates/{template_type}", "tags": [ "Email" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "template_type", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /email/templates/{template_type}", "description": "PUT operation for /email/templates/{template_type}", "tags": [ "Email" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "template_type", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /email/templates/{template_type}", "description": "DELETE operation for /email/templates/{template_type}", "tags": [ "Email" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "template_type", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /email/templates/{template_type}", "description": "PATCH operation for /email/templates/{template_type}", "tags": [ "Email" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "template_type", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/email/templates/{template_type}/default": { "get": { "summary": "GET /email/templates/{template_type}/default", "description": "GET operation for /email/templates/{template_type}/default", "tags": [ "Email" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "template_type", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/email/templates/{template_type}/merge_tags": { "get": { "summary": "GET /email/templates/{template_type}/merge_tags", "description": "GET operation for /email/templates/{template_type}/merge_tags", "tags": [ "Email" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "template_type", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/email/templates/{template_type}/{custom_template_name}": { "get": { "summary": "GET /email/templates/{template_type}/{custom_template_name}", "description": "GET operation for /email/templates/{template_type}/{custom_template_name}", "tags": [ "Email" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "template_type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "custom_template_name", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /email/templates/{template_type}/{custom_template_name}", "description": "PUT operation for /email/templates/{template_type}/{custom_template_name}", "tags": [ "Email" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "template_type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "custom_template_name", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /email/templates/{template_type}/{custom_template_name}", "description": "DELETE operation for /email/templates/{template_type}/{custom_template_name}", "tags": [ "Email" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "template_type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "custom_template_name", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /email/templates/{template_type}/{custom_template_name}", "description": "PATCH operation for /email/templates/{template_type}/{custom_template_name}", "tags": [ "Email" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "template_type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "custom_template_name", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/email/templates": { "get": { "summary": "GET /email/templates", "description": "GET operation for /email/templates", "tags": [ "Email" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomEmailTemplateSerializer" }, "example": { "id": 1, "template_type": "invite_member", "custom_template_name": "string", "display_name": "string", "subject_line": "string", "from_name": "string", "from_email": "user@example.com", "html": "string", "design": {}, "default": true, "is_enabled": true, "is_scheduled": true, "send_time": "string", "days_to_send": {}, "last_sent": "2021-01-01T00:00:00Z", "next_scheduled": "2021-01-01T00:00:00Z", "last_modified_date": "string", "last_modified_user": "string", "merge_tags": "string", "preview_html": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } }, "post": { "summary": "POST /email/templates", "description": "POST operation for /email/templates", "tags": [ "Email" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomEmailTemplateSerializer" }, "example": { "id": 1, "template_type": "invite_member", "custom_template_name": "string", "display_name": "string", "subject_line": "string", "from_name": "string", "from_email": "user@example.com", "html": "string", "design": {}, "default": true, "is_enabled": true, "is_scheduled": true, "send_time": "string", "days_to_send": {}, "last_sent": "2021-01-01T00:00:00Z", "next_scheduled": "2021-01-01T00:00:00Z", "last_modified_date": "string", "last_modified_user": "string", "merge_tags": "string", "preview_html": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomEmailTemplateSerializer" }, "example": { "template_type": "invite_member", "custom_template_name": "string", "display_name": "string", "subject_line": "string", "from_name": "string", "from_email": "user@example.com", "html": "string", "design": {}, "default": true, "is_enabled": true, "is_scheduled": true, "send_time": "string", "days_to_send": {} } } } } } }, "/email/templates/{template_type}/send/preview": { "post": { "summary": "POST /email/templates/{template_type}/send/preview", "description": "POST operation for /email/templates/{template_type}/send/preview", "tags": [ "Email" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendEmailTemplatePreviewSerializer" }, "example": { "subject_line": "string", "from_name": "string", "from_email": "user@example.com", "html": "string", "email_address": "user@example.com" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "template_type", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendEmailTemplatePreviewSerializer" }, "example": { "subject_line": "string", "from_name": "string", "from_email": "user@example.com", "html": "string", "email_address": "user@example.com" } } } } } }, "/email/templates/{template_type}/send/{custom_template_name}": { "post": { "summary": "POST /email/templates/{template_type}/send/{custom_template_name}", "description": "POST operation for /email/templates/{template_type}/send/{custom_template_name}", "tags": [ "Email" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendCustomEmailSerializer" }, "example": { "custom_template_name": "string", "template_type": "string", "subject_line": "string", "to_email": "user@example.com", "metadata": {} } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "template_type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "custom_template_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendCustomEmailSerializer" }, "example": { "custom_template_name": "string", "template_type": "string", "subject_line": "string", "to_email": "user@example.com", "metadata": {} } } } } } }, "/custom/forms": { "get": { "summary": "GET /custom/forms", "description": "GET operation for /custom/forms", "tags": [ "Forms" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFormSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "api_name": "string", "object": "customer", "is_active": true, "created_at": "2021-01-01T00:00:00Z", "form_fields": "string", "onboarder_company_id": "string", "allow_resubmissions": true, "submission_required": true, "complete_task_automatically": true, "is_sample": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } }, "post": { "summary": "POST /custom/forms", "description": "POST operation for /custom/forms", "tags": [ "Forms" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFormSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "api_name": "string", "object": "customer", "is_active": true, "created_at": "2021-01-01T00:00:00Z", "form_fields": "string", "onboarder_company_id": "string", "allow_resubmissions": true, "submission_required": true, "complete_task_automatically": true, "is_sample": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFormSerializer" }, "example": { "name": "string", "description": "string", "api_name": "string", "object": "customer", "is_active": true, "form_fields": "string", "allow_resubmissions": true, "submission_required": true, "complete_task_automatically": true, "is_sample": true } } } } } }, "/custom/forms/{id}": { "get": { "summary": "GET /custom/forms/{id}", "description": "GET operation for /custom/forms/{id}", "tags": [ "Forms" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFormSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "api_name": "string", "object": "customer", "is_active": true, "created_at": "2021-01-01T00:00:00Z", "form_fields": "string", "onboarder_company_id": "string", "allow_resubmissions": true, "submission_required": true, "complete_task_automatically": true, "is_sample": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /custom/forms/{id}", "description": "PUT operation for /custom/forms/{id}", "tags": [ "Forms" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFormSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "api_name": "string", "object": "customer", "is_active": true, "created_at": "2021-01-01T00:00:00Z", "form_fields": "string", "onboarder_company_id": "string", "allow_resubmissions": true, "submission_required": true, "complete_task_automatically": true, "is_sample": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFormSerializer" }, "example": { "name": "string", "description": "string", "api_name": "string", "object": "customer", "is_active": true, "form_fields": "string", "allow_resubmissions": true, "submission_required": true, "complete_task_automatically": true, "is_sample": true } } } } }, "delete": { "summary": "DELETE /custom/forms/{id}", "description": "DELETE operation for /custom/forms/{id}", "tags": [ "Forms" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFormSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "api_name": "string", "object": "customer", "is_active": true, "created_at": "2021-01-01T00:00:00Z", "form_fields": "string", "onboarder_company_id": "string", "allow_resubmissions": true, "submission_required": true, "complete_task_automatically": true, "is_sample": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /custom/forms/{id}", "description": "PATCH operation for /custom/forms/{id}", "tags": [ "Forms" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFormSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "api_name": "string", "object": "customer", "is_active": true, "created_at": "2021-01-01T00:00:00Z", "form_fields": "string", "onboarder_company_id": "string", "allow_resubmissions": true, "submission_required": true, "complete_task_automatically": true, "is_sample": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFormSerializer" }, "example": { "name": "string", "description": "string", "api_name": "string", "object": "customer", "is_active": true, "form_fields": "string", "allow_resubmissions": true, "submission_required": true, "complete_task_automatically": true, "is_sample": true } } } } } }, "/custom/forms/{id}/submissions": { "get": { "summary": "GET /custom/forms/{id}/submissions", "description": "GET operation for /custom/forms/{id}/submissions", "tags": [ "Forms" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsListSerializer" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /custom/forms/{id}/submissions", "description": "POST operation for /custom/forms/{id}/submissions", "tags": [ "Forms" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsListSerializer" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsListSerializer" } } } } } }, "/custom/forms/{id}/submissions/options": { "get": { "summary": "GET /custom/forms/{id}/submissions/options", "description": "GET operation for /custom/forms/{id}/submissions/options", "tags": [ "Forms" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/custom/forms/submissions": { "get": { "summary": "GET /custom/forms/submissions", "description": "GET operation for /custom/forms/submissions", "tags": [ "Forms" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsListSerializer" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/hooks/events": { "get": { "summary": "GET /hooks/events", "description": "GET operation for /hooks/events", "tags": [ "Hooks" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEventSerializer" }, "example": { "id": 1, "uuid": "string", "subscription_id": "string", "target": "string", "version": "string", "success": true, "status_code": 1, "sent_at": "2021-01-01T00:00:00Z", "data": {}, "response_data": "string", "response_headers": {} } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/hooks/subscriptions": { "get": { "summary": "GET /hooks/subscriptions", "description": "GET operation for /hooks/subscriptions", "tags": [ "Hooks" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSubscriptionSerializer" }, "example": { "id": 1, "target": "https://example.com", "event_type": "map-created", "version": "string", "automatic_retry": true, "created_at": "2021-01-01T00:00:00Z", "description": "string", "is_enabled": true, "is_salesforce": true, "is_hubspot": true, "custom_field": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } }, "post": { "summary": "POST /hooks/subscriptions", "description": "POST operation for /hooks/subscriptions", "tags": [ "Hooks" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSubscriptionSerializer" }, "example": { "id": 1, "target": "https://example.com", "event_type": "map-created", "version": "string", "automatic_retry": true, "created_at": "2021-01-01T00:00:00Z", "description": "string", "is_enabled": true, "is_salesforce": true, "is_hubspot": true, "custom_field": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSubscriptionSerializer" }, "example": { "target": "https://example.com", "event_type": "map-created", "version": "string", "automatic_retry": true, "description": "string", "is_enabled": true, "is_salesforce": true, "is_hubspot": true, "custom_field": "string" } } } } } }, "/hooks/subscriptions/{id}": { "get": { "summary": "GET /hooks/subscriptions/{id}", "description": "GET operation for /hooks/subscriptions/{id}", "tags": [ "Hooks" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSubscriptionSerializer" }, "example": { "id": 1, "target": "https://example.com", "event_type": "map-created", "version": "string", "automatic_retry": true, "created_at": "2021-01-01T00:00:00Z", "description": "string", "is_enabled": true, "is_salesforce": true, "is_hubspot": true, "custom_field": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /hooks/subscriptions/{id}", "description": "PUT operation for /hooks/subscriptions/{id}", "tags": [ "Hooks" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSubscriptionSerializer" }, "example": { "id": 1, "target": "https://example.com", "event_type": "map-created", "version": "string", "automatic_retry": true, "created_at": "2021-01-01T00:00:00Z", "description": "string", "is_enabled": true, "is_salesforce": true, "is_hubspot": true, "custom_field": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSubscriptionSerializer" }, "example": { "target": "https://example.com", "event_type": "map-created", "version": "string", "automatic_retry": true, "description": "string", "is_enabled": true, "is_salesforce": true, "is_hubspot": true, "custom_field": "string" } } } } }, "delete": { "summary": "DELETE /hooks/subscriptions/{id}", "description": "DELETE operation for /hooks/subscriptions/{id}", "tags": [ "Hooks" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSubscriptionSerializer" }, "example": { "id": 1, "target": "https://example.com", "event_type": "map-created", "version": "string", "automatic_retry": true, "created_at": "2021-01-01T00:00:00Z", "description": "string", "is_enabled": true, "is_salesforce": true, "is_hubspot": true, "custom_field": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /hooks/subscriptions/{id}", "description": "PATCH operation for /hooks/subscriptions/{id}", "tags": [ "Hooks" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSubscriptionSerializer" }, "example": { "id": 1, "target": "https://example.com", "event_type": "map-created", "version": "string", "automatic_retry": true, "created_at": "2021-01-01T00:00:00Z", "description": "string", "is_enabled": true, "is_salesforce": true, "is_hubspot": true, "custom_field": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookSubscriptionSerializer" }, "example": { "target": "https://example.com", "event_type": "map-created", "version": "string", "automatic_retry": true, "description": "string", "is_enabled": true, "is_salesforce": true, "is_hubspot": true, "custom_field": "string" } } } } } }, "/hooks/data": { "post": { "summary": "POST /hooks/data", "description": "POST operation for /hooks/data", "tags": [ "Hooks" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/history/map-tasks": { "get": { "summary": "GET /history/map-tasks", "description": "GET operation for /history/map-tasks", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryMapTasksSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "order": 1, "status": "open", "is_section": true, "client_visibility": "show_when_map_created", "is_internal": true, "is_optional": true, "onboardee_user": "string", "onboarder_user": "string", "due_date": "2021-01-01", "completed_by_onboardee_user": "string", "completed_by_onboarder_user": "string", "completed_at": "2021-01-01T00:00:00Z", "history_date": "2021-01-01T00:00:00Z", "roadmap": "string", "event_type": "string", "estimated_time": 1, "estimated_time_unit": "minutes", "estimated_time_raw": 1, "time_spent": 1, "time_spent_unit": "minutes", "time_spent_raw": 1, "external_id": "string", "is_ttv": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/history/map-update": { "get": { "summary": "GET /history/map-update", "description": "GET operation for /history/map-update", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryMapUpdateSerializer" }, "example": { "id": 1, "uuid": "string", "name": "string", "status": "launched", "onboardee_company": "string", "owner": "string", "history_date": "2021-01-01T00:00:00Z", "event_type": "string", "expected_launch_date": "2021-01-01T00:00:00Z", "actual_launch_date": "2021-01-01T00:00:00Z", "notes": "string", "has_messages": true, "external_id": "string", "custom": {} } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/options": { "get": { "summary": "GET /options", "description": "GET operation for /options", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptionListSerializer" }, "example": { "id": 1, "name": "string", "variable": "string", "verbose_name": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/options/{id}": { "get": { "summary": "GET /options/{id}", "description": "GET operation for /options/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptionSerializer" }, "example": { "id": 1, "name": "string", "delete": true, "order": 1 } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /options/{id}", "description": "PUT operation for /options/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptionSerializer" }, "example": { "id": 1, "name": "string", "delete": true, "order": 1 } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptionSerializer" }, "example": { "id": 1, "name": "string", "delete": true, "order": 1 } } } } }, "delete": { "summary": "DELETE /options/{id}", "description": "DELETE operation for /options/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptionSerializer" }, "example": { "id": 1, "name": "string", "delete": true, "order": 1 } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /options/{id}", "description": "PATCH operation for /options/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptionSerializer" }, "example": { "id": 1, "name": "string", "delete": true, "order": 1 } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptionSerializer" }, "example": { "id": 1, "name": "string", "delete": true, "order": 1 } } } } } }, "/roadmaps": { "get": { "summary": "GET /roadmaps", "description": "GET operation for /roadmaps", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } }, "post": { "summary": "POST /roadmaps", "description": "POST operation for /roadmaps", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/roadmaps/export": { "get": { "summary": "GET /roadmaps/export", "description": "GET operation for /roadmaps/export", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } }, "post": { "summary": "POST /roadmaps/export", "description": "POST operation for /roadmaps/export", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/roadmaps/{id}/gantt/export": { "get": { "summary": "GET /roadmaps/{id}/gantt/export", "description": "GET operation for /roadmaps/{id}/gantt/export", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /roadmaps/{id}/gantt/export", "description": "POST operation for /roadmaps/{id}/gantt/export", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/roadmaps/{id}": { "get": { "summary": "GET /roadmaps/{id}", "description": "GET operation for /roadmaps/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /roadmaps/{id}", "description": "PUT operation for /roadmaps/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /roadmaps/{id}", "description": "DELETE operation for /roadmaps/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /roadmaps/{id}", "description": "PATCH operation for /roadmaps/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/roadmaps/{id}/tasks": { "get": { "summary": "GET /roadmaps/{id}/tasks", "description": "GET operation for /roadmaps/{id}/tasks", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapTaskSerializer" }, "example": { "id": 1, "roadmap_id": "string", "roadmap_status": "string", "name": "string", "task_id": "string", "is_global_task": "string", "description": "string", "order": 1, "status": "open", "is_section": true, "is_hidden": true, "is_internal": true, "is_optional": true, "onboardee_user": "string", "onboardee_user_id": 1, "onboarder_user": "string", "onboarder_user_id": 1, "due_date": "2021-01-01", "move_to": 1, "description_preview": "string", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "completed_at": "2021-01-01T00:00:00Z", "completed_by_onboardee_user": "string", "completed_by_onboarder_user": "string", "completed_source": "string", "assignee_email": "user@example.com", "estimated_time": 1, "estimated_time_unit": "minutes", "estimated_time_raw": 1, "time_spent": 1, "time_spent_unit": "minutes", "time_spent_raw": 1, "refresh": "string", "refresh_message": "string", "preview_status": "keep", "initial_preview_status": "keep", "has_messages": true, "external_id": "string", "forms": "string", "time_tracking_enabled": true, "sf_task_id": "string", "dependencies": [ "string" ], "start_date": "2021-01-01", "end_date": "2021-01-01", "sync_due_date": true, "category": "task", "embedded": "string", "embedded_url": "string", "embedded_option": "url", "embedded_panel_title": "string", "is_billable": true, "due_date_type": "before_target_launch_date", "due_date_enabled": true, "due_date_days": 1, "due_date_days_after_specific_task_completed_roadmap_task_id": 1, "due_date_days_after_specific_task_due_roadmap_task_id": 1, "embedded_url_merge_tag": "string", "is_outboard_one_off_task": true, "is_ttv": true, "custom": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /roadmaps/{id}/tasks", "description": "POST operation for /roadmaps/{id}/tasks", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapTaskSerializer" }, "example": { "id": 1, "roadmap_id": "string", "roadmap_status": "string", "name": "string", "task_id": "string", "is_global_task": "string", "description": "string", "order": 1, "status": "open", "is_section": true, "is_hidden": true, "is_internal": true, "is_optional": true, "onboardee_user": "string", "onboardee_user_id": 1, "onboarder_user": "string", "onboarder_user_id": 1, "due_date": "2021-01-01", "move_to": 1, "description_preview": "string", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "completed_at": "2021-01-01T00:00:00Z", "completed_by_onboardee_user": "string", "completed_by_onboarder_user": "string", "completed_source": "string", "assignee_email": "user@example.com", "estimated_time": 1, "estimated_time_unit": "minutes", "estimated_time_raw": 1, "time_spent": 1, "time_spent_unit": "minutes", "time_spent_raw": 1, "refresh": "string", "refresh_message": "string", "preview_status": "keep", "initial_preview_status": "keep", "has_messages": true, "external_id": "string", "forms": "string", "time_tracking_enabled": true, "sf_task_id": "string", "dependencies": [ "string" ], "start_date": "2021-01-01", "end_date": "2021-01-01", "sync_due_date": true, "category": "task", "embedded": "string", "embedded_url": "string", "embedded_option": "url", "embedded_panel_title": "string", "is_billable": true, "due_date_type": "before_target_launch_date", "due_date_enabled": true, "due_date_days": 1, "due_date_days_after_specific_task_completed_roadmap_task_id": 1, "due_date_days_after_specific_task_due_roadmap_task_id": 1, "embedded_url_merge_tag": "string", "is_outboard_one_off_task": true, "is_ttv": true, "custom": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapTaskSerializer" }, "example": { "name": "string", "description": "string", "status": "open", "is_section": true, "is_hidden": true, "is_internal": true, "is_optional": true, "onboardee_user_id": 1, "onboarder_user_id": 1, "due_date": "2021-01-01", "move_to": 1, "completed_at": "2021-01-01T00:00:00Z", "completed_source": "string", "assignee_email": "user@example.com", "estimated_time": 1, "estimated_time_unit": "minutes", "estimated_time_raw": 1, "time_spent": 1, "time_spent_unit": "minutes", "time_spent_raw": 1, "preview_status": "keep", "external_id": "string", "time_tracking_enabled": true, "sf_task_id": "string", "dependencies": [ "string" ], "start_date": "2021-01-01", "end_date": "2021-01-01", "sync_due_date": true, "category": "task", "embedded": "string", "embedded_url": "string", "embedded_option": "url", "embedded_panel_title": "string", "is_billable": true, "due_date_days": 1, "due_date_days_after_specific_task_completed_roadmap_task_id": 1, "due_date_days_after_specific_task_due_roadmap_task_id": 1, "is_ttv": true, "custom": "string" } } } } } }, "/roadmaps/{id}/tasks/{id}": { "get": { "summary": "GET /roadmaps/{id}/tasks/{id}", "description": "GET operation for /roadmaps/{id}/tasks/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /roadmaps/{id}/tasks/{id}", "description": "PUT operation for /roadmaps/{id}/tasks/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /roadmaps/{id}/tasks/{id}", "description": "DELETE operation for /roadmaps/{id}/tasks/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /roadmaps/{id}/tasks/{id}", "description": "PATCH operation for /roadmaps/{id}/tasks/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/roadmaps/{id}/tasks/{id}/nudge": { "post": { "summary": "POST /roadmaps/{id}/tasks/{id}/nudge", "description": "POST operation for /roadmaps/{id}/tasks/{id}/nudge", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/roadmaps/{id}/tasks/{id}/move": { "post": { "summary": "POST /roadmaps/{id}/tasks/{id}/move", "description": "POST operation for /roadmaps/{id}/tasks/{id}/move", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/roadmaps/tasks/{id}": { "get": { "summary": "GET /roadmaps/tasks/{id}", "description": "GET operation for /roadmaps/tasks/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /roadmaps/tasks/{id}", "description": "PUT operation for /roadmaps/tasks/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /roadmaps/tasks/{id}", "description": "DELETE operation for /roadmaps/tasks/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /roadmaps/tasks/{id}", "description": "PATCH operation for /roadmaps/tasks/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/roadmaps/tasks/{id}/nudge": { "post": { "summary": "POST /roadmaps/tasks/{id}/nudge", "description": "POST operation for /roadmaps/tasks/{id}/nudge", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/roadmaps/{id}/assignment": { "post": { "summary": "POST /roadmaps/{id}/assignment", "description": "POST operation for /roadmaps/{id}/assignment", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/roadmaps/{id}/members": { "get": { "summary": "GET /roadmaps/{id}/members", "description": "GET operation for /roadmaps/{id}/members", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/roadmaps/{id}/preview": { "post": { "summary": "POST /roadmaps/{id}/preview", "description": "POST operation for /roadmaps/{id}/preview", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapPreviewSerializer" }, "example": { "id": 1, "preview_roadmap_id": "string", "options": "string", "tasks": "string", "parent_preview_save_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapPreviewSerializer" }, "example": { "options": "string" } } } } } }, "/roadmaps/{id}/preview-status": { "get": { "summary": "GET /roadmaps/{id}/preview-status", "description": "GET operation for /roadmaps/{id}/preview-status", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/roadmaps/preview/{id}": { "get": { "summary": "GET /roadmaps/preview/{id}", "description": "GET operation for /roadmaps/preview/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapPreviewSerializer" }, "example": { "id": 1, "preview_roadmap_id": "string", "options": "string", "tasks": "string", "parent_preview_save_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /roadmaps/preview/{id}", "description": "POST operation for /roadmaps/preview/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapPreviewSerializer" }, "example": { "id": 1, "preview_roadmap_id": "string", "options": "string", "tasks": "string", "parent_preview_save_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapPreviewSerializer" }, "example": { "options": "string" } } } } }, "delete": { "summary": "DELETE /roadmaps/preview/{id}", "description": "DELETE operation for /roadmaps/preview/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapPreviewSerializer" }, "example": { "id": 1, "preview_roadmap_id": "string", "options": "string", "tasks": "string", "parent_preview_save_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/roadmaps/preview/{id}/save": { "get": { "summary": "GET /roadmaps/preview/{id}/save", "description": "GET operation for /roadmaps/preview/{id}/save", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapPreviewSerializer" }, "example": { "id": 1, "preview_roadmap_id": "string", "options": "string", "tasks": "string", "parent_preview_save_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /roadmaps/preview/{id}/save", "description": "POST operation for /roadmaps/preview/{id}/save", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapPreviewSerializer" }, "example": { "id": 1, "preview_roadmap_id": "string", "options": "string", "tasks": "string", "parent_preview_save_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapPreviewSerializer" }, "example": { "options": "string" } } } } }, "delete": { "summary": "DELETE /roadmaps/preview/{id}/save", "description": "DELETE operation for /roadmaps/preview/{id}/save", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapPreviewSerializer" }, "example": { "id": 1, "preview_roadmap_id": "string", "options": "string", "tasks": "string", "parent_preview_save_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/roadmaps/{id}/insights/summary": { "get": { "summary": "GET /roadmaps/{id}/insights/summary", "description": "GET operation for /roadmaps/{id}/insights/summary", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/roadmaps/{id}/assessment-history": { "get": { "summary": "GET /roadmaps/{id}/assessment-history", "description": "GET operation for /roadmaps/{id}/assessment-history", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapAssessmentHistorySerializer" }, "example": { "id": 1, "roadmap_id": 1, "roadmap_name": "string", "customer_sentiment_assessment": 1, "previous_customer_sentiment_assessment": 1, "project_team_assessment": 1, "previous_project_team_assessment": 1, "updated_by": "string", "updated_by_name": "string", "updated_by_email": "string", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/roadmaps/{id}/assessment-history/export": { "get": { "summary": "GET /roadmaps/{id}/assessment-history/export", "description": "GET operation for /roadmaps/{id}/assessment-history/export", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/roadmaps/{roadmap_id}/onboardee-users": { "get": { "summary": "GET /roadmaps/{roadmap_id}/onboardee-users", "description": "GET operation for /roadmaps/{roadmap_id}/onboardee-users", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboardeeUserSerializer" }, "example": { "roadmap_id": "string", "onboardee_user_id": 1, "onboardee_user": "string", "email": "string", "roadmap_roles_assigned": "string", "roadmap_roles_assigned_ids": [ "string" ], "roadmap_roles_assigned_names": [ "string" ], "assign_tasks": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "roadmap_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /roadmaps/{roadmap_id}/onboardee-users", "description": "POST operation for /roadmaps/{roadmap_id}/onboardee-users", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboardeeUserSerializer" }, "example": { "roadmap_id": "string", "onboardee_user_id": 1, "onboardee_user": "string", "email": "string", "roadmap_roles_assigned": "string", "roadmap_roles_assigned_ids": [ "string" ], "roadmap_roles_assigned_names": [ "string" ], "assign_tasks": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "roadmap_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboardeeUserSerializer" }, "example": { "onboardee_user_id": 1, "email": "string", "roadmap_roles_assigned_ids": [ "string" ], "roadmap_roles_assigned_names": [ "string" ], "assign_tasks": true } } } } } }, "/roadmaps/{roadmap_id}/onboarder-users": { "get": { "summary": "GET /roadmaps/{roadmap_id}/onboarder-users", "description": "GET operation for /roadmaps/{roadmap_id}/onboarder-users", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboarderUserSerializer" }, "example": { "roadmap_id": "string", "onboarder_user_id": 1, "onboarder_user": "string", "email": "string", "roadmap_roles_assigned": "string", "roadmap_roles_assigned_ids": [ "string" ], "assign_tasks": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "roadmap_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /roadmaps/{roadmap_id}/onboarder-users", "description": "POST operation for /roadmaps/{roadmap_id}/onboarder-users", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboarderUserSerializer" }, "example": { "roadmap_id": "string", "onboarder_user_id": 1, "onboarder_user": "string", "email": "string", "roadmap_roles_assigned": "string", "roadmap_roles_assigned_ids": [ "string" ], "assign_tasks": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "roadmap_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboarderUserSerializer" }, "example": { "onboarder_user_id": 1, "email": "string", "roadmap_roles_assigned_ids": [ "string" ], "assign_tasks": true } } } } } }, "/roadmaps/{roadmap_id}/onboardee-users/{onboardee_user_id}": { "get": { "summary": "GET /roadmaps/{roadmap_id}/onboardee-users/{onboardee_user_id}", "description": "GET operation for /roadmaps/{roadmap_id}/onboardee-users/{onboardee_user_id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboardeeUserSerializer" }, "example": { "roadmap_id": "string", "onboardee_user_id": 1, "onboardee_user": "string", "email": "string", "roadmap_roles_assigned": "string", "roadmap_roles_assigned_ids": [ "string" ], "roadmap_roles_assigned_names": [ "string" ], "assign_tasks": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "roadmap_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "onboardee_user_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /roadmaps/{roadmap_id}/onboardee-users/{onboardee_user_id}", "description": "PUT operation for /roadmaps/{roadmap_id}/onboardee-users/{onboardee_user_id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboardeeUserSerializer" }, "example": { "roadmap_id": "string", "onboardee_user_id": 1, "onboardee_user": "string", "email": "string", "roadmap_roles_assigned": "string", "roadmap_roles_assigned_ids": [ "string" ], "roadmap_roles_assigned_names": [ "string" ], "assign_tasks": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "roadmap_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "onboardee_user_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboardeeUserSerializer" }, "example": { "onboardee_user_id": 1, "email": "string", "roadmap_roles_assigned_ids": [ "string" ], "roadmap_roles_assigned_names": [ "string" ], "assign_tasks": true } } } } }, "delete": { "summary": "DELETE /roadmaps/{roadmap_id}/onboardee-users/{onboardee_user_id}", "description": "DELETE operation for /roadmaps/{roadmap_id}/onboardee-users/{onboardee_user_id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboardeeUserSerializer" }, "example": { "roadmap_id": "string", "onboardee_user_id": 1, "onboardee_user": "string", "email": "string", "roadmap_roles_assigned": "string", "roadmap_roles_assigned_ids": [ "string" ], "roadmap_roles_assigned_names": [ "string" ], "assign_tasks": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "roadmap_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "onboardee_user_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /roadmaps/{roadmap_id}/onboardee-users/{onboardee_user_id}", "description": "PATCH operation for /roadmaps/{roadmap_id}/onboardee-users/{onboardee_user_id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboardeeUserSerializer" }, "example": { "roadmap_id": "string", "onboardee_user_id": 1, "onboardee_user": "string", "email": "string", "roadmap_roles_assigned": "string", "roadmap_roles_assigned_ids": [ "string" ], "roadmap_roles_assigned_names": [ "string" ], "assign_tasks": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "roadmap_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "onboardee_user_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboardeeUserSerializer" }, "example": { "onboardee_user_id": 1, "email": "string", "roadmap_roles_assigned_ids": [ "string" ], "roadmap_roles_assigned_names": [ "string" ], "assign_tasks": true } } } } } }, "/roadmaps/{roadmap_id}/onboarder-users/{onboarder_user_id}": { "get": { "summary": "GET /roadmaps/{roadmap_id}/onboarder-users/{onboarder_user_id}", "description": "GET operation for /roadmaps/{roadmap_id}/onboarder-users/{onboarder_user_id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboarderUserSerializer" }, "example": { "roadmap_id": "string", "onboarder_user_id": 1, "onboarder_user": "string", "email": "string", "roadmap_roles_assigned": "string", "roadmap_roles_assigned_ids": [ "string" ], "assign_tasks": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "roadmap_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "onboarder_user_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /roadmaps/{roadmap_id}/onboarder-users/{onboarder_user_id}", "description": "PUT operation for /roadmaps/{roadmap_id}/onboarder-users/{onboarder_user_id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboarderUserSerializer" }, "example": { "roadmap_id": "string", "onboarder_user_id": 1, "onboarder_user": "string", "email": "string", "roadmap_roles_assigned": "string", "roadmap_roles_assigned_ids": [ "string" ], "assign_tasks": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "roadmap_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "onboarder_user_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboarderUserSerializer" }, "example": { "onboarder_user_id": 1, "email": "string", "roadmap_roles_assigned_ids": [ "string" ], "assign_tasks": true } } } } }, "delete": { "summary": "DELETE /roadmaps/{roadmap_id}/onboarder-users/{onboarder_user_id}", "description": "DELETE operation for /roadmaps/{roadmap_id}/onboarder-users/{onboarder_user_id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboarderUserSerializer" }, "example": { "roadmap_id": "string", "onboarder_user_id": 1, "onboarder_user": "string", "email": "string", "roadmap_roles_assigned": "string", "roadmap_roles_assigned_ids": [ "string" ], "assign_tasks": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "roadmap_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "onboarder_user_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /roadmaps/{roadmap_id}/onboarder-users/{onboarder_user_id}", "description": "PATCH operation for /roadmaps/{roadmap_id}/onboarder-users/{onboarder_user_id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboarderUserSerializer" }, "example": { "roadmap_id": "string", "onboarder_user_id": 1, "onboarder_user": "string", "email": "string", "roadmap_roles_assigned": "string", "roadmap_roles_assigned_ids": [ "string" ], "assign_tasks": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "roadmap_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "onboarder_user_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboarderUserSerializer" }, "example": { "onboarder_user_id": 1, "email": "string", "roadmap_roles_assigned_ids": [ "string" ], "assign_tasks": true } } } } } }, "/roadmaps/{roadmap_id}/onboardee-users/{onboardee_user_id}/invite": { "post": { "summary": "POST /roadmaps/{roadmap_id}/onboardee-users/{onboardee_user_id}/invite", "description": "POST operation for /roadmaps/{roadmap_id}/onboardee-users/{onboardee_user_id}/invite", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "roadmap_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "onboardee_user_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/roadmaps/{roadmap_id}/onboarder-users/{onboarder_user_id}/invite": { "post": { "summary": "POST /roadmaps/{roadmap_id}/onboarder-users/{onboarder_user_id}/invite", "description": "POST operation for /roadmaps/{roadmap_id}/onboarder-users/{onboarder_user_id}/invite", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "roadmap_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "onboarder_user_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/projects": { "get": { "summary": "GET /projects", "description": "GET operation for /projects", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } }, "post": { "summary": "POST /projects", "description": "POST operation for /projects", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/projects/export": { "get": { "summary": "GET /projects/export", "description": "GET operation for /projects/export", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } }, "post": { "summary": "POST /projects/export", "description": "POST operation for /projects/export", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/projects/{id}/gantt/export": { "get": { "summary": "GET /projects/{id}/gantt/export", "description": "GET operation for /projects/{id}/gantt/export", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /projects/{id}/gantt/export", "description": "POST operation for /projects/{id}/gantt/export", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/projects/{id}": { "get": { "summary": "GET /projects/{id}", "description": "GET operation for /projects/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /projects/{id}", "description": "PUT operation for /projects/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /projects/{id}", "description": "DELETE operation for /projects/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /projects/{id}", "description": "PATCH operation for /projects/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/projects/{id}/tasks": { "get": { "summary": "GET /projects/{id}/tasks", "description": "GET operation for /projects/{id}/tasks", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapTaskSerializer" }, "example": { "id": 1, "roadmap_id": "string", "roadmap_status": "string", "name": "string", "task_id": "string", "is_global_task": "string", "description": "string", "order": 1, "status": "open", "is_section": true, "is_hidden": true, "is_internal": true, "is_optional": true, "onboardee_user": "string", "onboardee_user_id": 1, "onboarder_user": "string", "onboarder_user_id": 1, "due_date": "2021-01-01", "move_to": 1, "description_preview": "string", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "completed_at": "2021-01-01T00:00:00Z", "completed_by_onboardee_user": "string", "completed_by_onboarder_user": "string", "completed_source": "string", "assignee_email": "user@example.com", "estimated_time": 1, "estimated_time_unit": "minutes", "estimated_time_raw": 1, "time_spent": 1, "time_spent_unit": "minutes", "time_spent_raw": 1, "refresh": "string", "refresh_message": "string", "preview_status": "keep", "initial_preview_status": "keep", "has_messages": true, "external_id": "string", "forms": "string", "time_tracking_enabled": true, "sf_task_id": "string", "dependencies": [ "string" ], "start_date": "2021-01-01", "end_date": "2021-01-01", "sync_due_date": true, "category": "task", "embedded": "string", "embedded_url": "string", "embedded_option": "url", "embedded_panel_title": "string", "is_billable": true, "due_date_type": "before_target_launch_date", "due_date_enabled": true, "due_date_days": 1, "due_date_days_after_specific_task_completed_roadmap_task_id": 1, "due_date_days_after_specific_task_due_roadmap_task_id": 1, "embedded_url_merge_tag": "string", "is_outboard_one_off_task": true, "is_ttv": true, "custom": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /projects/{id}/tasks", "description": "POST operation for /projects/{id}/tasks", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapTaskSerializer" }, "example": { "id": 1, "roadmap_id": "string", "roadmap_status": "string", "name": "string", "task_id": "string", "is_global_task": "string", "description": "string", "order": 1, "status": "open", "is_section": true, "is_hidden": true, "is_internal": true, "is_optional": true, "onboardee_user": "string", "onboardee_user_id": 1, "onboarder_user": "string", "onboarder_user_id": 1, "due_date": "2021-01-01", "move_to": 1, "description_preview": "string", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "completed_at": "2021-01-01T00:00:00Z", "completed_by_onboardee_user": "string", "completed_by_onboarder_user": "string", "completed_source": "string", "assignee_email": "user@example.com", "estimated_time": 1, "estimated_time_unit": "minutes", "estimated_time_raw": 1, "time_spent": 1, "time_spent_unit": "minutes", "time_spent_raw": 1, "refresh": "string", "refresh_message": "string", "preview_status": "keep", "initial_preview_status": "keep", "has_messages": true, "external_id": "string", "forms": "string", "time_tracking_enabled": true, "sf_task_id": "string", "dependencies": [ "string" ], "start_date": "2021-01-01", "end_date": "2021-01-01", "sync_due_date": true, "category": "task", "embedded": "string", "embedded_url": "string", "embedded_option": "url", "embedded_panel_title": "string", "is_billable": true, "due_date_type": "before_target_launch_date", "due_date_enabled": true, "due_date_days": 1, "due_date_days_after_specific_task_completed_roadmap_task_id": 1, "due_date_days_after_specific_task_due_roadmap_task_id": 1, "embedded_url_merge_tag": "string", "is_outboard_one_off_task": true, "is_ttv": true, "custom": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapTaskSerializer" }, "example": { "name": "string", "description": "string", "status": "open", "is_section": true, "is_hidden": true, "is_internal": true, "is_optional": true, "onboardee_user_id": 1, "onboarder_user_id": 1, "due_date": "2021-01-01", "move_to": 1, "completed_at": "2021-01-01T00:00:00Z", "completed_source": "string", "assignee_email": "user@example.com", "estimated_time": 1, "estimated_time_unit": "minutes", "estimated_time_raw": 1, "time_spent": 1, "time_spent_unit": "minutes", "time_spent_raw": 1, "preview_status": "keep", "external_id": "string", "time_tracking_enabled": true, "sf_task_id": "string", "dependencies": [ "string" ], "start_date": "2021-01-01", "end_date": "2021-01-01", "sync_due_date": true, "category": "task", "embedded": "string", "embedded_url": "string", "embedded_option": "url", "embedded_panel_title": "string", "is_billable": true, "due_date_days": 1, "due_date_days_after_specific_task_completed_roadmap_task_id": 1, "due_date_days_after_specific_task_due_roadmap_task_id": 1, "is_ttv": true, "custom": "string" } } } } } }, "/projects/{id}/tasks/{id}": { "get": { "summary": "GET /projects/{id}/tasks/{id}", "description": "GET operation for /projects/{id}/tasks/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /projects/{id}/tasks/{id}", "description": "PUT operation for /projects/{id}/tasks/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /projects/{id}/tasks/{id}", "description": "DELETE operation for /projects/{id}/tasks/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /projects/{id}/tasks/{id}", "description": "PATCH operation for /projects/{id}/tasks/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/projects/{id}/tasks/{id}/nudge": { "post": { "summary": "POST /projects/{id}/tasks/{id}/nudge", "description": "POST operation for /projects/{id}/tasks/{id}/nudge", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/projects/{id}/tasks/{id}/move": { "post": { "summary": "POST /projects/{id}/tasks/{id}/move", "description": "POST operation for /projects/{id}/tasks/{id}/move", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/projects/{id}/preview": { "post": { "summary": "POST /projects/{id}/preview", "description": "POST operation for /projects/{id}/preview", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapPreviewSerializer" }, "example": { "id": 1, "preview_roadmap_id": "string", "options": "string", "tasks": "string", "parent_preview_save_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapPreviewSerializer" }, "example": { "options": "string" } } } } } }, "/projects/{id}/preview-status": { "get": { "summary": "GET /projects/{id}/preview-status", "description": "GET operation for /projects/{id}/preview-status", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/projects/preview/{id}": { "get": { "summary": "GET /projects/preview/{id}", "description": "GET operation for /projects/preview/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapPreviewSerializer" }, "example": { "id": 1, "preview_roadmap_id": "string", "options": "string", "tasks": "string", "parent_preview_save_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /projects/preview/{id}", "description": "POST operation for /projects/preview/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapPreviewSerializer" }, "example": { "id": 1, "preview_roadmap_id": "string", "options": "string", "tasks": "string", "parent_preview_save_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapPreviewSerializer" }, "example": { "options": "string" } } } } }, "delete": { "summary": "DELETE /projects/preview/{id}", "description": "DELETE operation for /projects/preview/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapPreviewSerializer" }, "example": { "id": 1, "preview_roadmap_id": "string", "options": "string", "tasks": "string", "parent_preview_save_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/projects/preview/{id}/save": { "get": { "summary": "GET /projects/preview/{id}/save", "description": "GET operation for /projects/preview/{id}/save", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapPreviewSerializer" }, "example": { "id": 1, "preview_roadmap_id": "string", "options": "string", "tasks": "string", "parent_preview_save_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /projects/preview/{id}/save", "description": "POST operation for /projects/preview/{id}/save", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapPreviewSerializer" }, "example": { "id": 1, "preview_roadmap_id": "string", "options": "string", "tasks": "string", "parent_preview_save_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapPreviewSerializer" }, "example": { "options": "string" } } } } }, "delete": { "summary": "DELETE /projects/preview/{id}/save", "description": "DELETE operation for /projects/preview/{id}/save", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapPreviewSerializer" }, "example": { "id": 1, "preview_roadmap_id": "string", "options": "string", "tasks": "string", "parent_preview_save_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/projects/{id}/insights/summary": { "get": { "summary": "GET /projects/{id}/insights/summary", "description": "GET operation for /projects/{id}/insights/summary", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/projects/{id}/assessment-history": { "get": { "summary": "GET /projects/{id}/assessment-history", "description": "GET operation for /projects/{id}/assessment-history", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapAssessmentHistorySerializer" }, "example": { "id": 1, "roadmap_id": 1, "roadmap_name": "string", "customer_sentiment_assessment": 1, "previous_customer_sentiment_assessment": 1, "project_team_assessment": 1, "previous_project_team_assessment": 1, "updated_by": "string", "updated_by_name": "string", "updated_by_email": "string", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/projects/{id}/assessment-history/export": { "get": { "summary": "GET /projects/{id}/assessment-history/export", "description": "GET operation for /projects/{id}/assessment-history/export", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/projects/{project_id}/onboardee-users": { "get": { "summary": "GET /projects/{project_id}/onboardee-users", "description": "GET operation for /projects/{project_id}/onboardee-users", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboardeeUserSerializer" }, "example": { "roadmap_id": "string", "onboardee_user_id": 1, "onboardee_user": "string", "email": "string", "roadmap_roles_assigned": "string", "roadmap_roles_assigned_ids": [ "string" ], "roadmap_roles_assigned_names": [ "string" ], "assign_tasks": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /projects/{project_id}/onboardee-users", "description": "POST operation for /projects/{project_id}/onboardee-users", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboardeeUserSerializer" }, "example": { "roadmap_id": "string", "onboardee_user_id": 1, "onboardee_user": "string", "email": "string", "roadmap_roles_assigned": "string", "roadmap_roles_assigned_ids": [ "string" ], "roadmap_roles_assigned_names": [ "string" ], "assign_tasks": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboardeeUserSerializer" }, "example": { "onboardee_user_id": 1, "email": "string", "roadmap_roles_assigned_ids": [ "string" ], "roadmap_roles_assigned_names": [ "string" ], "assign_tasks": true } } } } } }, "/projects/{project_id}/onboarder-users": { "get": { "summary": "GET /projects/{project_id}/onboarder-users", "description": "GET operation for /projects/{project_id}/onboarder-users", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboarderUserSerializer" }, "example": { "roadmap_id": "string", "onboarder_user_id": 1, "onboarder_user": "string", "email": "string", "roadmap_roles_assigned": "string", "roadmap_roles_assigned_ids": [ "string" ], "assign_tasks": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /projects/{project_id}/onboarder-users", "description": "POST operation for /projects/{project_id}/onboarder-users", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboarderUserSerializer" }, "example": { "roadmap_id": "string", "onboarder_user_id": 1, "onboarder_user": "string", "email": "string", "roadmap_roles_assigned": "string", "roadmap_roles_assigned_ids": [ "string" ], "assign_tasks": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboarderUserSerializer" }, "example": { "onboarder_user_id": 1, "email": "string", "roadmap_roles_assigned_ids": [ "string" ], "assign_tasks": true } } } } } }, "/projects/{project_id}/onboardee-users/{onboardee_user_id}": { "get": { "summary": "GET /projects/{project_id}/onboardee-users/{onboardee_user_id}", "description": "GET operation for /projects/{project_id}/onboardee-users/{onboardee_user_id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboardeeUserSerializer" }, "example": { "roadmap_id": "string", "onboardee_user_id": 1, "onboardee_user": "string", "email": "string", "roadmap_roles_assigned": "string", "roadmap_roles_assigned_ids": [ "string" ], "roadmap_roles_assigned_names": [ "string" ], "assign_tasks": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "onboardee_user_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /projects/{project_id}/onboardee-users/{onboardee_user_id}", "description": "PUT operation for /projects/{project_id}/onboardee-users/{onboardee_user_id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboardeeUserSerializer" }, "example": { "roadmap_id": "string", "onboardee_user_id": 1, "onboardee_user": "string", "email": "string", "roadmap_roles_assigned": "string", "roadmap_roles_assigned_ids": [ "string" ], "roadmap_roles_assigned_names": [ "string" ], "assign_tasks": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "onboardee_user_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboardeeUserSerializer" }, "example": { "onboardee_user_id": 1, "email": "string", "roadmap_roles_assigned_ids": [ "string" ], "roadmap_roles_assigned_names": [ "string" ], "assign_tasks": true } } } } }, "delete": { "summary": "DELETE /projects/{project_id}/onboardee-users/{onboardee_user_id}", "description": "DELETE operation for /projects/{project_id}/onboardee-users/{onboardee_user_id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboardeeUserSerializer" }, "example": { "roadmap_id": "string", "onboardee_user_id": 1, "onboardee_user": "string", "email": "string", "roadmap_roles_assigned": "string", "roadmap_roles_assigned_ids": [ "string" ], "roadmap_roles_assigned_names": [ "string" ], "assign_tasks": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "onboardee_user_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /projects/{project_id}/onboardee-users/{onboardee_user_id}", "description": "PATCH operation for /projects/{project_id}/onboardee-users/{onboardee_user_id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboardeeUserSerializer" }, "example": { "roadmap_id": "string", "onboardee_user_id": 1, "onboardee_user": "string", "email": "string", "roadmap_roles_assigned": "string", "roadmap_roles_assigned_ids": [ "string" ], "roadmap_roles_assigned_names": [ "string" ], "assign_tasks": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "onboardee_user_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboardeeUserSerializer" }, "example": { "onboardee_user_id": 1, "email": "string", "roadmap_roles_assigned_ids": [ "string" ], "roadmap_roles_assigned_names": [ "string" ], "assign_tasks": true } } } } } }, "/projects/{project_id}/onboarder-users/{onboarder_user_id}": { "get": { "summary": "GET /projects/{project_id}/onboarder-users/{onboarder_user_id}", "description": "GET operation for /projects/{project_id}/onboarder-users/{onboarder_user_id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboarderUserSerializer" }, "example": { "roadmap_id": "string", "onboarder_user_id": 1, "onboarder_user": "string", "email": "string", "roadmap_roles_assigned": "string", "roadmap_roles_assigned_ids": [ "string" ], "assign_tasks": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "onboarder_user_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /projects/{project_id}/onboarder-users/{onboarder_user_id}", "description": "PUT operation for /projects/{project_id}/onboarder-users/{onboarder_user_id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboarderUserSerializer" }, "example": { "roadmap_id": "string", "onboarder_user_id": 1, "onboarder_user": "string", "email": "string", "roadmap_roles_assigned": "string", "roadmap_roles_assigned_ids": [ "string" ], "assign_tasks": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "onboarder_user_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboarderUserSerializer" }, "example": { "onboarder_user_id": 1, "email": "string", "roadmap_roles_assigned_ids": [ "string" ], "assign_tasks": true } } } } }, "delete": { "summary": "DELETE /projects/{project_id}/onboarder-users/{onboarder_user_id}", "description": "DELETE operation for /projects/{project_id}/onboarder-users/{onboarder_user_id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboarderUserSerializer" }, "example": { "roadmap_id": "string", "onboarder_user_id": 1, "onboarder_user": "string", "email": "string", "roadmap_roles_assigned": "string", "roadmap_roles_assigned_ids": [ "string" ], "assign_tasks": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "onboarder_user_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /projects/{project_id}/onboarder-users/{onboarder_user_id}", "description": "PATCH operation for /projects/{project_id}/onboarder-users/{onboarder_user_id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboarderUserSerializer" }, "example": { "roadmap_id": "string", "onboarder_user_id": 1, "onboarder_user": "string", "email": "string", "roadmap_roles_assigned": "string", "roadmap_roles_assigned_ids": [ "string" ], "assign_tasks": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "onboarder_user_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoadmapOnboarderUserSerializer" }, "example": { "onboarder_user_id": 1, "email": "string", "roadmap_roles_assigned_ids": [ "string" ], "assign_tasks": true } } } } } }, "/projects/{project_id}/onboardee-users/{onboardee_user_id}/invite": { "post": { "summary": "POST /projects/{project_id}/onboardee-users/{onboardee_user_id}/invite", "description": "POST operation for /projects/{project_id}/onboardee-users/{onboardee_user_id}/invite", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "onboardee_user_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/projects/{project_id}/onboarder-users/{onboarder_user_id}/invite": { "post": { "summary": "POST /projects/{project_id}/onboarder-users/{onboarder_user_id}/invite", "description": "POST operation for /projects/{project_id}/onboarder-users/{onboarder_user_id}/invite", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "onboarder_user_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/tasks": { "get": { "summary": "GET /tasks", "description": "GET operation for /tasks", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "description_preview": "string", "order": 1, "is_section": true, "is_optional": true, "client_visibility": "show_when_map_created", "due_date_type": "before_target_launch_date", "due_date_days": 1, "due_date_enabled": true, "options_advanced": "string", "created_at": "2021-01-01T00:00:00Z", "move_to": 1, "options": "string", "is_internal": true, "assign_to_owner": true, "estimated_time": 1, "estimated_time_unit": "minutes", "estimated_time_raw": 1, "forms": "string", "time_tracking_enabled": true, "assign_to_role": "string", "assign_to_role_id": 1, "dependencies": [ "string" ], "category": "task", "embedded": "string", "embedded_url": "string", "embedded_option": "url", "embedded_panel_title": "string", "modified_at": "2021-01-01T00:00:00Z", "map_types": "string", "map_types_ids": "string", "is_billable": true, "due_date_days_after_specific_task_completed_task_id": 1, "due_date_days_after_specific_task_completed_task": "string", "due_date_days_after_specific_task_due_task_id": 1, "due_date_days_after_specific_task_due_task": "string", "embedded_url_merge_tag": "string", "is_ttv": true, "update_tasks": true, "update_tasks_notify": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } }, "post": { "summary": "POST /tasks", "description": "POST operation for /tasks", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "description_preview": "string", "order": 1, "is_section": true, "is_optional": true, "client_visibility": "show_when_map_created", "due_date_type": "before_target_launch_date", "due_date_days": 1, "due_date_enabled": true, "options_advanced": "string", "created_at": "2021-01-01T00:00:00Z", "move_to": 1, "options": "string", "is_internal": true, "assign_to_owner": true, "estimated_time": 1, "estimated_time_unit": "minutes", "estimated_time_raw": 1, "forms": "string", "time_tracking_enabled": true, "assign_to_role": "string", "assign_to_role_id": 1, "dependencies": [ "string" ], "category": "task", "embedded": "string", "embedded_url": "string", "embedded_option": "url", "embedded_panel_title": "string", "modified_at": "2021-01-01T00:00:00Z", "map_types": "string", "map_types_ids": "string", "is_billable": true, "due_date_days_after_specific_task_completed_task_id": 1, "due_date_days_after_specific_task_completed_task": "string", "due_date_days_after_specific_task_due_task_id": 1, "due_date_days_after_specific_task_due_task": "string", "embedded_url_merge_tag": "string", "is_ttv": true, "update_tasks": true, "update_tasks_notify": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "is_section": true, "is_optional": true, "client_visibility": "show_when_map_created", "due_date_type": "before_target_launch_date", "due_date_days": 1, "due_date_enabled": true, "options_advanced": "string", "move_to": 1, "options": "string", "is_internal": true, "assign_to_owner": true, "estimated_time": 1, "estimated_time_unit": "minutes", "estimated_time_raw": 1, "time_tracking_enabled": true, "assign_to_role": "string", "assign_to_role_id": 1, "dependencies": [ "string" ], "category": "task", "embedded": "string", "embedded_url": "string", "embedded_option": "url", "embedded_panel_title": "string", "is_billable": true, "due_date_days_after_specific_task_completed_task_id": 1, "due_date_days_after_specific_task_due_task_id": 1, "embedded_url_merge_tag": "string", "is_ttv": true, "update_tasks": true, "update_tasks_notify": true } } } } } }, "/tasks/{id}": { "get": { "summary": "GET /tasks/{id}", "description": "GET operation for /tasks/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "description_preview": "string", "order": 1, "is_section": true, "is_optional": true, "client_visibility": "show_when_map_created", "due_date_type": "before_target_launch_date", "due_date_days": 1, "due_date_enabled": true, "options_advanced": "string", "created_at": "2021-01-01T00:00:00Z", "move_to": 1, "options": "string", "is_internal": true, "assign_to_owner": true, "estimated_time": 1, "estimated_time_unit": "minutes", "estimated_time_raw": 1, "forms": "string", "time_tracking_enabled": true, "assign_to_role": "string", "assign_to_role_id": 1, "dependencies": [ "string" ], "category": "task", "embedded": "string", "embedded_url": "string", "embedded_option": "url", "embedded_panel_title": "string", "modified_at": "2021-01-01T00:00:00Z", "map_types": "string", "map_types_ids": "string", "is_billable": true, "due_date_days_after_specific_task_completed_task_id": 1, "due_date_days_after_specific_task_completed_task": "string", "due_date_days_after_specific_task_due_task_id": 1, "due_date_days_after_specific_task_due_task": "string", "embedded_url_merge_tag": "string", "is_ttv": true, "update_tasks": true, "update_tasks_notify": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /tasks/{id}", "description": "PUT operation for /tasks/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "description_preview": "string", "order": 1, "is_section": true, "is_optional": true, "client_visibility": "show_when_map_created", "due_date_type": "before_target_launch_date", "due_date_days": 1, "due_date_enabled": true, "options_advanced": "string", "created_at": "2021-01-01T00:00:00Z", "move_to": 1, "options": "string", "is_internal": true, "assign_to_owner": true, "estimated_time": 1, "estimated_time_unit": "minutes", "estimated_time_raw": 1, "forms": "string", "time_tracking_enabled": true, "assign_to_role": "string", "assign_to_role_id": 1, "dependencies": [ "string" ], "category": "task", "embedded": "string", "embedded_url": "string", "embedded_option": "url", "embedded_panel_title": "string", "modified_at": "2021-01-01T00:00:00Z", "map_types": "string", "map_types_ids": "string", "is_billable": true, "due_date_days_after_specific_task_completed_task_id": 1, "due_date_days_after_specific_task_completed_task": "string", "due_date_days_after_specific_task_due_task_id": 1, "due_date_days_after_specific_task_due_task": "string", "embedded_url_merge_tag": "string", "is_ttv": true, "update_tasks": true, "update_tasks_notify": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "is_section": true, "is_optional": true, "client_visibility": "show_when_map_created", "due_date_type": "before_target_launch_date", "due_date_days": 1, "due_date_enabled": true, "options_advanced": "string", "move_to": 1, "options": "string", "is_internal": true, "assign_to_owner": true, "estimated_time": 1, "estimated_time_unit": "minutes", "estimated_time_raw": 1, "time_tracking_enabled": true, "assign_to_role": "string", "assign_to_role_id": 1, "dependencies": [ "string" ], "category": "task", "embedded": "string", "embedded_url": "string", "embedded_option": "url", "embedded_panel_title": "string", "is_billable": true, "due_date_days_after_specific_task_completed_task_id": 1, "due_date_days_after_specific_task_due_task_id": 1, "embedded_url_merge_tag": "string", "is_ttv": true, "update_tasks": true, "update_tasks_notify": true } } } } }, "delete": { "summary": "DELETE /tasks/{id}", "description": "DELETE operation for /tasks/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "description_preview": "string", "order": 1, "is_section": true, "is_optional": true, "client_visibility": "show_when_map_created", "due_date_type": "before_target_launch_date", "due_date_days": 1, "due_date_enabled": true, "options_advanced": "string", "created_at": "2021-01-01T00:00:00Z", "move_to": 1, "options": "string", "is_internal": true, "assign_to_owner": true, "estimated_time": 1, "estimated_time_unit": "minutes", "estimated_time_raw": 1, "forms": "string", "time_tracking_enabled": true, "assign_to_role": "string", "assign_to_role_id": 1, "dependencies": [ "string" ], "category": "task", "embedded": "string", "embedded_url": "string", "embedded_option": "url", "embedded_panel_title": "string", "modified_at": "2021-01-01T00:00:00Z", "map_types": "string", "map_types_ids": "string", "is_billable": true, "due_date_days_after_specific_task_completed_task_id": 1, "due_date_days_after_specific_task_completed_task": "string", "due_date_days_after_specific_task_due_task_id": 1, "due_date_days_after_specific_task_due_task": "string", "embedded_url_merge_tag": "string", "is_ttv": true, "update_tasks": true, "update_tasks_notify": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /tasks/{id}", "description": "PATCH operation for /tasks/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "description_preview": "string", "order": 1, "is_section": true, "is_optional": true, "client_visibility": "show_when_map_created", "due_date_type": "before_target_launch_date", "due_date_days": 1, "due_date_enabled": true, "options_advanced": "string", "created_at": "2021-01-01T00:00:00Z", "move_to": 1, "options": "string", "is_internal": true, "assign_to_owner": true, "estimated_time": 1, "estimated_time_unit": "minutes", "estimated_time_raw": 1, "forms": "string", "time_tracking_enabled": true, "assign_to_role": "string", "assign_to_role_id": 1, "dependencies": [ "string" ], "category": "task", "embedded": "string", "embedded_url": "string", "embedded_option": "url", "embedded_panel_title": "string", "modified_at": "2021-01-01T00:00:00Z", "map_types": "string", "map_types_ids": "string", "is_billable": true, "due_date_days_after_specific_task_completed_task_id": 1, "due_date_days_after_specific_task_completed_task": "string", "due_date_days_after_specific_task_due_task_id": 1, "due_date_days_after_specific_task_due_task": "string", "embedded_url_merge_tag": "string", "is_ttv": true, "update_tasks": true, "update_tasks_notify": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "is_section": true, "is_optional": true, "client_visibility": "show_when_map_created", "due_date_type": "before_target_launch_date", "due_date_days": 1, "due_date_enabled": true, "options_advanced": "string", "move_to": 1, "options": "string", "is_internal": true, "assign_to_owner": true, "estimated_time": 1, "estimated_time_unit": "minutes", "estimated_time_raw": 1, "time_tracking_enabled": true, "assign_to_role": "string", "assign_to_role_id": 1, "dependencies": [ "string" ], "category": "task", "embedded": "string", "embedded_url": "string", "embedded_option": "url", "embedded_panel_title": "string", "is_billable": true, "due_date_days_after_specific_task_completed_task_id": 1, "due_date_days_after_specific_task_due_task_id": 1, "embedded_url_merge_tag": "string", "is_ttv": true, "update_tasks": true, "update_tasks_notify": true } } } } } }, "/tasks/{id}/move": { "post": { "summary": "POST /tasks/{id}/move", "description": "POST operation for /tasks/{id}/move", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/tasks/exports": { "post": { "summary": "POST /tasks/exports", "description": "POST operation for /tasks/exports", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/tasks/imports": { "post": { "summary": "POST /tasks/imports", "description": "POST operation for /tasks/imports", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "description_preview": "string", "order": 1, "is_section": true, "is_optional": true, "client_visibility": "show_when_map_created", "due_date_type": "before_target_launch_date", "due_date_days": 1, "due_date_enabled": true, "options_advanced": "string", "created_at": "2021-01-01T00:00:00Z", "move_to": 1, "options": "string", "is_internal": true, "assign_to_owner": true, "estimated_time": 1, "estimated_time_unit": "minutes", "estimated_time_raw": 1, "forms": "string", "time_tracking_enabled": true, "assign_to_role": "string", "assign_to_role_id": 1, "dependencies": [ "string" ], "category": "task", "embedded": "string", "embedded_url": "string", "embedded_option": "url", "embedded_panel_title": "string", "modified_at": "2021-01-01T00:00:00Z", "map_types": "string", "map_types_ids": "string", "is_billable": true, "due_date_days_after_specific_task_completed_task_id": 1, "due_date_days_after_specific_task_completed_task": "string", "due_date_days_after_specific_task_due_task_id": 1, "due_date_days_after_specific_task_due_task": "string", "embedded_url_merge_tag": "string", "is_ttv": true, "update_tasks": true, "update_tasks_notify": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "is_section": true, "is_optional": true, "client_visibility": "show_when_map_created", "due_date_type": "before_target_launch_date", "due_date_days": 1, "due_date_enabled": true, "options_advanced": "string", "move_to": 1, "options": "string", "is_internal": true, "assign_to_owner": true, "estimated_time": 1, "estimated_time_unit": "minutes", "estimated_time_raw": 1, "time_tracking_enabled": true, "assign_to_role": "string", "assign_to_role_id": 1, "dependencies": [ "string" ], "category": "task", "embedded": "string", "embedded_url": "string", "embedded_option": "url", "embedded_panel_title": "string", "is_billable": true, "due_date_days_after_specific_task_completed_task_id": 1, "due_date_days_after_specific_task_due_task_id": 1, "embedded_url_merge_tag": "string", "is_ttv": true, "update_tasks": true, "update_tasks_notify": true } } } } } }, "/tasks/calendar/config": { "get": { "summary": "GET /tasks/calendar/config", "description": "GET operation for /tasks/calendar/config", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarEmbedConfigSerializer" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/my-tasks": { "get": { "summary": "GET /my-tasks", "description": "GET operation for /my-tasks", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MyTaskSerializer" }, "example": { "id": 1, "name": "string", "description_preview": "string", "due_date": "2021-01-01", "order": 1, "is_internal": true, "is_optional": true, "created_at": "2021-01-01T00:00:00Z", "map_id": 1, "map_uuid": "string", "map_name": "string", "map_status": "string", "map_expected_launch_date": "2021-01-01T00:00:00Z", "onboarder_company_slug": "string", "onboardee_company_name": "string", "onboardee_company_avatar": "string", "estimated_time": 1, "estimated_time_unit": "minutes", "estimated_time_raw": 1, "time_spent": 1, "time_spent_unit": "minutes", "time_spent_raw": 1, "external_id": "string", "time_tracking_enabled": true, "is_ttv": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/team-tasks": { "get": { "summary": "GET /team-tasks", "description": "GET operation for /team-tasks", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamTaskSerializer" }, "example": { "id": 1, "name": "string", "description_preview": "string", "due_date": "2021-01-01", "is_internal": true, "is_optional": true, "created_at": "2021-01-01T00:00:00Z", "map_id": 1, "map_name": "string", "map_status": "string", "map_expected_launch_date": "2021-01-01T00:00:00Z", "onboardee_company_name": "string", "onboardee_company_avatar": "string", "roadmap_id": "string", "roadmap_status": "string", "description": "string", "status": "open", "is_section": true, "is_hidden": true, "onboarder_user": "string", "onboarder_user_id": 1, "onboardee_user": "string", "onboardee_user_id": 1, "modified_at": "2021-01-01T00:00:00Z", "completed_at": "2021-01-01T00:00:00Z", "time_spent": 1, "time_spent_unit": "minutes", "time_spent_raw": 1, "external_id": "string", "time_tracking_enabled": true, "is_ttv": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/time-tracking/exports/{id}": { "get": { "summary": "GET /time-tracking/exports/{id}", "description": "GET operation for /time-tracking/exports/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/variables": { "get": { "summary": "GET /variables", "description": "GET operation for /variables", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariableSerializer" }, "example": { "id": 1, "name": "string", "type": "number", "tasks": 1, "options": "string", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "is_required": true, "message": "string", "map_types": "string", "order": 1 } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } }, "post": { "summary": "POST /variables", "description": "POST operation for /variables", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariableSerializer" }, "example": { "id": 1, "name": "string", "type": "number", "tasks": 1, "options": "string", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "is_required": true, "message": "string", "map_types": "string", "order": 1 } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariableSerializer" }, "example": { "name": "string", "type": "number", "options": "string", "is_required": true, "map_types": "string" } } } } } }, "/variables/{id}": { "get": { "summary": "GET /variables/{id}", "description": "GET operation for /variables/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariableSerializer" }, "example": { "id": 1, "name": "string", "type": "number", "tasks": 1, "options": "string", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "is_required": true, "message": "string", "map_types": "string", "order": 1 } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /variables/{id}", "description": "PUT operation for /variables/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariableSerializer" }, "example": { "id": 1, "name": "string", "type": "number", "tasks": 1, "options": "string", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "is_required": true, "message": "string", "map_types": "string", "order": 1 } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariableSerializer" }, "example": { "name": "string", "type": "number", "options": "string", "is_required": true, "map_types": "string" } } } } }, "delete": { "summary": "DELETE /variables/{id}", "description": "DELETE operation for /variables/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariableSerializer" }, "example": { "id": 1, "name": "string", "type": "number", "tasks": 1, "options": "string", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "is_required": true, "message": "string", "map_types": "string", "order": 1 } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /variables/{id}", "description": "PATCH operation for /variables/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariableSerializer" }, "example": { "id": 1, "name": "string", "type": "number", "tasks": 1, "options": "string", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "is_required": true, "message": "string", "map_types": "string", "order": 1 } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariableSerializer" }, "example": { "name": "string", "type": "number", "options": "string", "is_required": true, "map_types": "string" } } } } } }, "/map-types": { "get": { "summary": "GET /map-types", "description": "GET operation for /map-types", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapTypeSerializer" }, "example": { "id": 1, "type": "string", "description": "string", "is_default": true, "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } }, "post": { "summary": "POST /map-types", "description": "POST operation for /map-types", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapTypeSerializer" }, "example": { "id": 1, "type": "string", "description": "string", "is_default": true, "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapTypeSerializer" }, "example": { "type": "string", "description": "string", "is_default": true } } } } } }, "/map-types/{id}": { "get": { "summary": "GET /map-types/{id}", "description": "GET operation for /map-types/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapTypeSerializer" }, "example": { "id": 1, "type": "string", "description": "string", "is_default": true, "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /map-types/{id}", "description": "PUT operation for /map-types/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapTypeSerializer" }, "example": { "id": 1, "type": "string", "description": "string", "is_default": true, "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapTypeSerializer" }, "example": { "type": "string", "description": "string", "is_default": true } } } } }, "delete": { "summary": "DELETE /map-types/{id}", "description": "DELETE operation for /map-types/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapTypeSerializer" }, "example": { "id": 1, "type": "string", "description": "string", "is_default": true, "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /map-types/{id}", "description": "PATCH operation for /map-types/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapTypeSerializer" }, "example": { "id": 1, "type": "string", "description": "string", "is_default": true, "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapTypeSerializer" }, "example": { "type": "string", "description": "string", "is_default": true } } } } } }, "/project-types": { "get": { "summary": "GET /project-types", "description": "GET operation for /project-types", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapTypeSerializer" }, "example": { "id": 1, "type": "string", "description": "string", "is_default": true, "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } }, "post": { "summary": "POST /project-types", "description": "POST operation for /project-types", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapTypeSerializer" }, "example": { "id": 1, "type": "string", "description": "string", "is_default": true, "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapTypeSerializer" }, "example": { "type": "string", "description": "string", "is_default": true } } } } } }, "/project-types/{id}": { "get": { "summary": "GET /project-types/{id}", "description": "GET operation for /project-types/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapTypeSerializer" }, "example": { "id": 1, "type": "string", "description": "string", "is_default": true, "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /project-types/{id}", "description": "PUT operation for /project-types/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapTypeSerializer" }, "example": { "id": 1, "type": "string", "description": "string", "is_default": true, "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapTypeSerializer" }, "example": { "type": "string", "description": "string", "is_default": true } } } } }, "delete": { "summary": "DELETE /project-types/{id}", "description": "DELETE operation for /project-types/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapTypeSerializer" }, "example": { "id": 1, "type": "string", "description": "string", "is_default": true, "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /project-types/{id}", "description": "PATCH operation for /project-types/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapTypeSerializer" }, "example": { "id": 1, "type": "string", "description": "string", "is_default": true, "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapTypeSerializer" }, "example": { "type": "string", "description": "string", "is_default": true } } } } } }, "/project-assets": { "get": { "summary": "GET /project-assets", "description": "GET operation for /project-assets", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectAssetSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "file": "binary-file-placeholder", "file_url": "binary-file-placeholder", "file_type": "string", "file_size": 1, "link": "https://example.com", "link_label": "string", "content_type": "string", "content_type_name": "string", "object_id": 1, "onboarder_user": "string", "onboarder_user_id": 1, "onboardee_user": "string", "onboardee_user_id": 1, "include_in_outboard": true, "order": 1, "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "created_by": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } }, "post": { "summary": "POST /project-assets", "description": "POST operation for /project-assets", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectAssetSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "file": "binary-file-placeholder", "file_url": "binary-file-placeholder", "file_type": "string", "file_size": 1, "link": "https://example.com", "link_label": "string", "content_type": "string", "content_type_name": "string", "object_id": 1, "onboarder_user": "string", "onboarder_user_id": 1, "onboardee_user": "string", "onboardee_user_id": 1, "include_in_outboard": true, "order": 1, "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "created_by": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectAssetSerializer" }, "example": { "name": "string", "description": "string", "file": "binary-file-placeholder", "link": "https://example.com", "link_label": "string", "content_type": "string", "object_id": 1, "onboarder_user_id": 1, "onboardee_user_id": 1, "include_in_outboard": true, "order": 1 } } } } } }, "/project-assets/{id}": { "get": { "summary": "GET /project-assets/{id}", "description": "GET operation for /project-assets/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectAssetSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "file": "binary-file-placeholder", "file_url": "binary-file-placeholder", "file_type": "string", "file_size": 1, "link": "https://example.com", "link_label": "string", "content_type": "string", "content_type_name": "string", "object_id": 1, "onboarder_user": "string", "onboarder_user_id": 1, "onboardee_user": "string", "onboardee_user_id": 1, "include_in_outboard": true, "order": 1, "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "created_by": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /project-assets/{id}", "description": "PUT operation for /project-assets/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectAssetSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "file": "binary-file-placeholder", "file_url": "binary-file-placeholder", "file_type": "string", "file_size": 1, "link": "https://example.com", "link_label": "string", "content_type": "string", "content_type_name": "string", "object_id": 1, "onboarder_user": "string", "onboarder_user_id": 1, "onboardee_user": "string", "onboardee_user_id": 1, "include_in_outboard": true, "order": 1, "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "created_by": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectAssetSerializer" }, "example": { "name": "string", "description": "string", "file": "binary-file-placeholder", "link": "https://example.com", "link_label": "string", "content_type": "string", "object_id": 1, "onboarder_user_id": 1, "onboardee_user_id": 1, "include_in_outboard": true, "order": 1 } } } } }, "delete": { "summary": "DELETE /project-assets/{id}", "description": "DELETE operation for /project-assets/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectAssetSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "file": "binary-file-placeholder", "file_url": "binary-file-placeholder", "file_type": "string", "file_size": 1, "link": "https://example.com", "link_label": "string", "content_type": "string", "content_type_name": "string", "object_id": 1, "onboarder_user": "string", "onboarder_user_id": 1, "onboardee_user": "string", "onboardee_user_id": 1, "include_in_outboard": true, "order": 1, "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "created_by": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /project-assets/{id}", "description": "PATCH operation for /project-assets/{id}", "tags": [ "Map" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectAssetSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "file": "binary-file-placeholder", "file_url": "binary-file-placeholder", "file_type": "string", "file_size": 1, "link": "https://example.com", "link_label": "string", "content_type": "string", "content_type_name": "string", "object_id": 1, "onboarder_user": "string", "onboarder_user_id": 1, "onboardee_user": "string", "onboardee_user_id": 1, "include_in_outboard": true, "order": 1, "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "created_by": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectAssetSerializer" }, "example": { "name": "string", "description": "string", "file": "binary-file-placeholder", "link": "https://example.com", "link_label": "string", "content_type": "string", "object_id": 1, "onboarder_user_id": 1, "onboardee_user_id": 1, "include_in_outboard": true, "order": 1 } } } } } }, "/dashboard/summary": { "get": { "summary": "GET /dashboard/summary", "description": "GET operation for /dashboard/summary", "tags": [ "Stats" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/dashboard/kpis": { "get": { "summary": "GET /dashboard/kpis", "description": "GET operation for /dashboard/kpis", "tags": [ "Stats" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/dashboard/kpis/detail": { "get": { "summary": "GET /dashboard/kpis/detail", "description": "GET operation for /dashboard/kpis/detail", "tags": [ "Stats" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/dashboard/kpis/export": { "get": { "summary": "GET /dashboard/kpis/export", "description": "GET operation for /dashboard/kpis/export", "tags": [ "Stats" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/dashboard/graph/active-maps": { "get": { "summary": "GET /dashboard/graph/active-maps", "description": "GET operation for /dashboard/graph/active-maps", "tags": [ "Stats" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/dashboard/map-owners": { "get": { "summary": "GET /dashboard/map-owners", "description": "GET operation for /dashboard/map-owners", "tags": [ "Stats" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardMapOwnersSerializer" }, "example": { "count_maps": 1, "id": 1, "first_name": "string", "last_name": "string", "name": "string", "email": "string", "avatar": "string", "created_at": "2021-01-01T00:00:00Z", "invited_at": "2021-01-01T00:00:00Z", "last_login": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/dashboard/configurations": { "get": { "summary": "GET /dashboard/configurations", "description": "GET operation for /dashboard/configurations", "tags": [ "Stats" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardConfigurationSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "type": "string", "type_display": "string", "type_code": "string", "type_details": "string", "is_default": true, "is_template": true, "configuration": {}, "created_by": "string", "created_by_name": "string", "updated_by": "string", "updated_by_name": "string", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } }, "post": { "summary": "POST /dashboard/configurations", "description": "POST operation for /dashboard/configurations", "tags": [ "Stats" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardConfigurationSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "type": "string", "type_display": "string", "type_code": "string", "type_details": "string", "is_default": true, "is_template": true, "configuration": {}, "created_by": "string", "created_by_name": "string", "updated_by": "string", "updated_by_name": "string", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardConfigurationSerializer" }, "example": { "name": "string", "description": "string", "type": "string", "is_default": true, "is_template": true, "configuration": {}, "created_by": "string", "updated_by": "string" } } } } } }, "/dashboard/configurations/{id}": { "get": { "summary": "GET /dashboard/configurations/{id}", "description": "GET operation for /dashboard/configurations/{id}", "tags": [ "Stats" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardConfigurationSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "type": "string", "type_display": "string", "type_code": "string", "type_details": "string", "is_default": true, "is_template": true, "configuration": {}, "created_by": "string", "created_by_name": "string", "updated_by": "string", "updated_by_name": "string", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /dashboard/configurations/{id}", "description": "PUT operation for /dashboard/configurations/{id}", "tags": [ "Stats" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardConfigurationSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "type": "string", "type_display": "string", "type_code": "string", "type_details": "string", "is_default": true, "is_template": true, "configuration": {}, "created_by": "string", "created_by_name": "string", "updated_by": "string", "updated_by_name": "string", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardConfigurationSerializer" }, "example": { "name": "string", "description": "string", "type": "string", "is_default": true, "is_template": true, "configuration": {}, "created_by": "string", "updated_by": "string" } } } } }, "delete": { "summary": "DELETE /dashboard/configurations/{id}", "description": "DELETE operation for /dashboard/configurations/{id}", "tags": [ "Stats" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardConfigurationSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "type": "string", "type_display": "string", "type_code": "string", "type_details": "string", "is_default": true, "is_template": true, "configuration": {}, "created_by": "string", "created_by_name": "string", "updated_by": "string", "updated_by_name": "string", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /dashboard/configurations/{id}", "description": "PATCH operation for /dashboard/configurations/{id}", "tags": [ "Stats" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardConfigurationSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "type": "string", "type_display": "string", "type_code": "string", "type_details": "string", "is_default": true, "is_template": true, "configuration": {}, "created_by": "string", "created_by_name": "string", "updated_by": "string", "updated_by_name": "string", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardConfigurationSerializer" }, "example": { "name": "string", "description": "string", "type": "string", "is_default": true, "is_template": true, "configuration": {}, "created_by": "string", "updated_by": "string" } } } } } }, "/dashboard/configurations/{id}/set-default": { "post": { "summary": "POST /dashboard/configurations/{id}/set-default", "description": "POST operation for /dashboard/configurations/{id}/set-default", "tags": [ "Stats" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/dashboard/configurations/type/{config_type}": { "get": { "summary": "GET /dashboard/configurations/type/{config_type}", "description": "GET operation for /dashboard/configurations/type/{config_type}", "tags": [ "Stats" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardConfigurationSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "type": "string", "type_display": "string", "type_code": "string", "type_details": "string", "is_default": true, "is_template": true, "configuration": {}, "created_by": "string", "created_by_name": "string", "updated_by": "string", "updated_by_name": "string", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "config_type", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/dashboard/configuration-types": { "get": { "summary": "GET /dashboard/configuration-types", "description": "GET operation for /dashboard/configuration-types", "tags": [ "Stats" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardConfigurationTypeSerializer" }, "example": { "id": 1, "name": "string", "code": "string", "description": "string", "is_active": true, "is_template": true } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/dashboard/templates": { "get": { "summary": "GET /dashboard/templates", "description": "GET operation for /dashboard/templates", "tags": [ "Stats" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardConfigurationTemplateSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "type": "string", "type_display": "string", "type_code": "string", "type_details": "string", "is_template": true, "configuration": {}, "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/dashboard/templates/type/{config_type}": { "get": { "summary": "GET /dashboard/templates/type/{config_type}", "description": "GET operation for /dashboard/templates/type/{config_type}", "tags": [ "Stats" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardConfigurationTemplateSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "type": "string", "type_display": "string", "type_code": "string", "type_details": "string", "is_template": true, "configuration": {}, "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "config_type", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/dashboard/templates/{template_id}/create-from": { "post": { "summary": "POST /dashboard/templates/{template_id}/create-from", "description": "POST operation for /dashboard/templates/{template_id}/create-from", "tags": [ "Stats" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardConfigurationCreateSerializer" }, "example": { "name": "string", "description": "string", "type": "string", "is_default": true, "is_template": true, "configuration": {} } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "template_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardConfigurationCreateSerializer" }, "example": { "name": "string", "description": "string", "type": "string", "is_default": true, "is_template": true, "configuration": {} } } } } } }, "/dashboard/metric-thresholds": { "get": { "summary": "GET /dashboard/metric-thresholds", "description": "GET operation for /dashboard/metric-thresholds", "tags": [ "Stats" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricThresholdSerializer" }, "example": { "id": 1, "onboarder_company": "string", "metric_key": "time_to_launch", "metric_key_display": "string", "target_value": 1, "good_value": 1, "risk_value": 1, "target_operator": "lt", "good_operator": "lt", "risk_operator": "lt", "description": "string", "context": "string", "created_by": "string", "created_by_name": "string", "updated_by": "string", "updated_by_name": "string", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } }, "post": { "summary": "POST /dashboard/metric-thresholds", "description": "POST operation for /dashboard/metric-thresholds", "tags": [ "Stats" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricThresholdSerializer" }, "example": { "id": 1, "onboarder_company": "string", "metric_key": "time_to_launch", "metric_key_display": "string", "target_value": 1, "good_value": 1, "risk_value": 1, "target_operator": "lt", "good_operator": "lt", "risk_operator": "lt", "description": "string", "context": "string", "created_by": "string", "created_by_name": "string", "updated_by": "string", "updated_by_name": "string", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricThresholdSerializer" }, "example": { "onboarder_company": "string", "metric_key": "time_to_launch", "target_value": 1, "good_value": 1, "risk_value": 1, "target_operator": "lt", "good_operator": "lt", "risk_operator": "lt", "description": "string", "context": "string", "created_by": "string", "updated_by": "string" } } } } } }, "/dashboard/metric-thresholds/initialize": { "post": { "summary": "POST /dashboard/metric-thresholds/initialize", "description": "POST operation for /dashboard/metric-thresholds/initialize", "tags": [ "Stats" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/dashboard/metric-thresholds/{id}": { "get": { "summary": "GET /dashboard/metric-thresholds/{id}", "description": "GET operation for /dashboard/metric-thresholds/{id}", "tags": [ "Stats" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricThresholdSerializer" }, "example": { "id": 1, "onboarder_company": "string", "metric_key": "time_to_launch", "metric_key_display": "string", "target_value": 1, "good_value": 1, "risk_value": 1, "target_operator": "lt", "good_operator": "lt", "risk_operator": "lt", "description": "string", "context": "string", "created_by": "string", "created_by_name": "string", "updated_by": "string", "updated_by_name": "string", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /dashboard/metric-thresholds/{id}", "description": "PUT operation for /dashboard/metric-thresholds/{id}", "tags": [ "Stats" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricThresholdSerializer" }, "example": { "id": 1, "onboarder_company": "string", "metric_key": "time_to_launch", "metric_key_display": "string", "target_value": 1, "good_value": 1, "risk_value": 1, "target_operator": "lt", "good_operator": "lt", "risk_operator": "lt", "description": "string", "context": "string", "created_by": "string", "created_by_name": "string", "updated_by": "string", "updated_by_name": "string", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricThresholdSerializer" }, "example": { "onboarder_company": "string", "metric_key": "time_to_launch", "target_value": 1, "good_value": 1, "risk_value": 1, "target_operator": "lt", "good_operator": "lt", "risk_operator": "lt", "description": "string", "context": "string", "created_by": "string", "updated_by": "string" } } } } }, "delete": { "summary": "DELETE /dashboard/metric-thresholds/{id}", "description": "DELETE operation for /dashboard/metric-thresholds/{id}", "tags": [ "Stats" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricThresholdSerializer" }, "example": { "id": 1, "onboarder_company": "string", "metric_key": "time_to_launch", "metric_key_display": "string", "target_value": 1, "good_value": 1, "risk_value": 1, "target_operator": "lt", "good_operator": "lt", "risk_operator": "lt", "description": "string", "context": "string", "created_by": "string", "created_by_name": "string", "updated_by": "string", "updated_by_name": "string", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /dashboard/metric-thresholds/{id}", "description": "PATCH operation for /dashboard/metric-thresholds/{id}", "tags": [ "Stats" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricThresholdSerializer" }, "example": { "id": 1, "onboarder_company": "string", "metric_key": "time_to_launch", "metric_key_display": "string", "target_value": 1, "good_value": 1, "risk_value": 1, "target_operator": "lt", "good_operator": "lt", "risk_operator": "lt", "description": "string", "context": "string", "created_by": "string", "created_by_name": "string", "updated_by": "string", "updated_by_name": "string", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricThresholdSerializer" }, "example": { "onboarder_company": "string", "metric_key": "time_to_launch", "target_value": 1, "good_value": 1, "risk_value": 1, "target_operator": "lt", "good_operator": "lt", "risk_operator": "lt", "description": "string", "context": "string", "created_by": "string", "updated_by": "string" } } } } } }, "/dashboard/metric-thresholds/{id}/history": { "get": { "summary": "GET /dashboard/metric-thresholds/{id}/history", "description": "GET operation for /dashboard/metric-thresholds/{id}/history", "tags": [ "Stats" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/dashboard/metric-thresholds/metric/{metric_key}": { "get": { "summary": "GET /dashboard/metric-thresholds/metric/{metric_key}", "description": "GET operation for /dashboard/metric-thresholds/metric/{metric_key}", "tags": [ "Stats" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetricThresholdSerializer" }, "example": { "id": 1, "onboarder_company": "string", "metric_key": "time_to_launch", "metric_key_display": "string", "target_value": 1, "good_value": 1, "risk_value": 1, "target_operator": "lt", "good_operator": "lt", "risk_operator": "lt", "description": "string", "context": "string", "created_by": "string", "created_by_name": "string", "updated_by": "string", "updated_by_name": "string", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "metric_key", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/workflows": { "get": { "summary": "GET /workflows", "description": "GET operation for /workflows", "tags": [ "Workflows" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowSerializer" }, "example": { "id": 1, "name": "string", "workflow_type": "quick_action", "workflow_actions": "string", "workflow_actions_display": "string", "trigger": "map-created", "trigger_display": "string", "internal_description": "string", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "created_by": "string", "button_color": "string", "button_placement": "map", "button_title": "string", "is_enabled": true, "filters": {}, "filters_rql": "string", "workflow_events": "string", "is_hidden": true, "schedule_type": "daily", "schedule_day": 1, "schedule_time": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } }, "post": { "summary": "POST /workflows", "description": "POST operation for /workflows", "tags": [ "Workflows" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowSerializer" }, "example": { "id": 1, "name": "string", "workflow_type": "quick_action", "workflow_actions": "string", "workflow_actions_display": "string", "trigger": "map-created", "trigger_display": "string", "internal_description": "string", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "created_by": "string", "button_color": "string", "button_placement": "map", "button_title": "string", "is_enabled": true, "filters": {}, "filters_rql": "string", "workflow_events": "string", "is_hidden": true, "schedule_type": "daily", "schedule_day": 1, "schedule_time": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowSerializer" }, "example": { "name": "string", "workflow_type": "quick_action", "workflow_actions": "string", "trigger": "map-created", "internal_description": "string", "button_color": "string", "button_placement": "map", "button_title": "string", "is_enabled": true, "filters": {}, "filters_rql": "string", "is_hidden": true, "schedule_type": "daily", "schedule_day": 1, "schedule_time": "string" } } } } } }, "/workflows/{id}": { "get": { "summary": "GET /workflows/{id}", "description": "GET operation for /workflows/{id}", "tags": [ "Workflows" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowSerializer" }, "example": { "id": 1, "name": "string", "workflow_type": "quick_action", "workflow_actions": "string", "workflow_actions_display": "string", "trigger": "map-created", "trigger_display": "string", "internal_description": "string", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "created_by": "string", "button_color": "string", "button_placement": "map", "button_title": "string", "is_enabled": true, "filters": {}, "filters_rql": "string", "workflow_events": "string", "is_hidden": true, "schedule_type": "daily", "schedule_day": 1, "schedule_time": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /workflows/{id}", "description": "PUT operation for /workflows/{id}", "tags": [ "Workflows" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowSerializer" }, "example": { "id": 1, "name": "string", "workflow_type": "quick_action", "workflow_actions": "string", "workflow_actions_display": "string", "trigger": "map-created", "trigger_display": "string", "internal_description": "string", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "created_by": "string", "button_color": "string", "button_placement": "map", "button_title": "string", "is_enabled": true, "filters": {}, "filters_rql": "string", "workflow_events": "string", "is_hidden": true, "schedule_type": "daily", "schedule_day": 1, "schedule_time": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowSerializer" }, "example": { "name": "string", "workflow_type": "quick_action", "workflow_actions": "string", "trigger": "map-created", "internal_description": "string", "button_color": "string", "button_placement": "map", "button_title": "string", "is_enabled": true, "filters": {}, "filters_rql": "string", "is_hidden": true, "schedule_type": "daily", "schedule_day": 1, "schedule_time": "string" } } } } }, "delete": { "summary": "DELETE /workflows/{id}", "description": "DELETE operation for /workflows/{id}", "tags": [ "Workflows" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowSerializer" }, "example": { "id": 1, "name": "string", "workflow_type": "quick_action", "workflow_actions": "string", "workflow_actions_display": "string", "trigger": "map-created", "trigger_display": "string", "internal_description": "string", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "created_by": "string", "button_color": "string", "button_placement": "map", "button_title": "string", "is_enabled": true, "filters": {}, "filters_rql": "string", "workflow_events": "string", "is_hidden": true, "schedule_type": "daily", "schedule_day": 1, "schedule_time": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /workflows/{id}", "description": "PATCH operation for /workflows/{id}", "tags": [ "Workflows" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowSerializer" }, "example": { "id": 1, "name": "string", "workflow_type": "quick_action", "workflow_actions": "string", "workflow_actions_display": "string", "trigger": "map-created", "trigger_display": "string", "internal_description": "string", "created_at": "2021-01-01T00:00:00Z", "modified_at": "2021-01-01T00:00:00Z", "created_by": "string", "button_color": "string", "button_placement": "map", "button_title": "string", "is_enabled": true, "filters": {}, "filters_rql": "string", "workflow_events": "string", "is_hidden": true, "schedule_type": "daily", "schedule_day": 1, "schedule_time": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowSerializer" }, "example": { "name": "string", "workflow_type": "quick_action", "workflow_actions": "string", "trigger": "map-created", "internal_description": "string", "button_color": "string", "button_placement": "map", "button_title": "string", "is_enabled": true, "filters": {}, "filters_rql": "string", "is_hidden": true, "schedule_type": "daily", "schedule_day": 1, "schedule_time": "string" } } } } } }, "/workflows/{id}/to-json": { "get": { "summary": "GET /workflows/{id}/to-json", "description": "GET operation for /workflows/{id}/to-json", "tags": [ "Workflows" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/workflows/{id}/run": { "post": { "summary": "POST /workflows/{id}/run", "description": "POST operation for /workflows/{id}/run", "tags": [ "Workflows" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/workflows/{id}/actions": { "get": { "summary": "GET /workflows/{id}/actions", "description": "GET operation for /workflows/{id}/actions", "tags": [ "Workflows" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowActionSerializer" }, "example": { "id": 1, "action_type": "send_email", "action_type_display": "string", "config": {}, "trigger": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /workflows/{id}/actions", "description": "POST operation for /workflows/{id}/actions", "tags": [ "Workflows" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowActionSerializer" }, "example": { "id": 1, "action_type": "send_email", "action_type_display": "string", "config": {}, "trigger": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowActionSerializer" }, "example": { "action_type": "send_email", "config": {}, "trigger": "string" } } } } } }, "/workflows/{id}/actions/{id}": { "get": { "summary": "GET /workflows/{id}/actions/{id}", "description": "GET operation for /workflows/{id}/actions/{id}", "tags": [ "Workflows" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowActionSerializer" }, "example": { "id": 1, "action_type": "send_email", "action_type_display": "string", "config": {}, "trigger": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /workflows/{id}/actions/{id}", "description": "PUT operation for /workflows/{id}/actions/{id}", "tags": [ "Workflows" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowActionSerializer" }, "example": { "id": 1, "action_type": "send_email", "action_type_display": "string", "config": {}, "trigger": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowActionSerializer" }, "example": { "action_type": "send_email", "config": {}, "trigger": "string" } } } } }, "delete": { "summary": "DELETE /workflows/{id}/actions/{id}", "description": "DELETE operation for /workflows/{id}/actions/{id}", "tags": [ "Workflows" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowActionSerializer" }, "example": { "id": 1, "action_type": "send_email", "action_type_display": "string", "config": {}, "trigger": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /workflows/{id}/actions/{id}", "description": "PATCH operation for /workflows/{id}/actions/{id}", "tags": [ "Workflows" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowActionSerializer" }, "example": { "id": 1, "action_type": "send_email", "action_type_display": "string", "config": {}, "trigger": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowActionSerializer" }, "example": { "action_type": "send_email", "config": {}, "trigger": "string" } } } } } }, "/workflows/filters/options": { "get": { "summary": "GET /workflows/filters/options", "description": "GET operation for /workflows/filters/options", "tags": [ "Workflows" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/workflows/history": { "get": { "summary": "GET /workflows/history", "description": "GET operation for /workflows/history", "tags": [ "Workflows" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowActivitySerializer" }, "example": { "id": 1, "created_at": "2021-01-01T00:00:00Z", "run_at": "2021-01-01T00:00:00Z", "is_complete": true, "workflow": "string", "onboarder_company": "string", "onboarder_user": "string", "roadmap": "string", "task": "string", "actions": {}, "metadata": {}, "status": "success" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/workflows/quick-actions": { "get": { "summary": "GET /workflows/quick-actions", "description": "GET operation for /workflows/quick-actions", "tags": [ "Workflows" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowQuickActionSerializer" }, "example": { "id": 1, "name": "string", "last_run_date": "string", "workflow_type": "quick_action", "workflow_actions": "string", "workflow_actions_display": "string", "trigger": "map-created", "trigger_display": "string", "internal_description": "string", "button_color": "string", "button_placement": "map", "button_title": "string", "is_enabled": true, "filters": {} } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/workflows/categories": { "get": { "summary": "GET /workflows/categories", "description": "GET operation for /workflows/categories", "tags": [ "Workflows" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowCategorySerializer" }, "example": { "id": 1, "created_at": "2021-01-01T00:00:00Z", "name": "string", "description": "string", "workflow_recipes": "string", "color": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/workflows/recipes": { "get": { "summary": "GET /workflows/recipes", "description": "GET operation for /workflows/recipes", "tags": [ "Workflows" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRecipeSerializer" }, "example": { "id": 1, "name": "string", "description": "string", "created_at": "2021-01-01T00:00:00Z", "config": {}, "object": "customer", "is_visible": true, "category_id": "string", "instructions": "string", "icon": "activity", "color": "string" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } }, "/workflows/ai/generate": { "post": { "summary": "POST /workflows/ai/generate", "description": "POST operation for /workflows/ai/generate", "tags": [ "Workflows" ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not found" } } } } }, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "API key authentication. Format: Your API key (no \"Token\" prefix needed)" } }, "schemas": { "APIMemberSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "first_name": { "type": "string" }, "name": { "type": "string", "readOnly": true }, "account_type": { "type": "string", "readOnly": true, "enum": [ "admin", "manager", "coordinator", "onboarder", "contributor", "view_only", "api" ], "x-onboard-source": "serializer-or-model-choices" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true }, "invited_at": { "type": "string", "format": "date-time", "readOnly": true }, "status": { "type": "string", "readOnly": true, "enum": [ "active", "deactivated", "invited", "expired" ], "x-onboard-source": "serializer-or-model-choices" }, "token": { "type": "string", "readOnly": true }, "regenerate_token": { "type": "boolean" } } }, "OnboardeeCompanyDetailSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string" }, "website": { "type": "string" }, "uuid": { "type": "string" }, "avatar": { "type": "string", "readOnly": true }, "logos": { "type": "string", "readOnly": true }, "icon": { "type": "string", "format": "binary" }, "icon_delete": { "type": "boolean" }, "icon_base64": { "type": "object" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true }, "created_by": { "type": "string", "readOnly": true }, "external_id": { "type": "string" }, "sf_account_id": { "type": "string" }, "hubspot_company_id": { "type": "integer" }, "custom": { "type": "string" } }, "required": [ "name" ] }, "OnboardeeUserBasicSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "first_name": { "type": "string", "readOnly": true }, "last_name": { "type": "string", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "email": { "type": "string", "readOnly": true }, "avatar": { "type": "string", "readOnly": true }, "external_id": { "type": "string" }, "last_login": { "type": "string", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true } } }, "OnboardeeUserByEmailSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "first_name": { "type": "string", "readOnly": true }, "last_name": { "type": "string", "readOnly": true }, "email": { "type": "string", "readOnly": true }, "avatar": { "type": "string", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "invited_at": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "active", "deactivated" ], "x-onboard-source": "serializer-or-model-choices" }, "external_id": { "type": "string" }, "role": { "type": "string" }, "last_login": { "type": "string", "readOnly": true }, "onboardee_company": { "type": "string" } }, "required": [ "status", "external_id", "onboardee_company" ] }, "OnboardeeUserNotificationsSerializer": { "type": "object", "properties": { "task_due_date_changed": { "type": "boolean" }, "task_due_date_reminders": { "type": "boolean" }, "task_overdue": { "type": "boolean" }, "discussion_mentions": { "type": "boolean" }, "discussion_daily_digest": { "type": "boolean" }, "task_summary_onboardee": { "type": "boolean" } } }, "OnboardeeUserSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string", "format": "email" }, "avatar": { "type": "string", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "profile": { "type": "string", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "invited_at": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "active", "deactivated" ], "x-onboard-source": "serializer-or-model-choices" }, "external_id": { "type": "string" }, "role": { "type": "string" }, "last_login": { "type": "string", "readOnly": true }, "onboardee_company": { "type": "string", "readOnly": true } }, "required": [ "first_name", "last_name", "email", "status", "external_id" ] }, "OnboarderCompanyAccountSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "company_name": { "type": "string" }, "slug": { "type": "string" }, "domain": { "type": "string" }, "uuid": { "type": "string", "readOnly": true }, "is_active": { "type": "boolean" }, "settings": { "type": "string" }, "outboard_logo_img": { "type": "string", "format": "binary" }, "outboard_logo": { "type": "string", "readOnly": true }, "icon": { "type": "string", "format": "binary" }, "avatar_img": { "type": "string", "format": "binary" }, "avatar": { "type": "string", "readOnly": true }, "logos": { "type": "string", "readOnly": true }, "outboard_logo_delete": { "type": "boolean" }, "avatar_delete": { "type": "boolean" }, "is_ai_enabled": { "type": "boolean" }, "auto_update_enabled": { "type": "boolean" }, "stalled_status_threshold": { "type": "integer" }, "chatbot_enabled": { "type": "boolean" }, "default_api_key": { "type": "string", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "first_roadmap_created_at": { "type": "string", "readOnly": true }, "address": { "type": "string", "readOnly": true }, "has_variables": { "type": "string", "readOnly": true }, "has_tasks": { "type": "string", "readOnly": true }, "has_project_templates": { "type": "string", "readOnly": true }, "has_custom_sending_domain": { "type": "string", "readOnly": true }, "has_slack": { "type": "string", "readOnly": true }, "payment_subscription_id": { "type": "string", "readOnly": true }, "payment_customer_id": { "type": "string", "readOnly": true }, "trial_end_date": { "type": "string", "format": "date", "readOnly": true }, "is_trialing": { "type": "string", "readOnly": true }, "terms_acceptance": { "type": "string", "readOnly": true }, "outboard_settings": { "type": "string" }, "internal": { "type": "boolean", "readOnly": true } }, "required": [ "company_name", "domain", "settings" ] }, "OnboarderCompanyAddressSerializer": { "type": "object", "properties": {} }, "OnboarderUserNotificationsSerializer": { "type": "object", "properties": { "roadmap_status_updates": { "type": "boolean" }, "task_due_date_changed": { "type": "boolean" }, "task_due_date_reminders": { "type": "boolean" }, "task_overdue": { "type": "boolean" }, "discussion_mentions": { "type": "boolean" }, "discussion_daily_digest": { "type": "boolean" }, "task_summary": { "type": "boolean" } } }, "RoleSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string" }, "description": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "role_type": { "type": "string", "enum": [ "internal", "external" ], "x-onboard-source": "serializer-or-model-choices" }, "order": { "type": "integer", "readOnly": true }, "created_by": { "type": "string", "readOnly": true } }, "required": [ "name", "role_type" ] }, "SSOSettingsSerializer": { "type": "object", "properties": {} }, "TeamMemberRequestsSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string", "format": "email" }, "role": { "type": "string" }, "account_type": { "type": "string", "enum": [ "admin", "manager", "coordinator", "onboarder", "contributor", "view_only", "api" ], "x-onboard-source": "serializer-or-model-choices" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true }, "invited_at": { "type": "string", "format": "date-time", "readOnly": true }, "status": { "type": "string", "readOnly": true, "enum": [ "active", "deactivated", "invited", "expired", "requested" ], "x-onboard-source": "serializer-or-model-choices" }, "external_id": { "type": "string" } }, "required": [ "first_name", "last_name", "email", "account_type" ] }, "TeamMemberSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "name": { "type": "string", "readOnly": true }, "email": { "type": "string", "format": "email" }, "role": { "type": "string" }, "account_type": { "type": "string", "enum": [ "admin", "manager", "coordinator", "onboarder", "contributor", "view_only", "api" ], "x-onboard-source": "serializer-or-model-choices" }, "avatar": { "type": "string", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true }, "invited_at": { "type": "string", "format": "date-time", "readOnly": true }, "status": { "type": "string", "readOnly": true, "enum": [ "active", "deactivated", "invited", "expired" ], "x-onboard-source": "serializer-or-model-choices" }, "external_id": { "type": "string" }, "last_login": { "type": "string", "readOnly": true }, "slack_member_id": { "type": "string" }, "roles": { "type": "string" }, "role_ids": { "type": "array", "items": { "type": "string" } }, "features": { "type": "object" }, "fora_id": { "type": "string", "readOnly": true }, "meeting_insights": { "type": "boolean", "description": "Enables Meeting Insights feature" }, "custom": { "type": "string" } }, "required": [ "first_name", "last_name", "email", "account_type" ] }, "TermsAcceptanceSerializer": { "type": "object", "properties": {} }, "ModelEnum_api_root_HistoricalOnboardeeCompany_status": { "description": "Allowed stored values for Django model `HistoricalOnboardeeCompany.status` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "launched", "stalled", "new" ] }, "ModelEnum_api_root_HistoricalOnboardeeCompany_history_type": { "description": "Allowed stored values for Django model `HistoricalOnboardeeCompany.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_api_root_OnboardeeCompany_status": { "description": "Allowed stored values for Django model `OnboardeeCompany.status` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "launched", "stalled", "new" ] }, "ModelEnum_api_root_HistoricalOnboardeeUser_status": { "description": "Allowed stored values for Django model `HistoricalOnboardeeUser.status` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "active", "deactivated" ] }, "ModelEnum_api_root_HistoricalOnboardeeUser_history_type": { "description": "Allowed stored values for Django model `HistoricalOnboardeeUser.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_api_root_OnboardeeUser_status": { "description": "Allowed stored values for Django model `OnboardeeUser.status` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "active", "deactivated" ] }, "ModelEnum_api_root_HistoricalOnboarderCompany_history_type": { "description": "Allowed stored values for Django model `HistoricalOnboarderCompany.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_api_root_HistoricalDefaultChoice_history_type": { "description": "Allowed stored values for Django model `HistoricalDefaultChoice.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_api_root_HistoricalCustomChoice_history_type": { "description": "Allowed stored values for Django model `HistoricalCustomChoice.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_api_root_HistoricalOnboarderCompanySettings_default_project_view": { "description": "Allowed stored values for Django model `HistoricalOnboarderCompanySettings.default_project_view` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "dashboard", "table", "gantt" ] }, "ModelEnum_api_root_HistoricalOnboarderCompanySettings_history_type": { "description": "Allowed stored values for Django model `HistoricalOnboarderCompanySettings.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_api_root_OnboarderCompanySettings_default_project_view": { "description": "Allowed stored values for Django model `OnboarderCompanySettings.default_project_view` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "dashboard", "table", "gantt" ] }, "ModelEnum_api_root_HistoricalOnboarderTeam_history_type": { "description": "Allowed stored values for Django model `HistoricalOnboarderTeam.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_api_root_HistoricalOnboarderTeamMembers_history_type": { "description": "Allowed stored values for Django model `HistoricalOnboarderTeamMembers.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_api_root_HistoricalOnboarderUser_account_type": { "description": "Allowed stored values for Django model `HistoricalOnboarderUser.account_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "admin", "manager", "coordinator", "onboarder", "contributor", "view_only", "api" ] }, "ModelEnum_api_root_HistoricalOnboarderUser_status": { "description": "Allowed stored values for Django model `HistoricalOnboarderUser.status` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "active", "deactivated", "invited", "expired" ] }, "ModelEnum_api_root_HistoricalOnboarderUser_history_type": { "description": "Allowed stored values for Django model `HistoricalOnboarderUser.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_api_root_OnboarderUser_account_type": { "description": "Allowed stored values for Django model `OnboarderUser.account_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "admin", "manager", "coordinator", "onboarder", "contributor", "view_only", "api" ] }, "ModelEnum_api_root_OnboarderUser_status": { "description": "Allowed stored values for Django model `OnboarderUser.status` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "active", "deactivated", "invited", "expired" ] }, "ModelEnum_api_root_HistoricalOnboardRole_role_type": { "description": "Allowed stored values for Django model `HistoricalOnboardRole.role_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "internal", "external" ] }, "ModelEnum_api_root_HistoricalOnboardRole_history_type": { "description": "Allowed stored values for Django model `HistoricalOnboardRole.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_api_root_OnboardRole_role_type": { "description": "Allowed stored values for Django model `OnboardRole.role_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "internal", "external" ] }, "ModelEnum_api_root_OnboarderUserRequests_account_type": { "description": "Allowed stored values for Django model `OnboarderUserRequests.account_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "admin", "manager", "coordinator", "onboarder", "contributor", "view_only", "api" ] }, "ModelEnum_api_root_OnboarderUserRequests_status": { "description": "Allowed stored values for Django model `OnboarderUserRequests.status` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "active", "deactivated", "invited", "expired", "requested" ] }, "ModelEnum_api_root_HistoricalOnboarderUserNotifications_history_type": { "description": "Allowed stored values for Django model `HistoricalOnboarderUserNotifications.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_api_root_HistoricalOnboardeeUserNotifications_history_type": { "description": "Allowed stored values for Django model `HistoricalOnboardeeUserNotifications.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_api_root_HistoricalPlan_history_type": { "description": "Allowed stored values for Django model `HistoricalPlan.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_api_root_HistoricalOutboardSettings_domain_status": { "description": "Allowed stored values for Django model `HistoricalOutboardSettings.domain_status` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "disabled", "enabled", "pending" ] }, "ModelEnum_api_root_HistoricalOutboardSettings_default_project_view": { "description": "Allowed stored values for Django model `HistoricalOutboardSettings.default_project_view` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "myTasks", "dashboard", "table", "gantt" ] }, "ModelEnum_api_root_HistoricalOutboardSettings_history_type": { "description": "Allowed stored values for Django model `HistoricalOutboardSettings.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_api_root_OutboardSettings_domain_status": { "description": "Allowed stored values for Django model `OutboardSettings.domain_status` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "disabled", "enabled", "pending" ] }, "ModelEnum_api_root_OutboardSettings_default_project_view": { "description": "Allowed stored values for Django model `OutboardSettings.default_project_view` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "myTasks", "dashboard", "table", "gantt" ] }, "ModelEnum_api_root_HistoricalSSOSettings_history_type": { "description": "Allowed stored values for Django model `HistoricalSSOSettings.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_api_root_HistoricalTermsAcceptance_provider": { "description": "Allowed stored values for Django model `HistoricalTermsAcceptance.provider` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "openai" ] }, "ModelEnum_api_root_HistoricalTermsAcceptance_history_type": { "description": "Allowed stored values for Django model `HistoricalTermsAcceptance.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_api_root_TermsAcceptance_provider": { "description": "Allowed stored values for Django model `TermsAcceptance.provider` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "openai" ] }, "ModelEnum_api_root_HistoricalGettingStartedTemplate_user_type": { "description": "Allowed stored values for Django model `HistoricalGettingStartedTemplate.user_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "admin", "manager", "coordinator", "onboarder", "contributor", "view_only", "api" ] }, "ModelEnum_api_root_HistoricalGettingStartedTemplate_history_type": { "description": "Allowed stored values for Django model `HistoricalGettingStartedTemplate.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_api_root_GettingStartedTemplate_user_type": { "description": "Allowed stored values for Django model `GettingStartedTemplate.user_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "admin", "manager", "coordinator", "onboarder", "contributor", "view_only", "api" ] }, "RoadmapTaskFileSerializer": { "type": "object", "properties": { "link": { "type": "string", "format": "binary", "readOnly": true }, "file": { "type": "string", "format": "binary" }, "roadmap_task_id": { "type": "integer" }, "onboarder_company_id": { "type": "integer" } }, "required": [ "file" ] }, "RoadmapTaskImageSerializer": { "type": "object", "properties": { "link": { "type": "string", "format": "binary", "readOnly": true }, "image": { "type": "string", "format": "binary" }, "roadmap_task_id": { "type": "integer" }, "onboarder_company_id": { "type": "integer" } }, "required": [ "image" ] }, "TaskFileSerializer": { "type": "object", "properties": { "link": { "type": "string", "format": "binary", "readOnly": true }, "file": { "type": "string", "format": "binary" }, "task_id": { "type": "integer" }, "onboarder_company_id": { "type": "integer" } }, "required": [ "file" ] }, "TaskImageSerializer": { "type": "object", "properties": { "link": { "type": "string", "format": "binary", "readOnly": true }, "image": { "type": "string", "format": "binary" }, "task_id": { "type": "integer" }, "onboarder_company_id": { "type": "integer" } }, "required": [ "image" ] }, "ModelEnum_o_assets_HistoricalUserAvatar_history_type": { "description": "Allowed stored values for Django model `HistoricalUserAvatar.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "CommentInboxMessageSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "posted_at": { "type": "string", "readOnly": true }, "stream_message_id": { "type": "string", "readOnly": true }, "text": { "type": "string", "readOnly": true }, "html": { "type": "string", "readOnly": true }, "author": { "type": "string", "readOnly": true }, "mentioned_users": { "type": "string", "readOnly": true }, "attachments": { "type": "string", "readOnly": true }, "channel_id": { "type": "string", "readOnly": true }, "roadmap_id": { "type": "string", "readOnly": true }, "task_id": { "type": "string", "readOnly": true }, "roadmap_name": { "type": "string", "readOnly": true }, "task_name": { "type": "string", "readOnly": true } } }, "StreamTokenSerializer": { "type": "object", "properties": { "stream_token": { "type": "string", "readOnly": true } } }, "ModelEnum_o_comments_HistoricalStreamWebhookEvent_history_type": { "description": "Allowed stored values for Django model `HistoricalStreamWebhookEvent.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "CustomFieldSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "label": { "type": "string" }, "api_name": { "type": "string", "readOnly": true }, "description": { "type": "string" }, "object": { "type": "string", "enum": [ "customer", "map", "team_member", "onboardee", "map_task", "task", "section" ], "x-onboard-source": "serializer-or-model-choices" }, "type": { "type": "string", "enum": [ "number", "text", "dropdown", "boolean", "date", "textarea", "multiselect", "attachment" ], "x-onboard-source": "serializer-or-model-choices" }, "options": { "type": "object" }, "is_internal": { "type": "boolean" }, "is_active": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "tables_display_enabled": { "type": "boolean" }, "panels_display_enabled": { "type": "boolean" }, "outboard_display_enabled": { "type": "boolean" }, "map_types": { "type": "string" } }, "required": [ "label", "object", "type" ] }, "ModelEnum_o_custom_HistoricalCustomField_object": { "description": "Allowed stored values for Django model `HistoricalCustomField.object` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "customer", "map", "team_member", "onboardee", "map_task", "task", "section" ] }, "ModelEnum_o_custom_HistoricalCustomField_type": { "description": "Allowed stored values for Django model `HistoricalCustomField.type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "number", "text", "dropdown", "boolean", "date", "textarea", "multiselect", "attachment" ] }, "ModelEnum_o_custom_HistoricalCustomField_history_type": { "description": "Allowed stored values for Django model `HistoricalCustomField.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_custom_CustomField_object": { "description": "Allowed stored values for Django model `CustomField.object` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "customer", "map", "team_member", "onboardee", "map_task", "task", "section" ] }, "ModelEnum_o_custom_CustomField_type": { "description": "Allowed stored values for Django model `CustomField.type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "number", "text", "dropdown", "boolean", "date", "textarea", "multiselect", "attachment" ] }, "CustomEmailTemplateSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "template_type": { "type": "string", "enum": [ "invite_member", "invite_to_roadmap", "invite_onboardee_to_task", "invite_onboardee_to_task_bulk", "invite_to_task", "invite_to_task_bulk", "task_due_date_changed", "task_due_date_changed_bulk", "roadmap_status_update", "task_overdue", "task_due_date_tomorrow", "task_due_date_today", "o_comments_mention", "roadmap_blocked_by_hidden_section", "section_unlocked", "passwordless_invite", "passwordless_login", "passwordless_reminder", "workflow", "slack_disconnection", "task_summary", "task_summary_onboardee", "custom" ], "x-onboard-source": "serializer-or-model-choices" }, "custom_template_name": { "type": "string" }, "display_name": { "type": "string" }, "subject_line": { "type": "string" }, "from_name": { "type": "string" }, "from_email": { "type": "string", "format": "email" }, "html": { "type": "string" }, "design": { "type": "object" }, "default": { "type": "boolean" }, "is_enabled": { "type": "boolean" }, "is_scheduled": { "type": "boolean" }, "send_time": { "type": "string", "format": "time" }, "days_to_send": { "type": "object" }, "last_sent": { "type": "string", "format": "date-time", "readOnly": true }, "next_scheduled": { "type": "string", "format": "date-time", "readOnly": true }, "last_modified_date": { "type": "string", "readOnly": true }, "last_modified_user": { "type": "string", "readOnly": true }, "merge_tags": { "type": "string", "readOnly": true }, "preview_html": { "type": "string", "readOnly": true } }, "required": [ "template_type", "subject_line", "from_name", "design", "default", "is_enabled" ] }, "SendCustomEmailSerializer": { "type": "object", "properties": { "custom_template_name": { "type": "string" }, "template_type": { "type": "string" }, "subject_line": { "type": "string" }, "to_email": { "type": "string", "format": "email" }, "metadata": { "type": "object" } }, "required": [ "custom_template_name", "template_type", "subject_line", "to_email", "metadata" ] }, "SendEmailTemplatePreviewSerializer": { "type": "object", "properties": { "subject_line": { "type": "string" }, "from_name": { "type": "string" }, "from_email": { "type": "string", "format": "email" }, "html": { "type": "string" }, "email_address": { "type": "string", "format": "email" } }, "required": [ "subject_line", "from_name", "email_address" ] }, "ModelEnum_o_email_CustomSendingDomain_status": { "description": "Allowed stored values for Django model `CustomSendingDomain.status` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "active", "unverified", "disabled" ] }, "ModelEnum_o_email_HistoricalDefaultEmailTemplate_template_type": { "description": "Allowed stored values for Django model `HistoricalDefaultEmailTemplate.template_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "invite_member", "invite_to_roadmap", "invite_onboardee_to_task", "invite_onboardee_to_task_bulk", "invite_to_task", "invite_to_task_bulk", "task_due_date_changed", "task_due_date_changed_bulk", "roadmap_status_update", "task_overdue", "task_due_date_tomorrow", "task_due_date_today", "o_comments_mention", "roadmap_blocked_by_hidden_section", "section_unlocked", "passwordless_invite", "passwordless_login", "passwordless_reminder", "workflow", "task_summary", "slack_disconnection", "custom" ] }, "ModelEnum_o_email_HistoricalDefaultEmailTemplate_history_type": { "description": "Allowed stored values for Django model `HistoricalDefaultEmailTemplate.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_email_DefaultEmailTemplate_template_type": { "description": "Allowed stored values for Django model `DefaultEmailTemplate.template_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "invite_member", "invite_to_roadmap", "invite_onboardee_to_task", "invite_onboardee_to_task_bulk", "invite_to_task", "invite_to_task_bulk", "task_due_date_changed", "task_due_date_changed_bulk", "roadmap_status_update", "task_overdue", "task_due_date_tomorrow", "task_due_date_today", "o_comments_mention", "roadmap_blocked_by_hidden_section", "section_unlocked", "passwordless_invite", "passwordless_login", "passwordless_reminder", "workflow", "task_summary", "slack_disconnection", "custom" ] }, "ModelEnum_o_email_HistoricalCustomEmailTemplate_template_type": { "description": "Allowed stored values for Django model `HistoricalCustomEmailTemplate.template_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "invite_member", "invite_to_roadmap", "invite_onboardee_to_task", "invite_onboardee_to_task_bulk", "invite_to_task", "invite_to_task_bulk", "task_due_date_changed", "task_due_date_changed_bulk", "roadmap_status_update", "task_overdue", "task_due_date_tomorrow", "task_due_date_today", "o_comments_mention", "roadmap_blocked_by_hidden_section", "section_unlocked", "passwordless_invite", "passwordless_login", "passwordless_reminder", "workflow", "slack_disconnection", "task_summary", "task_summary_onboardee", "custom" ] }, "ModelEnum_o_email_HistoricalCustomEmailTemplate_history_type": { "description": "Allowed stored values for Django model `HistoricalCustomEmailTemplate.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_email_CustomEmailTemplate_template_type": { "description": "Allowed stored values for Django model `CustomEmailTemplate.template_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "invite_member", "invite_to_roadmap", "invite_onboardee_to_task", "invite_onboardee_to_task_bulk", "invite_to_task", "invite_to_task_bulk", "task_due_date_changed", "task_due_date_changed_bulk", "roadmap_status_update", "task_overdue", "task_due_date_tomorrow", "task_due_date_today", "o_comments_mention", "roadmap_blocked_by_hidden_section", "section_unlocked", "passwordless_invite", "passwordless_login", "passwordless_reminder", "workflow", "slack_disconnection", "task_summary", "task_summary_onboardee", "custom" ] }, "CustomFormSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string" }, "description": { "type": "string" }, "api_name": { "type": "string" }, "object": { "type": "string", "enum": [ "customer", "map", "team_member", "task" ], "x-onboard-source": "serializer-or-model-choices" }, "is_active": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "form_fields": { "type": "string" }, "onboarder_company_id": { "type": "string", "readOnly": true }, "allow_resubmissions": { "type": "boolean" }, "submission_required": { "type": "boolean" }, "complete_task_automatically": { "type": "boolean" }, "is_sample": { "type": "boolean", "description": "Whether this is sample data created for new companies" } }, "required": [ "name", "object" ] }, "FormSubmissionsListSerializer": { "type": "object", "properties": {} }, "ModelEnum_o_forms_HistoricalForm_object": { "description": "Allowed stored values for Django model `HistoricalForm.object` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "customer", "map", "team_member", "task" ] }, "ModelEnum_o_forms_HistoricalForm_history_type": { "description": "Allowed stored values for Django model `HistoricalForm.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_forms_Form_object": { "description": "Allowed stored values for Django model `Form.object` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "customer", "map", "team_member", "task" ] }, "ModelEnum_o_forms_HistoricalFormSubmission_history_type": { "description": "Allowed stored values for Django model `HistoricalFormSubmission.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_forms_HistoricalTaskForm_history_type": { "description": "Allowed stored values for Django model `HistoricalTaskForm.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_forms_HistoricalRoadmapTaskForm_history_type": { "description": "Allowed stored values for Django model `HistoricalRoadmapTaskForm.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_forms_HistoricalProjectTemplateTaskForm_history_type": { "description": "Allowed stored values for Django model `HistoricalProjectTemplateTaskForm.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "WebhookEventSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "uuid": { "type": "string" }, "subscription_id": { "type": "string", "readOnly": true }, "target": { "type": "string", "description": "URL of target for where to send webhook event." }, "version": { "type": "string" }, "success": { "type": "boolean" }, "status_code": { "type": "integer" }, "sent_at": { "type": "string", "format": "date-time" }, "data": { "type": "object" }, "response_data": { "type": "string" }, "response_headers": { "type": "object" } }, "required": [ "target", "version" ] }, "WebhookSubscriptionSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "target": { "type": "string", "format": "uri" }, "event_type": { "type": "string", "enum": [ "map-created", "map-updated", "map-status-updated", "map-owner-updated", "map-custom-field-updated", "map-task-created", "map-task-updated", "map-task-assignee-updated", "map-task-due-date-updated", "map-task-status-updated", "map-section-completed", "customer-created", "customer-updated", "customer-custom-field-updated", "discussion-message-created", "team-member-created", "variable-created", "global-task-created", "workflow-completed", "custom-form-submitted" ], "x-onboard-source": "serializer-or-model-choices" }, "version": { "type": "string" }, "automatic_retry": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "description": { "type": "string" }, "is_enabled": { "type": "boolean" }, "is_salesforce": { "type": "boolean", "description": "Created via Salesforce integration" }, "is_hubspot": { "type": "boolean", "description": "Created via HubSpot integration" }, "custom_field": { "type": "string" } }, "required": [ "target", "event_type" ] }, "ModelEnum_o_hooks_HistoricalWebhookSubscription_event_type": { "description": "Allowed stored values for Django model `HistoricalWebhookSubscription.event_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "map-created", "map-updated", "map-status-updated", "map-owner-updated", "map-custom-field-updated", "map-task-created", "map-task-updated", "map-task-assignee-updated", "map-task-due-date-updated", "map-task-status-updated", "map-section-completed", "customer-created", "customer-updated", "customer-custom-field-updated", "discussion-message-created", "team-member-created", "variable-created", "global-task-created", "workflow-completed", "custom-form-submitted" ] }, "ModelEnum_o_hooks_HistoricalWebhookSubscription_history_type": { "description": "Allowed stored values for Django model `HistoricalWebhookSubscription.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_hooks_WebhookSubscription_event_type": { "description": "Allowed stored values for Django model `WebhookSubscription.event_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "map-created", "map-updated", "map-status-updated", "map-owner-updated", "map-custom-field-updated", "map-task-created", "map-task-updated", "map-task-assignee-updated", "map-task-due-date-updated", "map-task-status-updated", "map-section-completed", "customer-created", "customer-updated", "customer-custom-field-updated", "discussion-message-created", "team-member-created", "variable-created", "global-task-created", "workflow-completed", "custom-form-submitted" ] }, "CalendarEmbedConfigSerializer": { "type": "object", "properties": {} }, "HistoryMapTasksSerializer": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "integer", "readOnly": true }, "status": { "type": "string", "enum": [ "open", "complete" ], "x-onboard-source": "serializer-or-model-choices" }, "is_section": { "type": "boolean" }, "client_visibility": { "type": "string", "enum": [ "show_when_map_created", "hide_when_map_created", "show_when_prev_section_complete" ], "x-onboard-source": "serializer-or-model-choices" }, "is_internal": { "type": "boolean" }, "is_optional": { "type": "boolean" }, "onboardee_user": { "type": "string" }, "onboarder_user": { "type": "string" }, "due_date": { "type": "string", "format": "date" }, "completed_by_onboardee_user": { "type": "string" }, "completed_by_onboarder_user": { "type": "string" }, "completed_at": { "type": "string", "format": "date-time" }, "history_date": { "type": "string", "format": "date-time", "readOnly": true }, "roadmap": { "type": "string" }, "event_type": { "type": "string" }, "estimated_time": { "type": "integer" }, "estimated_time_unit": { "type": "string", "enum": [ "minutes", "hours", "days" ], "x-onboard-source": "serializer-or-model-choices" }, "estimated_time_raw": { "type": "integer" }, "time_spent": { "type": "number", "format": "float" }, "time_spent_unit": { "type": "string", "enum": [ "minutes", "hours", "days" ], "x-onboard-source": "serializer-or-model-choices" }, "time_spent_raw": { "type": "integer" }, "external_id": { "type": "string" }, "is_ttv": { "type": "boolean", "description": "Time to Value task - only one task per project template, global tasks, or roadmap can be marked as TTV" } }, "required": [ "name", "onboardee_user", "onboarder_user", "completed_by_onboardee_user", "completed_by_onboarder_user", "roadmap", "event_type" ] }, "HistoryMapUpdateSerializer": { "type": "object", "properties": { "id": { "type": "integer" }, "uuid": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "launched", "stalled", "new", "in_progress", "paused" ], "x-onboard-source": "serializer-or-model-choices" }, "onboardee_company": { "type": "string" }, "owner": { "type": "string" }, "history_date": { "type": "string", "format": "date-time", "readOnly": true }, "event_type": { "type": "string" }, "expected_launch_date": { "type": "string", "format": "date-time" }, "actual_launch_date": { "type": "string", "format": "date-time" }, "notes": { "type": "string" }, "has_messages": { "type": "boolean" }, "external_id": { "type": "string" }, "custom": { "type": "object" } }, "required": [ "name", "onboardee_company", "owner", "event_type" ] }, "MapTypeSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "type": { "type": "string" }, "description": { "type": "string" }, "is_default": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "type" ] }, "MyTaskSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string" }, "description_preview": { "type": "string", "readOnly": true }, "due_date": { "type": "string", "format": "date" }, "order": { "type": "integer", "readOnly": true }, "is_internal": { "type": "boolean" }, "is_optional": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "map_id": { "type": "integer" }, "map_uuid": { "type": "string" }, "map_name": { "type": "string" }, "map_status": { "type": "string" }, "map_expected_launch_date": { "type": "string", "format": "date-time" }, "onboarder_company_slug": { "type": "string" }, "onboardee_company_name": { "type": "string" }, "onboardee_company_avatar": { "type": "string" }, "estimated_time": { "type": "integer" }, "estimated_time_unit": { "type": "string", "enum": [ "minutes", "hours", "days" ], "x-onboard-source": "serializer-or-model-choices" }, "estimated_time_raw": { "type": "integer" }, "time_spent": { "type": "number", "format": "float" }, "time_spent_unit": { "type": "string", "enum": [ "minutes", "hours", "days" ], "x-onboard-source": "serializer-or-model-choices" }, "time_spent_raw": { "type": "integer" }, "external_id": { "type": "string" }, "time_tracking_enabled": { "type": "boolean" }, "is_ttv": { "type": "boolean", "description": "Time to Value task - only one task per project template, global tasks, or roadmap can be marked as TTV" } }, "required": [ "name", "map_id", "map_uuid", "map_name", "map_status", "map_expected_launch_date", "onboarder_company_slug", "onboardee_company_name", "onboardee_company_avatar" ] }, "OptionListSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string" }, "variable": { "type": "string" }, "verbose_name": { "type": "string", "readOnly": true } }, "required": [ "name", "variable" ] }, "OptionSerializer": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "delete": { "type": "boolean" }, "order": { "type": "integer" } }, "required": [ "name" ] }, "ProjectAssetSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string" }, "description": { "type": "string" }, "file": { "type": "string", "format": "binary" }, "file_url": { "type": "string", "format": "binary", "readOnly": true }, "file_type": { "type": "string", "readOnly": true, "description": "MIME type or file extension" }, "file_size": { "type": "integer", "readOnly": true, "description": "File size in bytes" }, "link": { "type": "string", "format": "uri", "description": "URL link for the asset (alternative to file upload)" }, "link_label": { "type": "string", "description": "Label text for the link (auto-extracted from URL metadata if not provided)" }, "content_type": { "type": "string" }, "content_type_name": { "type": "string", "readOnly": true }, "object_id": { "type": "integer" }, "onboarder_user": { "type": "string", "readOnly": true }, "onboarder_user_id": { "type": "integer" }, "onboardee_user": { "type": "string", "readOnly": true }, "onboardee_user_id": { "type": "integer" }, "include_in_outboard": { "type": "boolean", "description": "Whether this asset should be visible in the customer portal (outboard)" }, "order": { "type": "integer", "description": "Ordering field for assets within the same content object (project/task/etc.)" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true }, "created_by": { "type": "string", "readOnly": true } } }, "RoadmapAssessmentHistorySerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "roadmap_id": { "type": "integer", "readOnly": true }, "roadmap_name": { "type": "string", "readOnly": true }, "customer_sentiment_assessment": { "type": "integer", "description": "Customer Sentiment Assessment value (1-5)" }, "previous_customer_sentiment_assessment": { "type": "integer", "description": "Previous Customer Sentiment Assessment value (1-5)" }, "project_team_assessment": { "type": "integer", "description": "Project Team Assessment value (1-5)" }, "previous_project_team_assessment": { "type": "integer", "description": "Previous Project Team Assessment value (1-5)" }, "updated_by": { "type": "string" }, "updated_by_name": { "type": "string", "readOnly": true }, "updated_by_email": { "type": "string", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true } } }, "RoadmapOnboardeeUserSerializer": { "type": "object", "properties": { "roadmap_id": { "type": "string", "readOnly": true }, "onboardee_user_id": { "type": "integer" }, "onboardee_user": { "type": "string", "readOnly": true }, "email": { "type": "string" }, "roadmap_roles_assigned": { "type": "string", "readOnly": true }, "roadmap_roles_assigned_ids": { "type": "array", "items": { "type": "string" } }, "roadmap_roles_assigned_names": { "type": "array", "items": { "type": "string" } }, "assign_tasks": { "type": "boolean" } } }, "RoadmapOnboarderUserSerializer": { "type": "object", "properties": { "roadmap_id": { "type": "string", "readOnly": true }, "onboarder_user_id": { "type": "integer" }, "onboarder_user": { "type": "string", "readOnly": true }, "email": { "type": "string" }, "roadmap_roles_assigned": { "type": "string", "readOnly": true }, "roadmap_roles_assigned_ids": { "type": "array", "items": { "type": "string" } }, "assign_tasks": { "type": "boolean" } } }, "RoadmapPreviewSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "preview_roadmap_id": { "type": "string", "readOnly": true }, "options": { "type": "string" }, "tasks": { "type": "string", "readOnly": true }, "parent_preview_save_at": { "type": "string", "format": "date-time", "readOnly": true } } }, "RoadmapTaskSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "roadmap_id": { "type": "string", "readOnly": true }, "roadmap_status": { "type": "string", "readOnly": true }, "name": { "type": "string" }, "task_id": { "type": "string", "readOnly": true }, "is_global_task": { "type": "string", "readOnly": true }, "description": { "type": "string" }, "order": { "type": "integer", "readOnly": true }, "status": { "type": "string", "enum": [ "open", "complete" ], "x-onboard-source": "serializer-or-model-choices" }, "is_section": { "type": "boolean" }, "is_hidden": { "type": "boolean" }, "is_internal": { "type": "boolean" }, "is_optional": { "type": "boolean" }, "onboardee_user": { "type": "string", "readOnly": true }, "onboardee_user_id": { "type": "integer" }, "onboarder_user": { "type": "string", "readOnly": true }, "onboarder_user_id": { "type": "integer" }, "due_date": { "type": "string", "format": "date" }, "move_to": { "type": "integer" }, "description_preview": { "type": "string", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true }, "completed_at": { "type": "string", "format": "date-time" }, "completed_by_onboardee_user": { "type": "string", "readOnly": true }, "completed_by_onboarder_user": { "type": "string", "readOnly": true }, "completed_source": { "type": "string" }, "assignee_email": { "type": "string", "format": "email" }, "estimated_time": { "type": "integer" }, "estimated_time_unit": { "type": "string", "enum": [ "minutes", "hours", "days" ], "x-onboard-source": "serializer-or-model-choices" }, "estimated_time_raw": { "type": "integer" }, "time_spent": { "type": "number", "format": "float" }, "time_spent_unit": { "type": "string", "enum": [ "minutes", "hours", "days" ], "x-onboard-source": "serializer-or-model-choices" }, "time_spent_raw": { "type": "integer" }, "refresh": { "type": "string", "readOnly": true }, "refresh_message": { "type": "string", "readOnly": true }, "preview_status": { "type": "string", "enum": [ "keep", "add", "remove" ], "x-onboard-source": "serializer-or-model-choices" }, "initial_preview_status": { "type": "string", "readOnly": true, "enum": [ "keep", "add", "remove" ], "x-onboard-source": "serializer-or-model-choices" }, "has_messages": { "type": "boolean", "readOnly": true }, "external_id": { "type": "string" }, "forms": { "type": "string", "readOnly": true }, "time_tracking_enabled": { "type": "boolean" }, "sf_task_id": { "type": "string" }, "dependencies": { "type": "array", "items": { "type": "string" } }, "start_date": { "type": "string", "format": "date" }, "end_date": { "type": "string", "format": "date" }, "sync_due_date": { "type": "boolean" }, "category": { "type": "string", "enum": [ "task", "survey", "form", "meeting", "training", "documentation", "chat_bot" ], "x-onboard-source": "serializer-or-model-choices" }, "embedded": { "type": "string" }, "embedded_url": { "type": "string" }, "embedded_option": { "type": "string", "enum": [ "url", "owner", "assignee", "map", "customer" ], "x-onboard-source": "serializer-or-model-choices" }, "embedded_panel_title": { "type": "string" }, "is_billable": { "type": "boolean" }, "due_date_type": { "type": "string", "readOnly": true, "enum": [ "before_target_launch_date", "after_target_launch_date", "before_created_date", "after_created_date", "days_after_previous_task_completed", "days_after_specific_task_completed", "days_after_previous_task_due", "days_after_specific_task_due" ], "x-onboard-source": "serializer-or-model-choices" }, "due_date_enabled": { "type": "boolean", "readOnly": true }, "due_date_days": { "type": "integer" }, "due_date_days_after_specific_task_completed_roadmap_task_id": { "type": "integer" }, "due_date_days_after_specific_task_due_roadmap_task_id": { "type": "integer" }, "embedded_url_merge_tag": { "type": "string", "readOnly": true }, "is_outboard_one_off_task": { "type": "boolean", "readOnly": true }, "is_ttv": { "type": "boolean", "description": "Time to Value task - only one task per project template, global tasks, or roadmap can be marked as TTV" }, "custom": { "type": "string" } }, "required": [ "name" ] }, "TaskSerializer": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string" }, "description_preview": { "type": "string", "readOnly": true }, "order": { "type": "integer", "readOnly": true }, "is_section": { "type": "boolean" }, "is_optional": { "type": "boolean" }, "client_visibility": { "type": "string", "enum": [ "show_when_map_created", "hide_when_map_created", "show_when_prev_section_complete" ], "x-onboard-source": "serializer-or-model-choices" }, "due_date_type": { "type": "string", "enum": [ "before_target_launch_date", "after_target_launch_date", "before_created_date", "after_created_date", "days_after_previous_task_completed", "days_after_specific_task_completed", "days_after_previous_task_due", "days_after_specific_task_due" ], "x-onboard-source": "serializer-or-model-choices" }, "due_date_days": { "type": "integer" }, "due_date_enabled": { "type": "boolean" }, "options_advanced": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "move_to": { "type": "integer" }, "options": { "type": "string" }, "is_internal": { "type": "boolean" }, "assign_to_owner": { "type": "boolean" }, "estimated_time": { "type": "integer" }, "estimated_time_unit": { "type": "string", "enum": [ "minutes", "hours", "days" ], "x-onboard-source": "serializer-or-model-choices" }, "estimated_time_raw": { "type": "integer" }, "forms": { "type": "string", "readOnly": true }, "time_tracking_enabled": { "type": "boolean" }, "assign_to_role": { "type": "string" }, "assign_to_role_id": { "type": "integer" }, "dependencies": { "type": "array", "items": { "type": "string" } }, "category": { "type": "string", "enum": [ "task", "survey", "form", "meeting", "training", "documentation", "chat_bot" ], "x-onboard-source": "serializer-or-model-choices" }, "embedded": { "type": "string" }, "embedded_url": { "type": "string" }, "embedded_option": { "type": "string", "enum": [ "url", "owner", "assignee", "map", "customer" ], "x-onboard-source": "serializer-or-model-choices" }, "embedded_panel_title": { "type": "string" }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true }, "map_types": { "type": "string", "readOnly": true }, "map_types_ids": { "type": "string", "readOnly": true }, "is_billable": { "type": "boolean" }, "due_date_days_after_specific_task_completed_task_id": { "type": "integer" }, "due_date_days_after_specific_task_completed_task": { "type": "string", "readOnly": true }, "due_date_days_after_specific_task_due_task_id": { "type": "integer" }, "due_date_days_after_specific_task_due_task": { "type": "string", "readOnly": true }, "embedded_url_merge_tag": { "type": "string" }, "is_ttv": { "type": "boolean", "description": "Time to Value task - only one task per project template, global tasks, or roadmap can be marked as TTV" }, "update_tasks": { "type": "boolean" }, "update_tasks_notify": { "type": "boolean" } }, "required": [ "name" ] }, "TeamTaskSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string" }, "description_preview": { "type": "string", "readOnly": true }, "due_date": { "type": "string", "format": "date" }, "is_internal": { "type": "boolean" }, "is_optional": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "map_id": { "type": "integer" }, "map_name": { "type": "string" }, "map_status": { "type": "string" }, "map_expected_launch_date": { "type": "string", "format": "date-time" }, "onboardee_company_name": { "type": "string" }, "onboardee_company_avatar": { "type": "string" }, "roadmap_id": { "type": "string", "readOnly": true }, "roadmap_status": { "type": "string", "readOnly": true }, "description": { "type": "string" }, "status": { "type": "string", "enum": [ "open", "complete" ], "x-onboard-source": "serializer-or-model-choices" }, "is_section": { "type": "boolean" }, "is_hidden": { "type": "boolean" }, "onboarder_user": { "type": "string", "readOnly": true }, "onboarder_user_id": { "type": "integer" }, "onboardee_user": { "type": "string", "readOnly": true }, "onboardee_user_id": { "type": "integer" }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true }, "completed_at": { "type": "string", "format": "date-time" }, "time_spent": { "type": "number", "format": "float" }, "time_spent_unit": { "type": "string", "enum": [ "minutes", "hours", "days" ], "x-onboard-source": "serializer-or-model-choices" }, "time_spent_raw": { "type": "integer" }, "external_id": { "type": "string" }, "time_tracking_enabled": { "type": "boolean" }, "is_ttv": { "type": "boolean", "description": "Time to Value task - only one task per project template, global tasks, or roadmap can be marked as TTV" } }, "required": [ "name", "map_id", "map_name", "map_status", "map_expected_launch_date", "onboardee_company_name", "onboardee_company_avatar" ] }, "VariableSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "number", "percentage", "picklist", "multiple_picklist" ], "x-onboard-source": "serializer-or-model-choices" }, "tasks": { "type": "integer", "readOnly": true }, "options": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true }, "is_required": { "type": "boolean" }, "message": { "type": "string", "readOnly": true }, "map_types": { "type": "string" }, "order": { "type": "integer", "readOnly": true } }, "required": [ "name", "type", "options" ] }, "ModelEnum_o_map_HistoricalOption_history_type": { "description": "Allowed stored values for Django model `HistoricalOption.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_map_HistoricalRoadmap_status": { "description": "Allowed stored values for Django model `HistoricalRoadmap.status` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "launched", "stalled", "new", "in_progress", "paused" ] }, "ModelEnum_o_map_HistoricalRoadmap_history_type": { "description": "Allowed stored values for Django model `HistoricalRoadmap.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_map_Roadmap_status": { "description": "Allowed stored values for Django model `Roadmap.status` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "launched", "stalled", "new", "in_progress", "paused" ] }, "ModelEnum_o_map_HistoricalRoadmapOnboardeeUser_history_type": { "description": "Allowed stored values for Django model `HistoricalRoadmapOnboardeeUser.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_map_HistoricalRoadmapOnboarderUser_history_type": { "description": "Allowed stored values for Django model `HistoricalRoadmapOnboarderUser.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_map_HistoricalRoadmapOption_history_type": { "description": "Allowed stored values for Django model `HistoricalRoadmapOption.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_map_HistoricalRoadmapTask_due_date_type": { "description": "Allowed stored values for Django model `HistoricalRoadmapTask.due_date_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "before_target_launch_date", "after_target_launch_date", "before_created_date", "after_created_date", "days_after_previous_task_completed", "days_after_specific_task_completed", "days_after_previous_task_due", "days_after_specific_task_due" ] }, "ModelEnum_o_map_HistoricalRoadmapTask_estimated_time_unit": { "description": "Allowed stored values for Django model `HistoricalRoadmapTask.estimated_time_unit` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "minutes", "hours", "days" ] }, "ModelEnum_o_map_HistoricalRoadmapTask_client_visibility": { "description": "Allowed stored values for Django model `HistoricalRoadmapTask.client_visibility` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "show_when_map_created", "hide_when_map_created", "show_when_prev_section_complete" ] }, "ModelEnum_o_map_HistoricalRoadmapTask_time_spent_unit": { "description": "Allowed stored values for Django model `HistoricalRoadmapTask.time_spent_unit` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "minutes", "hours", "days" ] }, "ModelEnum_o_map_HistoricalRoadmapTask_category": { "description": "Allowed stored values for Django model `HistoricalRoadmapTask.category` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "task", "survey", "form", "meeting", "training", "documentation", "chat_bot" ] }, "ModelEnum_o_map_HistoricalRoadmapTask_embedded_option": { "description": "Allowed stored values for Django model `HistoricalRoadmapTask.embedded_option` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "url", "owner", "assignee", "map", "customer" ] }, "ModelEnum_o_map_HistoricalRoadmapTask_status": { "description": "Allowed stored values for Django model `HistoricalRoadmapTask.status` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "open", "complete" ] }, "ModelEnum_o_map_HistoricalRoadmapTask_preview_status": { "description": "Allowed stored values for Django model `HistoricalRoadmapTask.preview_status` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "keep", "add", "remove" ] }, "ModelEnum_o_map_HistoricalRoadmapTask_initial_preview_status": { "description": "Allowed stored values for Django model `HistoricalRoadmapTask.initial_preview_status` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "keep", "add", "remove" ] }, "ModelEnum_o_map_HistoricalRoadmapTask_history_type": { "description": "Allowed stored values for Django model `HistoricalRoadmapTask.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_map_RoadmapTask_due_date_type": { "description": "Allowed stored values for Django model `RoadmapTask.due_date_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "before_target_launch_date", "after_target_launch_date", "before_created_date", "after_created_date", "days_after_previous_task_completed", "days_after_specific_task_completed", "days_after_previous_task_due", "days_after_specific_task_due" ] }, "ModelEnum_o_map_RoadmapTask_estimated_time_unit": { "description": "Allowed stored values for Django model `RoadmapTask.estimated_time_unit` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "minutes", "hours", "days" ] }, "ModelEnum_o_map_RoadmapTask_client_visibility": { "description": "Allowed stored values for Django model `RoadmapTask.client_visibility` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "show_when_map_created", "hide_when_map_created", "show_when_prev_section_complete" ] }, "ModelEnum_o_map_RoadmapTask_time_spent_unit": { "description": "Allowed stored values for Django model `RoadmapTask.time_spent_unit` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "minutes", "hours", "days" ] }, "ModelEnum_o_map_RoadmapTask_category": { "description": "Allowed stored values for Django model `RoadmapTask.category` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "task", "survey", "form", "meeting", "training", "documentation", "chat_bot" ] }, "ModelEnum_o_map_RoadmapTask_embedded_option": { "description": "Allowed stored values for Django model `RoadmapTask.embedded_option` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "url", "owner", "assignee", "map", "customer" ] }, "ModelEnum_o_map_RoadmapTask_status": { "description": "Allowed stored values for Django model `RoadmapTask.status` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "open", "complete" ] }, "ModelEnum_o_map_RoadmapTask_preview_status": { "description": "Allowed stored values for Django model `RoadmapTask.preview_status` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "keep", "add", "remove" ] }, "ModelEnum_o_map_RoadmapTask_initial_preview_status": { "description": "Allowed stored values for Django model `RoadmapTask.initial_preview_status` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "keep", "add", "remove" ] }, "ModelEnum_o_map_HistoricalTask_due_date_type": { "description": "Allowed stored values for Django model `HistoricalTask.due_date_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "before_target_launch_date", "after_target_launch_date", "before_created_date", "after_created_date", "days_after_previous_task_completed", "days_after_specific_task_completed", "days_after_previous_task_due", "days_after_specific_task_due" ] }, "ModelEnum_o_map_HistoricalTask_estimated_time_unit": { "description": "Allowed stored values for Django model `HistoricalTask.estimated_time_unit` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "minutes", "hours", "days" ] }, "ModelEnum_o_map_HistoricalTask_client_visibility": { "description": "Allowed stored values for Django model `HistoricalTask.client_visibility` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "show_when_map_created", "hide_when_map_created", "show_when_prev_section_complete" ] }, "ModelEnum_o_map_HistoricalTask_time_spent_unit": { "description": "Allowed stored values for Django model `HistoricalTask.time_spent_unit` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "minutes", "hours", "days" ] }, "ModelEnum_o_map_HistoricalTask_category": { "description": "Allowed stored values for Django model `HistoricalTask.category` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "task", "survey", "form", "meeting", "training", "documentation", "chat_bot" ] }, "ModelEnum_o_map_HistoricalTask_embedded_option": { "description": "Allowed stored values for Django model `HistoricalTask.embedded_option` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "url", "owner", "assignee", "map", "customer" ] }, "ModelEnum_o_map_HistoricalTask_history_type": { "description": "Allowed stored values for Django model `HistoricalTask.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_map_Task_due_date_type": { "description": "Allowed stored values for Django model `Task.due_date_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "before_target_launch_date", "after_target_launch_date", "before_created_date", "after_created_date", "days_after_previous_task_completed", "days_after_specific_task_completed", "days_after_previous_task_due", "days_after_specific_task_due" ] }, "ModelEnum_o_map_Task_estimated_time_unit": { "description": "Allowed stored values for Django model `Task.estimated_time_unit` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "minutes", "hours", "days" ] }, "ModelEnum_o_map_Task_client_visibility": { "description": "Allowed stored values for Django model `Task.client_visibility` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "show_when_map_created", "hide_when_map_created", "show_when_prev_section_complete" ] }, "ModelEnum_o_map_Task_time_spent_unit": { "description": "Allowed stored values for Django model `Task.time_spent_unit` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "minutes", "hours", "days" ] }, "ModelEnum_o_map_Task_category": { "description": "Allowed stored values for Django model `Task.category` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "task", "survey", "form", "meeting", "training", "documentation", "chat_bot" ] }, "ModelEnum_o_map_Task_embedded_option": { "description": "Allowed stored values for Django model `Task.embedded_option` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "url", "owner", "assignee", "map", "customer" ] }, "ModelEnum_o_map_HistoricalTaskOption_history_type": { "description": "Allowed stored values for Django model `HistoricalTaskOption.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_map_HistoricalVariable_type": { "description": "Allowed stored values for Django model `HistoricalVariable.type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "number", "percentage", "picklist", "multiple_picklist" ] }, "ModelEnum_o_map_HistoricalVariable_history_type": { "description": "Allowed stored values for Django model `HistoricalVariable.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_map_Variable_type": { "description": "Allowed stored values for Django model `Variable.type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "number", "percentage", "picklist", "multiple_picklist" ] }, "ModelEnum_o_map_HistoricalCalendarEmbedConfig_history_type": { "description": "Allowed stored values for Django model `HistoricalCalendarEmbedConfig.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_map_HistoricalMapType_history_type": { "description": "Allowed stored values for Django model `HistoricalMapType.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_map_HistoricalVariableMapType_history_type": { "description": "Allowed stored values for Django model `HistoricalVariableMapType.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_map_HistoricalCustomFieldMapType_history_type": { "description": "Allowed stored values for Django model `HistoricalCustomFieldMapType.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_map_HistoricalProjectTemplate_history_type": { "description": "Allowed stored values for Django model `HistoricalProjectTemplate.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_map_HistoricalProjectTemplateOption_history_type": { "description": "Allowed stored values for Django model `HistoricalProjectTemplateOption.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_map_HistoricalProjectTemplateCustomer_history_type": { "description": "Allowed stored values for Django model `HistoricalProjectTemplateCustomer.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_map_HistoricalProjectTemplateTask_due_date_type": { "description": "Allowed stored values for Django model `HistoricalProjectTemplateTask.due_date_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "before_target_launch_date", "after_target_launch_date", "before_created_date", "after_created_date", "days_after_previous_task_completed", "days_after_specific_task_completed", "days_after_previous_task_due", "days_after_specific_task_due" ] }, "ModelEnum_o_map_HistoricalProjectTemplateTask_estimated_time_unit": { "description": "Allowed stored values for Django model `HistoricalProjectTemplateTask.estimated_time_unit` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "minutes", "hours", "days" ] }, "ModelEnum_o_map_HistoricalProjectTemplateTask_client_visibility": { "description": "Allowed stored values for Django model `HistoricalProjectTemplateTask.client_visibility` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "show_when_map_created", "hide_when_map_created", "show_when_prev_section_complete" ] }, "ModelEnum_o_map_HistoricalProjectTemplateTask_time_spent_unit": { "description": "Allowed stored values for Django model `HistoricalProjectTemplateTask.time_spent_unit` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "minutes", "hours", "days" ] }, "ModelEnum_o_map_HistoricalProjectTemplateTask_category": { "description": "Allowed stored values for Django model `HistoricalProjectTemplateTask.category` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "task", "survey", "form", "meeting", "training", "documentation", "chat_bot" ] }, "ModelEnum_o_map_HistoricalProjectTemplateTask_embedded_option": { "description": "Allowed stored values for Django model `HistoricalProjectTemplateTask.embedded_option` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "url", "owner", "assignee", "map", "customer" ] }, "ModelEnum_o_map_HistoricalProjectTemplateTask_history_type": { "description": "Allowed stored values for Django model `HistoricalProjectTemplateTask.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_map_ProjectTemplateTask_due_date_type": { "description": "Allowed stored values for Django model `ProjectTemplateTask.due_date_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "before_target_launch_date", "after_target_launch_date", "before_created_date", "after_created_date", "days_after_previous_task_completed", "days_after_specific_task_completed", "days_after_previous_task_due", "days_after_specific_task_due" ] }, "ModelEnum_o_map_ProjectTemplateTask_estimated_time_unit": { "description": "Allowed stored values for Django model `ProjectTemplateTask.estimated_time_unit` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "minutes", "hours", "days" ] }, "ModelEnum_o_map_ProjectTemplateTask_client_visibility": { "description": "Allowed stored values for Django model `ProjectTemplateTask.client_visibility` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "show_when_map_created", "hide_when_map_created", "show_when_prev_section_complete" ] }, "ModelEnum_o_map_ProjectTemplateTask_time_spent_unit": { "description": "Allowed stored values for Django model `ProjectTemplateTask.time_spent_unit` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "minutes", "hours", "days" ] }, "ModelEnum_o_map_ProjectTemplateTask_category": { "description": "Allowed stored values for Django model `ProjectTemplateTask.category` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "task", "survey", "form", "meeting", "training", "documentation", "chat_bot" ] }, "ModelEnum_o_map_ProjectTemplateTask_embedded_option": { "description": "Allowed stored values for Django model `ProjectTemplateTask.embedded_option` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "url", "owner", "assignee", "map", "customer" ] }, "ModelEnum_o_map_HistoricalProjectAsset_history_type": { "description": "Allowed stored values for Django model `HistoricalProjectAsset.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "DashboardConfigurationCreateSerializer": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string" }, "is_default": { "type": "boolean" }, "is_template": { "type": "boolean", "description": "Whether this is a template configuration" }, "configuration": { "type": "object" } }, "required": [ "name", "type", "configuration" ] }, "DashboardConfigurationSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string" }, "type_display": { "type": "string", "readOnly": true }, "type_code": { "type": "string", "readOnly": true }, "type_details": { "type": "string", "readOnly": true }, "is_default": { "type": "boolean" }, "is_template": { "type": "boolean", "description": "Whether this is a template configuration" }, "configuration": { "type": "object" }, "created_by": { "type": "string" }, "created_by_name": { "type": "string", "readOnly": true }, "updated_by": { "type": "string" }, "updated_by_name": { "type": "string", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "name", "type", "configuration" ] }, "DashboardConfigurationTemplateSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "description": { "type": "string", "readOnly": true }, "type": { "type": "string", "readOnly": true }, "type_display": { "type": "string", "readOnly": true }, "type_code": { "type": "string", "readOnly": true }, "type_details": { "type": "string", "readOnly": true }, "is_template": { "type": "boolean", "readOnly": true, "description": "Whether this is a template configuration" }, "configuration": { "type": "object", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } } }, "DashboardConfigurationTypeSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string" }, "code": { "type": "string", "description": "Auto-generated from name" }, "description": { "type": "string" }, "is_active": { "type": "boolean", "description": "Whether this configuration type is available for use" }, "is_template": { "type": "boolean", "description": "Whether this is a template configuration type" } }, "required": [ "name" ] }, "DashboardMapOwnersSerializer": { "type": "object", "properties": { "count_maps": { "type": "integer", "readOnly": true }, "id": { "type": "integer", "readOnly": true }, "first_name": { "type": "string", "readOnly": true }, "last_name": { "type": "string", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "email": { "type": "string", "readOnly": true }, "avatar": { "type": "string", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "invited_at": { "type": "string", "format": "date-time" }, "last_login": { "type": "string", "readOnly": true } } }, "MetricThresholdSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "onboarder_company": { "type": "string" }, "metric_key": { "type": "string", "enum": [ "time_to_launch", "on_time_launch_rate", "customer_engagement", "internal_task_efficiency", "overdue_task_rate" ], "x-onboard-source": "serializer-or-model-choices" }, "metric_key_display": { "type": "string", "readOnly": true }, "target_value": { "type": "number", "format": "float", "description": "Target threshold value" }, "good_value": { "type": "number", "format": "float", "description": "Good threshold value" }, "risk_value": { "type": "number", "format": "float", "description": "Risk threshold value" }, "target_operator": { "type": "string", "enum": [ "lt", "gt", "lte", "gte" ], "description": "Operator for target comparison", "x-onboard-source": "serializer-or-model-choices" }, "good_operator": { "type": "string", "enum": [ "lt", "gt", "lte", "gte" ], "description": "Operator for good comparison", "x-onboard-source": "serializer-or-model-choices" }, "risk_operator": { "type": "string", "enum": [ "lt", "gt", "lte", "gte" ], "description": "Operator for risk comparison", "x-onboard-source": "serializer-or-model-choices" }, "description": { "type": "string", "description": "Description of the metric" }, "context": { "type": "string", "description": "Context about what the metric means" }, "created_by": { "type": "string" }, "created_by_name": { "type": "string", "readOnly": true }, "updated_by": { "type": "string" }, "updated_by_name": { "type": "string", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "required": [ "onboarder_company", "metric_key", "target_value", "good_value", "risk_value" ] }, "ModelEnum_o_stats_DashboardSummary_stat": { "description": "Allowed stored values for Django model `DashboardSummary.stat` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "sc", "ac" ] }, "ModelEnum_o_stats_HistoricalMetricThreshold_metric_key": { "description": "Allowed stored values for Django model `HistoricalMetricThreshold.metric_key` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "time_to_launch", "on_time_launch_rate", "customer_engagement", "internal_task_efficiency", "overdue_task_rate" ] }, "ModelEnum_o_stats_HistoricalMetricThreshold_target_operator": { "description": "Allowed stored values for Django model `HistoricalMetricThreshold.target_operator` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "lt", "gt", "lte", "gte" ] }, "ModelEnum_o_stats_HistoricalMetricThreshold_good_operator": { "description": "Allowed stored values for Django model `HistoricalMetricThreshold.good_operator` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "lt", "gt", "lte", "gte" ] }, "ModelEnum_o_stats_HistoricalMetricThreshold_risk_operator": { "description": "Allowed stored values for Django model `HistoricalMetricThreshold.risk_operator` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "lt", "gt", "lte", "gte" ] }, "ModelEnum_o_stats_HistoricalMetricThreshold_history_type": { "description": "Allowed stored values for Django model `HistoricalMetricThreshold.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_stats_MetricThreshold_metric_key": { "description": "Allowed stored values for Django model `MetricThreshold.metric_key` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "time_to_launch", "on_time_launch_rate", "customer_engagement", "internal_task_efficiency", "overdue_task_rate" ] }, "ModelEnum_o_stats_MetricThreshold_target_operator": { "description": "Allowed stored values for Django model `MetricThreshold.target_operator` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "lt", "gt", "lte", "gte" ] }, "ModelEnum_o_stats_MetricThreshold_good_operator": { "description": "Allowed stored values for Django model `MetricThreshold.good_operator` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "lt", "gt", "lte", "gte" ] }, "ModelEnum_o_stats_MetricThreshold_risk_operator": { "description": "Allowed stored values for Django model `MetricThreshold.risk_operator` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "lt", "gt", "lte", "gte" ] }, "WorkflowActionSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "action_type": { "type": "string", "enum": [ "send_email", "slack", "update_customer_fields", "update_map_fields", "update_map_variables", "refresh_map_tasks", "create_map" ], "x-onboard-source": "serializer-or-model-choices" }, "action_type_display": { "type": "string", "readOnly": true }, "config": { "type": "object" }, "trigger": { "type": "string" } }, "required": [ "action_type" ] }, "WorkflowActivitySerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "run_at": { "type": "string", "format": "date-time" }, "is_complete": { "type": "boolean" }, "workflow": { "type": "string" }, "onboarder_company": { "type": "string" }, "onboarder_user": { "type": "string", "readOnly": true }, "roadmap": { "type": "string", "readOnly": true }, "task": { "type": "string" }, "actions": { "type": "object" }, "metadata": { "type": "object" }, "status": { "type": "string", "enum": [ "success", "filtered", "error", "running" ], "x-onboard-source": "serializer-or-model-choices" } }, "required": [ "workflow", "onboarder_company", "task" ] }, "WorkflowCategorySerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "description": { "type": "string", "readOnly": true }, "workflow_recipes": { "type": "string" }, "color": { "type": "string", "readOnly": true } } }, "WorkflowQuickActionSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string" }, "last_run_date": { "type": "string", "readOnly": true }, "workflow_type": { "type": "string", "enum": [ "quick_action", "event", "scheduled" ], "x-onboard-source": "serializer-or-model-choices" }, "workflow_actions": { "type": "string" }, "workflow_actions_display": { "type": "string", "readOnly": true }, "trigger": { "type": "string", "enum": [ "map-created", "map-updated", "map-status-updated", "map-owner-updated", "map-task-created", "map-task-assignee-updated", "map-task-due-date-updated", "map-task-status-updated", "map-section-completed", "discussion-message-created", "customer-created", "customer-updated", "custom-form-submitted" ], "description": "Only required when workflow_type=event", "x-onboard-source": "serializer-or-model-choices" }, "trigger_display": { "type": "string", "readOnly": true }, "internal_description": { "type": "string" }, "button_color": { "type": "string" }, "button_placement": { "type": "string", "enum": [ "map", "map_task" ], "x-onboard-source": "serializer-or-model-choices" }, "button_title": { "type": "string" }, "is_enabled": { "type": "boolean" }, "filters": { "type": "object" } }, "required": [ "name", "workflow_type" ] }, "WorkflowRecipeSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "description": { "type": "string", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "config": { "type": "object", "readOnly": true }, "object": { "type": "string", "readOnly": true, "enum": [ "customer", "map", "variable", "task" ], "x-onboard-source": "serializer-or-model-choices" }, "is_visible": { "type": "boolean", "readOnly": true }, "category_id": { "type": "string", "readOnly": true }, "instructions": { "type": "string", "readOnly": true }, "icon": { "type": "string", "readOnly": true, "enum": [ "activity", "airplay", "alert-circle", "alert-octagon", "alert-triangle", "align-center", "align-justify", "align-left", "align-right", "anchor", "aperture", "archive", "arrange", "arrange-double", "arrow-down", "arrow-down-circle", "arrow-left", "arrow-right", "arrow-up", "at-sign", "award", "bar-chart", "battery", "battery-charging", "bell", "bell-off", "bluetooth", "bold", "book-open", "bookmark", "box", "briefcase", "calendar", "camera", "camera-off", "cast", "check", "check-circle", "check-inside", "check-square", "check-uncheck", "chevron-down", "chevron-left", "chevron-right", "chevron-up", "chevrons-down", "chevrons-left", "chevrons-right", "chevrons-up", "chrome", "circle", "circle-check", "circle-check-full", "circle-full", "clipboard", "clock", "cloud", "cloud-drizzle", "cloud-lightning", "cloud-off", "cloud-rain", "cloud-snow", "code", "compass", "copy", "cpu", "credit-card", "crop", "crosshair", "database", "delete", "disc", "dollar-sign", "download", "download-cloud", "droplet", "edit", "external-link", "eye", "eye-off", "feather", "file", "file-text", "film", "filter", "flag", "folder", "folder-minus", "folder-plus", "framer", "frown", "gantt", "gift", "git-branch", "git-commit", "git-merge", "git-pull-request", "github", "gitlab", "globe", "grid", "hard-drive", "hash", "heart", "help-circle", "home", "image", "inbox", "info", "instagram", "italic", "key", "layers", "layout", "life-buoy", "link", "link-2", "linkedin", "list", "loader", "lock", "log-in", "log-out", "mail", "map", "map-pin", "maximize", "menu", "message-circle", "message-square", "mic", "mic-off", "minimize", "minus", "minus-circle", "monitor", "moon", "more-horizontal", "more-vertical", "mouse-pointer", "music", "navigation", "navigation-2", "octagon", "onboard", "package", "paperclip", "pause", "pause-circle", "pen-tool", "pencil", "percent", "phone", "phone-call", "phone-forwarded", "phone-incoming", "phone-missed", "phone-off", "phone-outgoing", "pie-chart", "play", "play-circle", "plus", "plus-circle", "power", "printer", "radio", "refresh", "refresh-ccw", "refresh-cw", "remove", "remove-circle", "repeat", "rewind", "rotate-ccw", "rotate-cw", "rss", "save", "scissors", "search", "send", "server", "settings", "share", "share-2", "shield", "shield-off", "shopping-bag", "shopping-cart", "skip-back", "skip-forward", "slash", "sliders", "smile", "sort", "sparkling", "speaker", "square", "star", "stop-circle", "sun", "tag", "target", "thermometer", "thumbs-down", "thumbs-up", "trash", "trash-2", "trending-down", "trending-up", "twitter", "type", "underline", "upload", "upload-cloud", "user", "user-check", "user-minus", "user-plus", "user-x", "users", "video", "video-off", "voicemail", "volume", "volume-2", "volume-x", "watch", "wifi", "wifi-off", "x", "x-circle", "x-square", "zap", "zap-off", "zoom-in", "zoom-out" ], "x-onboard-source": "serializer-or-model-choices" }, "color": { "type": "string", "readOnly": true } } }, "WorkflowSerializer": { "type": "object", "properties": { "id": { "type": "integer", "readOnly": true }, "name": { "type": "string" }, "workflow_type": { "type": "string", "enum": [ "quick_action", "event", "scheduled" ], "x-onboard-source": "serializer-or-model-choices" }, "workflow_actions": { "type": "string" }, "workflow_actions_display": { "type": "string", "readOnly": true }, "trigger": { "type": "string", "enum": [ "map-created", "map-updated", "map-status-updated", "map-owner-updated", "map-task-created", "map-task-assignee-updated", "map-task-due-date-updated", "map-task-status-updated", "map-section-completed", "discussion-message-created", "customer-created", "customer-updated", "custom-form-submitted" ], "description": "Only required when workflow_type=event", "x-onboard-source": "serializer-or-model-choices" }, "trigger_display": { "type": "string", "readOnly": true }, "internal_description": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "modified_at": { "type": "string", "format": "date-time", "readOnly": true }, "created_by": { "type": "string", "readOnly": true }, "button_color": { "type": "string" }, "button_placement": { "type": "string", "enum": [ "map", "map_task" ], "x-onboard-source": "serializer-or-model-choices" }, "button_title": { "type": "string" }, "is_enabled": { "type": "boolean" }, "filters": { "type": "object" }, "filters_rql": { "type": "string" }, "workflow_events": { "type": "string", "readOnly": true }, "is_hidden": { "type": "boolean" }, "schedule_type": { "type": "string", "enum": [ "daily", "weekly", "monthly" ], "x-onboard-source": "serializer-or-model-choices" }, "schedule_day": { "type": "integer", "description": "Day of the week as an integer (0 for Monday, 6 for Sunday)" }, "schedule_time": { "type": "string", "format": "time" } }, "required": [ "name", "workflow_type" ] }, "ModelEnum_o_workflows_HistoricalWorkflow_workflow_type": { "description": "Allowed stored values for Django model `HistoricalWorkflow.workflow_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "quick_action", "event", "scheduled" ] }, "ModelEnum_o_workflows_HistoricalWorkflow_trigger": { "description": "Allowed stored values for Django model `HistoricalWorkflow.trigger` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "map-created", "map-updated", "map-status-updated", "map-owner-updated", "map-task-created", "map-task-assignee-updated", "map-task-due-date-updated", "map-task-status-updated", "map-section-completed", "discussion-message-created", "customer-created", "customer-updated", "custom-form-submitted" ] }, "ModelEnum_o_workflows_HistoricalWorkflow_button_placement": { "description": "Allowed stored values for Django model `HistoricalWorkflow.button_placement` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "map", "map_task" ] }, "ModelEnum_o_workflows_HistoricalWorkflow_schedule_type": { "description": "Allowed stored values for Django model `HistoricalWorkflow.schedule_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "daily", "weekly", "monthly" ] }, "ModelEnum_o_workflows_HistoricalWorkflow_history_type": { "description": "Allowed stored values for Django model `HistoricalWorkflow.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_workflows_Workflow_workflow_type": { "description": "Allowed stored values for Django model `Workflow.workflow_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "quick_action", "event", "scheduled" ] }, "ModelEnum_o_workflows_Workflow_trigger": { "description": "Allowed stored values for Django model `Workflow.trigger` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "map-created", "map-updated", "map-status-updated", "map-owner-updated", "map-task-created", "map-task-assignee-updated", "map-task-due-date-updated", "map-task-status-updated", "map-section-completed", "discussion-message-created", "customer-created", "customer-updated", "custom-form-submitted" ] }, "ModelEnum_o_workflows_Workflow_button_placement": { "description": "Allowed stored values for Django model `Workflow.button_placement` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "map", "map_task" ] }, "ModelEnum_o_workflows_Workflow_schedule_type": { "description": "Allowed stored values for Django model `Workflow.schedule_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "daily", "weekly", "monthly" ] }, "ModelEnum_o_workflows_HistoricalWorkflowAction_action_type": { "description": "Allowed stored values for Django model `HistoricalWorkflowAction.action_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "send_email", "slack", "update_customer_fields", "update_map_fields", "update_map_variables", "refresh_map_tasks", "create_map" ] }, "ModelEnum_o_workflows_HistoricalWorkflowAction_history_type": { "description": "Allowed stored values for Django model `HistoricalWorkflowAction.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_workflows_WorkflowAction_action_type": { "description": "Allowed stored values for Django model `WorkflowAction.action_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "send_email", "slack", "update_customer_fields", "update_map_fields", "update_map_variables", "refresh_map_tasks", "create_map" ] }, "ModelEnum_o_workflows_HistoricalWorkflowEvent_status": { "description": "Allowed stored values for Django model `HistoricalWorkflowEvent.status` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "success", "filtered", "error", "running" ] }, "ModelEnum_o_workflows_HistoricalWorkflowEvent_history_type": { "description": "Allowed stored values for Django model `HistoricalWorkflowEvent.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_workflows_WorkflowEvent_status": { "description": "Allowed stored values for Django model `WorkflowEvent.status` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "success", "filtered", "error", "running" ] }, "ModelEnum_o_workflows_HistoricalWorkflowCategory_history_type": { "description": "Allowed stored values for Django model `HistoricalWorkflowCategory.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_workflows_HistoricalWorkflowRecipe_object": { "description": "Allowed stored values for Django model `HistoricalWorkflowRecipe.object` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "customer", "map", "variable", "task" ] }, "ModelEnum_o_workflows_HistoricalWorkflowRecipe_icon": { "description": "Allowed stored values for Django model `HistoricalWorkflowRecipe.icon` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "activity", "airplay", "alert-circle", "alert-octagon", "alert-triangle", "align-center", "align-justify", "align-left", "align-right", "anchor", "aperture", "archive", "arrange", "arrange-double", "arrow-down", "arrow-down-circle", "arrow-left", "arrow-right", "arrow-up", "at-sign", "award", "bar-chart", "battery", "battery-charging", "bell", "bell-off", "bluetooth", "bold", "book-open", "bookmark", "box", "briefcase", "calendar", "camera", "camera-off", "cast", "check", "check-circle", "check-inside", "check-square", "check-uncheck", "chevron-down", "chevron-left", "chevron-right", "chevron-up", "chevrons-down", "chevrons-left", "chevrons-right", "chevrons-up", "chrome", "circle", "circle-check", "circle-check-full", "circle-full", "clipboard", "clock", "cloud", "cloud-drizzle", "cloud-lightning", "cloud-off", "cloud-rain", "cloud-snow", "code", "compass", "copy", "cpu", "credit-card", "crop", "crosshair", "database", "delete", "disc", "dollar-sign", "download", "download-cloud", "droplet", "edit", "external-link", "eye", "eye-off", "feather", "file", "file-text", "film", "filter", "flag", "folder", "folder-minus", "folder-plus", "framer", "frown", "gantt", "gift", "git-branch", "git-commit", "git-merge", "git-pull-request", "github", "gitlab", "globe", "grid", "hard-drive", "hash", "heart", "help-circle", "home", "image", "inbox", "info", "instagram", "italic", "key", "layers", "layout", "life-buoy", "link", "link-2", "linkedin", "list", "loader", "lock", "log-in", "log-out", "mail", "map", "map-pin", "maximize", "menu", "message-circle", "message-square", "mic", "mic-off", "minimize", "minus", "minus-circle", "monitor", "moon", "more-horizontal", "more-vertical", "mouse-pointer", "music", "navigation", "navigation-2", "octagon", "onboard", "package", "paperclip", "pause", "pause-circle", "pen-tool", "pencil", "percent", "phone", "phone-call", "phone-forwarded", "phone-incoming", "phone-missed", "phone-off", "phone-outgoing", "pie-chart", "play", "play-circle", "plus", "plus-circle", "power", "printer", "radio", "refresh", "refresh-ccw", "refresh-cw", "remove", "remove-circle", "repeat", "rewind", "rotate-ccw", "rotate-cw", "rss", "save", "scissors", "search", "send", "server", "settings", "share", "share-2", "shield", "shield-off", "shopping-bag", "shopping-cart", "skip-back", "skip-forward", "slash", "sliders", "smile", "sort", "sparkling", "speaker", "square", "star", "stop-circle", "sun", "tag", "target", "thermometer", "thumbs-down", "thumbs-up", "trash", "trash-2", "trending-down", "trending-up", "twitter", "type", "underline", "upload", "upload-cloud", "user", "user-check", "user-minus", "user-plus", "user-x", "users", "video", "video-off", "voicemail", "volume", "volume-2", "volume-x", "watch", "wifi", "wifi-off", "x", "x-circle", "x-square", "zap", "zap-off", "zoom-in", "zoom-out" ] }, "ModelEnum_o_workflows_HistoricalWorkflowRecipe_history_type": { "description": "Allowed stored values for Django model `HistoricalWorkflowRecipe.history_type` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "+", "~", "-" ] }, "ModelEnum_o_workflows_WorkflowRecipe_object": { "description": "Allowed stored values for Django model `WorkflowRecipe.object` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "customer", "map", "variable", "task" ] }, "ModelEnum_o_workflows_WorkflowRecipe_icon": { "description": "Allowed stored values for Django model `WorkflowRecipe.icon` (from field choices). Use these literals in API payloads and filters.", "type": "string", "enum": [ "activity", "airplay", "alert-circle", "alert-octagon", "alert-triangle", "align-center", "align-justify", "align-left", "align-right", "anchor", "aperture", "archive", "arrange", "arrange-double", "arrow-down", "arrow-down-circle", "arrow-left", "arrow-right", "arrow-up", "at-sign", "award", "bar-chart", "battery", "battery-charging", "bell", "bell-off", "bluetooth", "bold", "book-open", "bookmark", "box", "briefcase", "calendar", "camera", "camera-off", "cast", "check", "check-circle", "check-inside", "check-square", "check-uncheck", "chevron-down", "chevron-left", "chevron-right", "chevron-up", "chevrons-down", "chevrons-left", "chevrons-right", "chevrons-up", "chrome", "circle", "circle-check", "circle-check-full", "circle-full", "clipboard", "clock", "cloud", "cloud-drizzle", "cloud-lightning", "cloud-off", "cloud-rain", "cloud-snow", "code", "compass", "copy", "cpu", "credit-card", "crop", "crosshair", "database", "delete", "disc", "dollar-sign", "download", "download-cloud", "droplet", "edit", "external-link", "eye", "eye-off", "feather", "file", "file-text", "film", "filter", "flag", "folder", "folder-minus", "folder-plus", "framer", "frown", "gantt", "gift", "git-branch", "git-commit", "git-merge", "git-pull-request", "github", "gitlab", "globe", "grid", "hard-drive", "hash", "heart", "help-circle", "home", "image", "inbox", "info", "instagram", "italic", "key", "layers", "layout", "life-buoy", "link", "link-2", "linkedin", "list", "loader", "lock", "log-in", "log-out", "mail", "map", "map-pin", "maximize", "menu", "message-circle", "message-square", "mic", "mic-off", "minimize", "minus", "minus-circle", "monitor", "moon", "more-horizontal", "more-vertical", "mouse-pointer", "music", "navigation", "navigation-2", "octagon", "onboard", "package", "paperclip", "pause", "pause-circle", "pen-tool", "pencil", "percent", "phone", "phone-call", "phone-forwarded", "phone-incoming", "phone-missed", "phone-off", "phone-outgoing", "pie-chart", "play", "play-circle", "plus", "plus-circle", "power", "printer", "radio", "refresh", "refresh-ccw", "refresh-cw", "remove", "remove-circle", "repeat", "rewind", "rotate-ccw", "rotate-cw", "rss", "save", "scissors", "search", "send", "server", "settings", "share", "share-2", "shield", "shield-off", "shopping-bag", "shopping-cart", "skip-back", "skip-forward", "slash", "sliders", "smile", "sort", "sparkling", "speaker", "square", "star", "stop-circle", "sun", "tag", "target", "thermometer", "thumbs-down", "thumbs-up", "trash", "trash-2", "trending-down", "trending-up", "twitter", "type", "underline", "upload", "upload-cloud", "user", "user-check", "user-minus", "user-plus", "user-x", "users", "video", "video-off", "voicemail", "volume", "volume-2", "volume-x", "watch", "wifi", "wifi-off", "x", "x-circle", "x-square", "zap", "zap-off", "zoom-in", "zoom-out" ] } } }, "security": [ { "ApiKeyAuth": [] } ], "tags": [ { "name": "Activity" }, { "name": "Assets" }, { "name": "Comments" }, { "name": "Custom" }, { "name": "Email" }, { "name": "Forms" }, { "name": "Hooks" }, { "name": "Map" }, { "name": "Platform" }, { "name": "Stats" }, { "name": "Workflows" } ] }