Astravue API
  1. Schemas
Astravue API
  • Welcome to the Astravue API
  • Auth
    • Get Access and Refresh Token
    • Refresh Access Token
  • Personal Tasks
    • Get task by ID
    • Update a task
    • Delete a task
    • Get all tasks
    • Create a task
  • Spaces
    • Get space by ID
    • Update a space
    • Delete a space
    • Get all spaces
    • Create a new space
  • Projects
    • Get project details by ID
    • Update a project
    • Delete a project
    • Get all projects in a space
    • Create a new project
  • Project Tasks
    • Get a project task by ID
    • Update a project task
    • Delete a project task
    • Get all tasks in a project
    • Create a project task
  • Task Timer
    • Get timers for a user in a task
    • Get active timers for a user
    • Update a timer
    • Stop timer for a task
    • Delete a timer entry
    • Start timer for a personal task
    • Add a time range entry for a personal task
    • Add manual time entry for a personal task
    • Start timer for a project task
    • Add range timer for a project task
    • Add manual time entry for a project task
  • Task Comments
    • Get comments for a task
  • Project Subtasks
    • Get all subtasks for a project task
  • Personal Subtasks
    • Get all subtasks for a personal task
  • Tasks Checklist
    • Get all checklists for a subtask
    • Get all checklists for a parent task
  • Schemas
    • Schemas
      • ApiError
      • TimerData
      • NotificationReadResponseDto
      • FieldError
      • TimerUpdateRequest
      • NotificationDto
      • ApiSuccessResponseListTaskCheckListDto
      • TimeTrackerDto
      • TaskCommentDto
      • TaskCheckListDto
      • TaskListResponse
      • TaskUpdateRequest
      • NotificationDeleteRequestDto
      • ApiSuccessResponseTaskDto
      • TimerRequest
      • NotificationDeleteResponseDto
      • ApiSuccessResponseListTaskCommentDto
      • CustomFieldOptionDto
      • RangeTimerRequest
      • ApiSuccessResponseSubtaskListResponse
      • OrgRoleDto
      • ManualTimerRequest
      • SubtaskListResponse
      • TaskCustomFieldDto
      • TaskTimerResponseDto
      • TaskDependencyDto
      • TaskDto
      • TaskFieldValue
      • TaskPriorityDto
      • TaskResponseDto
      • TaskStatusDto
      • TaskTagDto
      • UserDisplayDto
      • SpaceUpdateRequest
      • ApiSuccessResponseSpaceDto
      • SpaceDto
      • SpaceMemberDto
      • SpaceRoleDto
      • ProjectUpdateRequest
      • AccountLabelDto
      • ApiSuccessResponseProjectDto
      • ContactDto
      • ContactProperties
      • ContactTagDto
      • ProjectDto
      • ProjectHealthDto
      • ProjectMemberDto
      • ProjectPriorityDto
      • ProjectRoleDto
      • ProjectStatusDto
      • ProjectTagDto
      • ProjectTaskUpdateRequest
      • AppDto
      • ResponseFormat
      • OrgMemberDto
      • UserPreference
      • UserPreferenceProperties
      • PasswordUpdateDto
      • UserDetailDto
      • MemberPreferenceDto
      • WidgetProperties
      • TimeMapDto
      • TaskStatusTemplateDto
      • DefaultProjectTaskStatusesTemplateDto
      • EmailContent
      • AttachmentDto
      • ReminderModeDto
      • TaskReminderDto
      • DailyRecurrenceSettings
      • DaysAfterRecurrenceSettings
      • FieldsToInclude
      • MonthlyRecurrenceSettings
      • TaskRecurrenceDto
      • WeeklyRecurrenceSettings
      • YearlyRecurrenceSettings
      • TaskListDto
      • OrganizationDto
      • Address
      • BillingAndAccountInfo
      • Filter
      • FilterList
      • FilterViewDto
      • CalendarEvent
      • EventReminder
      • ContactNotesDto
      • ColumnPreferenceDto
      • ColumnPreferenceProperties
      • AccountDto
      • AccountTagDto
      • ContactLabelDto
      • TaskCreateRequest
      • SpaceCreateRequest
      • ProjectCreateRequest
      • ProjectTaskCreateRequest
      • FileUploadDto
      • GlobalTaskStatusesTemplateDto
      • PasswordResetDto
      • UserDto
      • InviteUserDto
      • UserActivity
      • UserActivityKey
      • ApiSuccessResponseTaskListResponse
      • ApiSuccessResponseProjectListResponse
      • ApiSuccessResponseListSpaceDto
      • ProjectListResponse
      • ApiSuccessResponseObject
      • BackupUserActivity
  1. Schemas

