### Get Team Members API Response Sample Source: https://developer.kickflow.com/rest/spec This is a sample response for the get team members API, detailing the structure of team membership information. ```json [ { "grades": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "level": 255, "code": "string", "isDefault": false, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "leader": true, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "email": "user@example.com", "code": "string", "firstName": "string", "lastName": "string", "fullName": "string", "employeeId": "string", "image": { "100x100": "string", "64x64": "string", "32x32": "string" }, "status": "invited", "locale": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "deactivatedAt": "2019-08-24T14:15:22Z" } ] ``` -------------------------------- ### Get Audit Logs List Response Sample Source: https://developer.kickflow.com/rest/spec This is a sample JSON response for retrieving a list of audit logs. It includes pagination and sorting parameters. ```json [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "user": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "email": "user@example.com", "code": "string", "firstName": "string", "lastName": "string", "fullName": "string", "employeeId": "string", "image": { "100x100": "string", "64x64": "string", "32x32": "string" }, "status": "invited", "locale": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "deactivatedAt": "2019-08-24T14:15:22Z" }, "action": "string", "data": { }, "remoteIp": "string", "systemType": "automation", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ] ``` -------------------------------- ### Get Workflows List Source: https://developer.kickflow.com/rest/spec Retrieves a list of workflows, with options to filter by status. Supports pagination and sorting. ```json [ { "id": "string", "code": "string", "versionId": "string", "versionNumber": 0, "name": "string", "description": "string", "status": "visible", "publicTicket": false, "visibleToManager": "none", "visibleToTeamMembers": false, "titleDescription": "string", "ticketNumberFormat": "string", "overwritable": true, "createdAt": "string", "updatedAt": "string", "titleInputMode": "none", "titleFormula": "string", "allowEditingOfViewers": true, "author": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "email": "user@example.com", "code": "string", "firstName": "string", "lastName": "string", "fullName": "string", "employeeId": "string", "image": { "100x100": "string", "64x64": "string", "32x32": "string" }, "status": "invited", "locale": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "deactivatedAt": "2019-08-24T14:15:22Z" }, "versionAuthor": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "email": "user@example.com", "code": "string", "firstName": "string", "lastName": "string", "fullName": "string", "employeeId": "string", "image": { "100x100": "string", "64x64": "string", "32x32": "string" }, "status": "invited", "locale": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "deactivatedAt": "2019-08-24T14:15:22Z" }, "folder": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "code": "string", "description": "string", "workflowsCount": 0, "routesCount": 0, "pipelinesCount": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }, "categories": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ] } ] ``` -------------------------------- ### Get Ticket Viewers Response Sample Source: https://developer.kickflow.com/rest/spec This is a sample JSON response for retrieving viewers of a ticket. It includes user, team, and grade details for each viewer. ```json [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "user": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "email": "user@example.com", "code": "string", "firstName": "string", "lastName": "string", "fullName": "string", "employeeId": "string", "image": { "100x100": "string", "64x64": "string", "32x32": "string" }, "status": "invited", "locale": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "deactivatedAt": "2019-08-24T14:15:22Z" }, "team": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "fullName": "string", "code": "string", "notes": "string", "approveOnly": true, "usersCount": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }, "grade": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "level": 255, "code": "string", "isDefault": false, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }, "descendants": true } ] ``` -------------------------------- ### Get Workflows Source: https://developer.kickflow.com/rest/spec Retrieves a list of workflows. Filtering by status is available. Supports pagination and sorting. ```APIDOC ## GET /v1/workflows ### Description Retrieves a list of workflows. Filtering by status is available. Supports pagination and sorting. ### Method GET ### Endpoint https://api.kickflow.com/v1/workflows ### Parameters #### Query Parameters - **page** (integer) - Optional - Page number. 1 is the first page. Default: 1 - **perPage** (integer) - Optional - Number of items per page. Default: 25. Range: [1 .. 100] - **sortBy** (string) - Optional - Field and order for sorting. Possible fields: createdAt, updatedAt, name, status. Example: "createdAt-desc" - **status** (Array of strings) - Optional - Filter by status. Possible values: "visible", "invisible" ### Responses #### Success Response (200) OK. Response sample: ```json [ { "id": "string", "code": "string", "versionId": "string", "versionNumber": 0, "name": "string", "description": "string", "status": "visible", "publicTicket": false, "visibleToManager": "none", "visibleToTeamMembers": false, "titleDescription": "string", "ticketNumberFormat": "string", "overwritable": true, "createdAt": "string", "updatedAt": "string", "titleInputMode": "none", "titleFormula": "string", "allowEditingOfViewers": true, "author": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "email": "user@example.com", "code": "string", "firstName": "string", "lastName": "string", "fullName": "string", "employeeId": "string", "image": { "100x100": "string", "64x64": "string", "32x32": "string" }, "status": "invited", "locale": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "deactivatedAt": "2019-08-24T14:15:22Z" }, "versionAuthor": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "email": "user@example.com", "code": "string", "firstName": "string", "lastName": "string", "fullName": "string", "employeeId": "string", "image": { "100x100": "string", "64x64": "string", "32x32": "string" }, "status": "invited", "locale": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "deactivatedAt": "2019-08-24T14:15:22Z" }, "folder": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "code": "string", "description": "string", "workflowsCount": 0, "routesCount": 0, "pipelinesCount": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }, "categories": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ] } ] ``` #### Error Responses - **400** Bad Request - **401** Unauthorized - **403** Forbidden - **404** Not Found - **422** Unprocessable Content - **500** Internal Server Error - **504** Gateway Timeout ``` -------------------------------- ### Get Audit Logs Source: https://developer.kickflow.com/rest/spec Retrieves a list of audit logs. Supports filtering and pagination. ```APIDOC ## Get Audit Logs ### Description Retrieves a list of audit logs. Supports filtering and pagination. ### Method GET ### Endpoint /v1/auditLogs ### Query Parameters - **page** (integer, optional, default: 1) - Page number. - **perPage** (integer, optional, default: 25) - Number of items per page (1-100). - **sortBy** (string, optional) - Sort field and order. Only `createdAt` is supported, with optional `-asc` or `-desc` suffix. - **createdAtStart** (string, optional) - Start date for filtering by creation date. - **createdAtEnd** (string, optional) - End date for filtering by creation date. - **userId** (string, optional) - Filter by user ID (UUID). ### Responses #### Success Response (200) OK. Returns a list of audit log entries. #### Error Responses - **400** Bad Request - **401** Unauthorized - **403** Forbidden - **404** Not Found - **422** Unprocessable Content - **500** Internal Server Error - **504** Gateway Timeout ### Request Example ```json { "example": "request body" } ``` ### Response Example (200 OK) ```json [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "user": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "email": "user@example.com", "code": "string", "firstName": "string", "lastName": "string", "fullName": "string", "employeeId": "string", "image": { "100x100": "string", "64x64": "string", "32x32": "string" }, "status": "invited", "locale": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "deactivatedAt": "2019-08-24T14:15:22Z" }, "action": "string", "data": {}, "remoteIp": "string", "systemType": "automation", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ] ``` ``` -------------------------------- ### Get Tickets Source: https://developer.kickflow.com/rest/spec Retrieves a list of tickets. Supports filtering by multiple conditions. Note that form input and approval routes are excluded for performance reasons. To get detailed ticket information, use the Get a single ticket API. ```APIDOC ## GET /v1/tickets ### Description Retrieves a list of tickets. Supports filtering by multiple conditions. Note that form input and approval routes are excluded for performance reasons. To get detailed ticket information, use the Get a single ticket API. ### Method GET ### Endpoint https://api.kickflow.com/v1/tickets ### Query Parameters - **page** (integer >= 1) - Optional - Default: 1 - Page number. - **perPage** (integer [1..100]) - Optional - Default: 25 - Number of items per page. - **sortBy** (string) - Optional - Sort field and order. Possible values: createdAt, updatedAt, with optional suffix (-asc, -desc). - **status** (string or Array of strings) - Optional - Array of statuses. - **subStatusIds** (Array of strings ) - Optional - Array of sub-status UUIDs. - **workflowId** (string) - Optional - Workflow UUID. - **authorId** (string) - Optional - Author UUID. - **authorTeamFullName** (string) - Optional - Full name of the team including parent organizations at the time of application. - **ticketNumber** (string) - Optional - Ticket number. - **createdAtStart** (string) - Optional - Start of creation date and time. - **createdAtEnd** (string) - Optional - End of creation date and time. - **updatedAtStart** (string) - Optional - Start of update date and time. - **updatedAtEnd** (string) - Optional - End of update date and time. - **openedAtStart** (string) - Optional - Start of opening date and time. - **openedAtEnd** (string) - Optional - End of opening date and time. - **completedAtStart** (string) - Optional - Start of completion date and time. - **completedAtEnd** (string) - Optional - End of completion date and time. - **archivedAtStart** (string) - Optional - Start of archiving date and time. - **archivedAtEnd** (string) - Optional - End of archiving date and time. - **assigneeUserId** (string ) - Optional - Approver UUID. Specify with assigneeStatus. - **assigneeStatus** (Array of strings) - Optional - Approver status. Items Enum: "all", "current", "approved". Specify with assigneeUserId. - **stepTitle** (string) - Optional - Current approval step title. ### Responses #### Success Response (200) OK #### Error Responses - **400** Bad Request - **401** Unauthorized - **403** Forbidden - **404** Not Found - **422** Unprocessable Content - **500** Internal Server Error - **504** Gateway Timeout ``` -------------------------------- ### Get Attachment Info Source: https://developer.kickflow.com/rest/spec Retrieves information about an attachment, including its pre-signed URL for Amazon S3. ```APIDOC ## GET /v1/files/{signedId} ### Description Retrieves information about an attachment, including its URL on Amazon S3. Note: The URL returned by this API expires in 5 minutes. Note: Files not attached to a ticket cannot have their URL retrieved. Please attach them to a ticket first. ### Method GET ### Endpoint https://api.kickflow.com/v1/files/{signedId} ### Parameters #### Path Parameters - **signedId** (string) - Required - The signed ID of the attachment. ``` -------------------------------- ### Get Workflow by ID Source: https://developer.kickflow.com/rest/spec Retrieves a specific workflow by its ID. ```APIDOC ## GET /v1/workflows/{workflowId} ### Description Retrieves a specific workflow by its ID. ### Method GET ### Endpoint https://api.kickflow.com/v1/workflows/{workflowId} ### Parameters #### Path Parameters - **workflowId** (string) - Required - The UUID or code of the workflow. ### Responses #### Success Response (200) OK #### Error Responses - **400** Bad Request - **401** Unauthorized - **403** Forbidden - **404** Not Found - **422** Unprocessable Content - **500** Internal Server Error - **504** Gateway Timeout ``` -------------------------------- ### Get Ticket Viewers Source: https://developer.kickflow.com/rest/spec Retrieves a list of viewers for a specific ticket. ```APIDOC ## GET /v1/tickets/{ticketId}/viewers ### Description Retrieves a list of viewers for a specific ticket. ### Method GET ### Endpoint https://api.kickflow.com/v1/tickets/{ticketId}/viewers ### Parameters #### Path Parameters - **ticketId** (string) - Required - The UUID of the ticket. #### Query Parameters - **page** (integer) - Optional - Default: 1. The page number. - **perPage** (integer) - Optional - Default: 25. The number of items per page (between 1 and 100). - **sortBy** (string) - Optional - Sort field and order. Allowed values: `createdAt` (asc/desc). ### Responses #### Success Response (200) OK #### Error Responses - **400** Bad Request - **401** Unauthorized - **403** Forbidden - **404** Not Found - **422** Unprocessable Content - **500** Internal Server Error - **504** Gateway Timeout ### Response Example (200) ```json [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "user": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "email": "user@example.com", "code": "string", "firstName": "string", "lastName": "string", "fullName": "string", "employeeId": "string", "image": { "100x100": "string", "64x64": "string", "32x32": "string" }, "status": "invited", "locale": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "deactivatedAt": "2019-08-24T14:15:22Z" }, "team": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "fullName": "string", "code": "string", "notes": "string", "approveOnly": true, "usersCount": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }, "grade": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "level": 255, "code": "string", "isDefault": false, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }, "descendants": true } ] ``` ``` -------------------------------- ### Get Authorizations Source: https://developer.kickflow.com/rest/spec Retrieves a list of authorization requests assigned to the current user. Supports filtering by status, dates, assignees, and more. ```APIDOC ## GET /v1/tickets/tasks ### Description Retrieves a list of authorization requests assigned to the current user. Multiple conditions can be combined for filtering. Note: For performance reasons, form inputs and approval routes are not included in the response for ticket lists. To get more detailed ticket information, please use the API to retrieve a single ticket. ### Method GET ### Endpoint https://api.kickflow.com/v1/tickets/tasks ### Parameters #### Query Parameters - **page** (integer >= 1) - Optional - Default: 1 - Page number. - **perPage** (integer [1..100]) - Optional - Default: 25 - Number of items per page. - **sortBy** (string) - Optional - Sort target field and order. Possible fields: createdAt, updatedAt, openedAt, assignedToMeAt. - **status** (Array of strings) - Optional - Items Enum: "draft", "in_progress", "rejected", "completed", "deleted" - Array of statuses. - **subStatusIds** (Array of strings ) - Optional - Array of sub-status UUIDs. - **workflowId** (string) - Optional - UUID of the workflow. - **authorId** (string) - Optional - UUID of the applicant. - **authorTeamFullName** (string) - Optional - Full name of the team selected during application, including parent organizations. - **ticketNumber** (string) - Optional - Ticket number. - **createdAtStart** (string ) - Optional - Start of creation date. - **createdAtEnd** (string ) - Optional - End of creation date. - **updatedAtStart** (string ) - Optional - Start of update date. - **updatedAtEnd** (string ) - Optional - End of update date. - **openedAtStart** (string ) - Optional - Start of application date. - **openedAtEnd** (string ) - Optional - End of application date. - **assignedToMeAtStart** (string ) - Optional - Start of assignment date. - **assignedToMeAtEnd** (string ) - Optional - End of assignment date. - **completedAtStart** (string ) - Optional - Start of completion date. - **completedAtEnd** (string ) - Optional - End of completion date. - **archivedAtStart** (string ) - Optional - Start of archive date. - **archivedAtEnd** (string ) - Optional - End of archive date. - **stepTitle** (string) - Optional - Current approval step title. - **pending** (string) - Optional - Enum: "true", "false" - Filters tickets by pending status. 'true': only pending tickets, 'false': only non-pending tickets. ### Responses #### Success Response (200) OK #### Error Responses - **400** Bad Request - **401** Unauthorized - **403** Forbidden - **404** Not Found - **422** Unprocessable Content - **500** Internal Server Error - **504** Gateway Timeout ``` -------------------------------- ### Get Team Memberships Source: https://developer.kickflow.com/rest/spec Retrieves a list of members belonging to a specific team. Requires team management permissions. Supports pagination. ```APIDOC ## GET /v1/organizationCharts/{organizationChartId}/teams/{teamId}/memberships ### Description Retrieves a list of members belonging to a specific team. Requires team management permissions. ### Method GET ### Endpoint /v1/organizationCharts/{organizationChartId}/teams/{teamId}/memberships ### Parameters #### Path Parameters - **organizationChartId** (string ) - Required - The UUID of the organization chart. - **teamId** (string) - Required - The UUID or code of the team. #### Query Parameters - **page** (integer >= 1) - Optional - Default: 1 - The page number, where 1 is the first page. - **perPage** (integer [1..100]) - Optional - Default: 25 - The number of items per page. ### Responses #### Success Response (200) OK #### Response Example (200) ```json [ { "grades": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "level": 255, "code": "string", "isDefault": false, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "leader": true, "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "email": "user@example.com", "code": "string", "firstName": "string", "lastName": "string", "fullName": "string", "employeeId": "string", "image": { "100x100": "string", "64x64": "string", "32x32": "string" }, "status": "invited", "locale": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "deactivatedAt": "2019-08-24T14:15:22Z" } ] ``` #### Error Responses - **400** Bad Request - **401** Unauthorized - **403** Forbidden - **404** Not Found - **422** Unprocessable Content - **500** Internal Server Error - **504** Gateway Timeout ``` -------------------------------- ### Create Proxy Approver Request Payload Source: https://developer.kickflow.com/rest/spec This JSON payload is used to create a new proxy approver. It includes the user IDs for the proxy and the user being proxied, along with optional start and end dates and a list of workflow IDs. ```json { "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b", "proxyUserId": "18322d52-b82e-4911-b409-4ba49f870c3b", "startsOn": "2019-08-24", "endsOn": "2019-08-24", "workflowIds": [ "497f6eca-6276-4993-bfeb-53cbbbba6f08" ] } ``` -------------------------------- ### Get Workflow by ID Source: https://developer.kickflow.com/rest/spec Retrieves a specific workflow using its unique ID or code. This endpoint is useful for fetching detailed information about a single workflow. ```http GET /v1/workflows/{workflowId} HTTP/1.1 Host: api.kickflow.com Accept: application/json Authorization: Bearer YOUR_ACCESS_TOKEN ``` -------------------------------- ### Create Proxy Approver Response (200 OK) Source: https://developer.kickflow.com/rest/spec This is a sample successful response when creating a proxy approver. It returns the details of the created proxy approval, including user information, dates, and associated workflows. ```json { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "user": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "email": "user@example.com", "code": "string", "firstName": "string", "lastName": "string", "fullName": "string", "employeeId": "string", "image": { "100x100": "string", "64x64": "string", "32x32": "string" }, "status": "invited", "locale": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "deactivatedAt": "2019-08-24T14:15:22Z" }, "proxyUser": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "email": "user@example.com", "code": "string", "firstName": "string", "lastName": "string", "fullName": "string", "employeeId": "string", "image": { "100x100": "string", "64x64": "string", "32x32": "string" }, "status": "invited", "locale": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "deactivatedAt": "2019-08-24T14:15:22Z" }, "startsOn": "2019-08-24", "endsOn": "2019-08-24", "workflows": [ { "id": "string", "code": "string", "versionId": "string", "versionNumber": 0, "name": "string", "description": "string", "status": "visible", "publicTicket": false, "visibleToManager": "none", "visibleToTeamMembers": false, "titleDescription": "string", "ticketNumberFormat": "string", "overwritable": true, "createdAt": "string", "updatedAt": "string", "titleInputMode": "none", "titleFormula": "string", "allowEditingOfViewers": true, "author": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "email": "user@example.com", "code": "string", "firstName": "string", "lastName": "string", "fullName": "string", "employeeId": "string", "image": { "100x100": "string", "64x64": "string", "32x32": "string" }, "status": "invited", "locale": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "deactivatedAt": "2019-08-24T14:15:22Z" }, "versionAuthor": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "email": "user@example.com", "code": "string", "firstName": "string", "lastName": "string", "fullName": "string", "employeeId": "string", "image": { "100x100": "string", "64x64": "string", "32x32": "string" }, "status": "invited", "locale": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "deactivatedAt": "2019-08-24T14:15:22Z" }, "folder": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "code": "string", "description": "string", "workflowsCount": 0, "routesCount": 0, "pipelinesCount": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }, "categories": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ] } ] } ``` -------------------------------- ### User Response Sample Source: https://developer.kickflow.com/rest/spec This is a sample JSON response for user-related API calls, illustrating the structure of user data returned by the API. ```json { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "email": "user@example.com", "code": "string", "firstName": "string", "lastName": "string", "fullName": "string", "employeeId": "string", "image": { "100x100": "string", "64x64": "string", "32x32": "string" }, "status": "invited", "locale": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "deactivatedAt": "2019-08-24T14:15:22Z" } ``` -------------------------------- ### Sample Workflow Response Source: https://developer.kickflow.com/rest/spec This is a sample JSON response for a workflow. It includes timestamps, dates, input field details, and potential error messages. ```json { "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "startsOn": "2019-08-24", "endsOn": "2019-08-24", "inputs": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "value": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "field": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "title": "string", "description": "string", "code": "string", "fieldType": "text", "required": true, "visible": true, "options": [ null ], "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } } ], "errorMessage": "string" } ``` -------------------------------- ### Upload File Response Sample Source: https://developer.kickflow.com/rest/spec This JSON response is returned after successfully uploading a file, containing a signed ID for the uploaded file. ```json { "signedId": "string" } ``` -------------------------------- ### Add Team Member API Request Sample Source: https://developer.kickflow.com/rest/spec This is a sample request payload for adding members to a team. It specifies the user IDs and their leadership status. ```json { "users": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "leader": true, "gradeIds": [ "497f6eca-6276-4993-bfeb-53cbbbba6f08" ] } ] } ``` -------------------------------- ### Delete Team API Response Sample Source: https://developer.kickflow.com/rest/spec This is a sample response for the delete team API when validation fails. ```json { "code": "validation_failed", "message": "hoge must not be empty" } ```