ApiSuccessResponseProjectListResponse

Standard API success response structure

{
    "success": true,
    "message": "Operation completed successfully",
    "code": 200,
    "data": {
        "tenantId": 0,
        "spaceId": 0,
        "projects": [
            {
                "tenantId": 0,
                "spaceId": 0,
                "projectId": 0,
                "contact": {
                    "tenantId": 0,
                    "contactId": 0,
                    "contactName": "string",
                    "email": "string",
                    "phone": {
                        "countryCode": "string",
                        "number": "string",
                        "countryName": "string"
                    },
                    "mobile": {
                        "countryCode": "string",
                        "number": "string",
                        "countryName": "string"
                    },
                    "address": "string",
                    "city": "string",
                    "country": "string",
                    "state": "string",
                    "zipCode": "string",
                    "website": "string",
                    "profilePicURL": "string",
                    "profilePicName": "string",
                    "profilePicColor": "string",
                    "createdBy": {
                        "userId": 0,
                        "firstName": "string",
                        "lastName": "string",
                        "email": "string",
                        "profilePicURL": "string",
                        "profilePicName": "string",
                        "profilePicColor": "string",
                        "provider": "string",
                        "newUser": true,
                        "isTourCompleted": true,
                        "about": "string",
                        "updateTime": "2019-08-24T14:15:22Z",
                        "expiryDate": "2019-08-24T14:15:22Z",
                        "status": "string",
                        "role": {
                            "orgRoleId": 0,
                            "roleName": "string"
                        }
                    },
                    "modifiedBy": {
                        "userId": 0,
                        "firstName": "string",
                        "lastName": "string",
                        "email": "string",
                        "profilePicURL": "string",
                        "profilePicName": "string",
                        "profilePicColor": "string",
                        "provider": "string",
                        "newUser": true,
                        "isTourCompleted": true,
                        "about": "string",
                        "updateTime": "2019-08-24T14:15:22Z",
                        "expiryDate": "2019-08-24T14:15:22Z",
                        "status": "string",
                        "role": {
                            "orgRoleId": 0,
                            "roleName": "string"
                        }
                    },
                    "createdTime": "2019-08-24T14:15:22Z",
                    "modifiedTime": "2019-08-24T14:15:22Z",
                    "account": {
                        "accountId": 0,
                        "accountName": "string",
                        "email": "string",
                        "profilePicUrl": "string",
                        "profilePicName": "string",
                        "profilePicColor": "string"
                    },
                    "contactTags": [
                        {
                            "tenantId": 0,
                            "contactTagId": 0,
                            "tagName": "string",
                            "color": "string",
                            "createdBy": 0,
                            "modifiedBy": 0
                        }
                    ],
                    "projectCount": 0
                },
                "projectName": "string",
                "description": "string",
                "startDate": "2019-08-24T14:15:22Z",
                "dueDate": "2019-08-24T14:15:22Z",
                "completion": 0,
                "deleted": true,
                "createdTime": "2019-08-24T14:15:22Z",
                "modifiedTime": "2019-08-24T14:15:22Z",
                "deletedTime": "2019-08-24T14:15:22Z",
                "completedTime": "2019-08-24T14:15:22Z",
                "createdBy": {
                    "userId": 0,
                    "firstName": "string",
                    "lastName": "string",
                    "email": "string",
                    "profilePicURL": "string",
                    "profilePicName": "string",
                    "profilePicColor": "string",
                    "provider": "string",
                    "newUser": true,
                    "isTourCompleted": true,
                    "about": "string",
                    "updateTime": "2019-08-24T14:15:22Z",
                    "expiryDate": "2019-08-24T14:15:22Z",
                    "status": "string",
                    "role": {
                        "orgRoleId": 0,
                        "roleName": "string"
                    }
                },
                "modifiedBy": {
                    "userId": 0,
                    "firstName": "string",
                    "lastName": "string",
                    "email": "string",
                    "profilePicURL": "string",
                    "profilePicName": "string",
                    "profilePicColor": "string",
                    "provider": "string",
                    "newUser": true,
                    "isTourCompleted": true,
                    "about": "string",
                    "updateTime": "2019-08-24T14:15:22Z",
                    "expiryDate": "2019-08-24T14:15:22Z",
                    "status": "string",
                    "role": {
                        "orgRoleId": 0,
                        "roleName": "string"
                    }
                },
                "deletedBy": {
                    "userId": 0,
                    "firstName": "string",
                    "lastName": "string",
                    "email": "string",
                    "profilePicURL": "string",
                    "profilePicName": "string",
                    "profilePicColor": "string",
                    "provider": "string",
                    "newUser": true,
                    "isTourCompleted": true,
                    "about": "string",
                    "updateTime": "2019-08-24T14:15:22Z",
                    "expiryDate": "2019-08-24T14:15:22Z",
                    "status": "string",
                    "role": {
                        "orgRoleId": 0,
                        "roleName": "string"
                    }
                },
                "projectStatus": {
                    "tenantId": 0,
                    "projectStatusId": 0,
                    "projectStatusName": "string",
                    "color": "string",
                    "projectStatusCategory": "string",
                    "createdTime": "2019-08-24T14:15:22Z",
                    "modifiedTime": "2019-08-24T14:15:22Z",
                    "createdBy": {
                        "userId": 0,
                        "firstName": "string",
                        "lastName": "string",
                        "email": "string",
                        "profilePicURL": "string",
                        "profilePicName": "string",
                        "profilePicColor": "string",
                        "provider": "string",
                        "newUser": true,
                        "isTourCompleted": true,
                        "about": "string",
                        "updateTime": "2019-08-24T14:15:22Z",
                        "expiryDate": "2019-08-24T14:15:22Z",
                        "status": "string",
                        "role": {
                            "orgRoleId": 0,
                            "roleName": "string"
                        }
                    },
                    "modifiedBy": {
                        "userId": 0,
                        "firstName": "string",
                        "lastName": "string",
                        "email": "string",
                        "profilePicURL": "string",
                        "profilePicName": "string",
                        "profilePicColor": "string",
                        "provider": "string",
                        "newUser": true,
                        "isTourCompleted": true,
                        "about": "string",
                        "updateTime": "2019-08-24T14:15:22Z",
                        "expiryDate": "2019-08-24T14:15:22Z",
                        "status": "string",
                        "role": {
                            "orgRoleId": 0,
                            "roleName": "string"
                        }
                    },
                    "default": true
                },
                "projectPriority": {
                    "tenantId": 0,
                    "projectPriorityId": 0,
                    "priorityLabel": "string",
                    "color": "string",
                    "createdBy": {
                        "userId": 0,
                        "firstName": "string",
                        "lastName": "string",
                        "email": "string",
                        "profilePicURL": "string",
                        "profilePicName": "string",
                        "profilePicColor": "string",
                        "provider": "string",
                        "newUser": true,
                        "isTourCompleted": true,
                        "about": "string",
                        "updateTime": "2019-08-24T14:15:22Z",
                        "expiryDate": "2019-08-24T14:15:22Z",
                        "status": "string",
                        "role": {
                            "orgRoleId": 0,
                            "roleName": "string"
                        }
                    },
                    "modifiedBy": {
                        "userId": 0,
                        "firstName": "string",
                        "lastName": "string",
                        "email": "string",
                        "profilePicURL": "string",
                        "profilePicName": "string",
                        "profilePicColor": "string",
                        "provider": "string",
                        "newUser": true,
                        "isTourCompleted": true,
                        "about": "string",
                        "updateTime": "2019-08-24T14:15:22Z",
                        "expiryDate": "2019-08-24T14:15:22Z",
                        "status": "string",
                        "role": {
                            "orgRoleId": 0,
                            "roleName": "string"
                        }
                    },
                    "default": true,
                    "primary": true
                },
                "projectHealth": {
                    "tenantId": 0,
                    "projectHealthId": 0,
                    "healthLabel": "string",
                    "color": "string",
                    "createdBy": {
                        "userId": 0,
                        "firstName": "string",
                        "lastName": "string",
                        "email": "string",
                        "profilePicURL": "string",
                        "profilePicName": "string",
                        "profilePicColor": "string",
                        "provider": "string",
                        "newUser": true,
                        "isTourCompleted": true,
                        "about": "string",
                        "updateTime": "2019-08-24T14:15:22Z",
                        "expiryDate": "2019-08-24T14:15:22Z",
                        "status": "string",
                        "role": {
                            "orgRoleId": 0,
                            "roleName": "string"
                        }
                    },
                    "modifiedBy": {
                        "userId": 0,
                        "firstName": "string",
                        "lastName": "string",
                        "email": "string",
                        "profilePicURL": "string",
                        "profilePicName": "string",
                        "profilePicColor": "string",
                        "provider": "string",
                        "newUser": true,
                        "isTourCompleted": true,
                        "about": "string",
                        "updateTime": "2019-08-24T14:15:22Z",
                        "expiryDate": "2019-08-24T14:15:22Z",
                        "status": "string",
                        "role": {
                            "orgRoleId": 0,
                            "roleName": "string"
                        }
                    },
                    "default": true,
                    "primary": true
                },
                "projectTags": [
                    {
                        "tenantId": 0,
                        "projectTagId": 0,
                        "tagName": "string",
                        "color": "string",
                        "createdBy": 0,
                        "modifiedBy": 0
                    }
                ],
                "projectMembers": [
                    {
                        "projectMemberId": 0,
                        "projectId": 0,
                        "user": {
                            "userId": 0,
                            "firstName": "string",
                            "lastName": "string",
                            "email": "string",
                            "profilePicURL": "string",
                            "profilePicName": "string",
                            "profilePicColor": "string",
                            "provider": "string",
                            "newUser": true,
                            "isTourCompleted": true,
                            "about": "string",
                            "updateTime": "2019-08-24T14:15:22Z",
                            "expiryDate": "2019-08-24T14:15:22Z",
                            "status": "string",
                            "role": {
                                "orgRoleId": 0,
                                "roleName": "string"
                            }
                        },
                        "invitedBy": {
                            "userId": 0,
                            "firstName": "string",
                            "lastName": "string",
                            "email": "string",
                            "profilePicURL": "string",
                            "profilePicName": "string",
                            "profilePicColor": "string",
                            "provider": "string",
                            "newUser": true,
                            "isTourCompleted": true,
                            "about": "string",
                            "updateTime": "2019-08-24T14:15:22Z",
                            "expiryDate": "2019-08-24T14:15:22Z",
                            "status": "string",
                            "role": {
                                "orgRoleId": 0,
                                "roleName": "string"
                            }
                        },
                        "role": {
                            "projectRoleId": 0,
                            "projectRoleName": "string"
                        }
                    }
                ],
                "projectMail": "string",
                "spaceName": "string",
                "customFields": [
                    {
                        "tenantId": 0,
                        "taskCustomFieldId": 0,
                        "fieldName": "string",
                        "description": "string",
                        "fieldType": "string",
                        "fieldValue": [
                            {
                                "taskId": 0,
                                "value": {}
                            }
                        ],
                        "fieldIcon": "string",
                        "spaceId": 0,
                        "projectId": 0,
                        "associatedId": 0,
                        "order": 0,
                        "createdBy": {
                            "userId": 0,
                            "firstName": "string",
                            "lastName": "string",
                            "email": "string",
                            "profilePicURL": "string",
                            "profilePicName": "string",
                            "profilePicColor": "string",
                            "provider": "string",
                            "newUser": true,
                            "isTourCompleted": true,
                            "about": "string",
                            "updateTime": "2019-08-24T14:15:22Z",
                            "expiryDate": "2019-08-24T14:15:22Z",
                            "status": "string",
                            "role": {
                                "orgRoleId": 0,
                                "roleName": "string"
                            }
                        },
                        "modifiedBy": {
                            "userId": 0,
                            "firstName": "string",
                            "lastName": "string",
                            "email": "string",
                            "profilePicURL": "string",
                            "profilePicName": "string",
                            "profilePicColor": "string",
                            "provider": "string",
                            "newUser": true,
                            "isTourCompleted": true,
                            "about": "string",
                            "updateTime": "2019-08-24T14:15:22Z",
                            "expiryDate": "2019-08-24T14:15:22Z",
                            "status": "string",
                            "role": {
                                "orgRoleId": 0,
                                "roleName": "string"
                            }
                        },
                        "createdTime": "2019-08-24T14:15:22Z",
                        "modifiedTime": "2019-08-24T14:15:22Z",
                        "customFieldOption": [
                            {
                                "optionId": 0,
                                "optionName": "string",
                                "color": "string",
                                "spaceId": 0,
                                "projectId": 0,
                                "taskCustomFieldId": 0
                            }
                        ]
                    }
                ],
                "public": true,
                "overdue": true,
                "archived": true
            }
        ],
        "hasMore": true
    },
    "timestamp": "2023-01-01T12:00:00Z"
}
Built with