My Project
  1. Annotations
My Project
  • Start your Apidog journey
  • Standalone Mode
    • Models
      • Create the Model
      • Get All the models
      • Getting the child models of a parent
      • Fetching models based on user role
      • Clone model by root model Id
      • Generate Model through AI by Uploading Image for specific trained models
      • Fetching the model Attributes
      • Deleting the attributes
      • Fetching a particular model by Id
      • Creating the Model Attributes
      • Deleting A Model By Id
      • Updating a Model by Id
      • Creating the model Annotations
      • Updating the model annotation
      • Deleting the Model annotation
      • fetching the model annotations
      • Fetching the Model Components
      • Saving completion status for models
    • Projects
      • Fetching the project model components
      • Get the recent projects
      • Get the completed projects
      • Get the shared project
      • Fetching the projects
      • Creating the project
      • Fetching the project by project Id
      • Deleting the project by projectId
      • Updating the project by Id
      • Get project model
      • create project model
      • Get project Model
      • Delete Project Model
      • Update the project model
      • Skip the project model
      • Complete the project
      • Upload pdf for project model
      • Adding project model attribute
      • Get the project model component
      • Downloading pdf in project
      • Upload image and get url
      • Get project settings
    • Checklists
      • Creating the Checklist
      • Get project checklist
      • Create project checklist
      • Delete project checklist
      • Get All checklist by Project Id
      • Update project checklist
      • Reset project checklist
      • Getting the relevant checklists
      • Fetching the predefined checklists
      • Creating the predefined checklist
      • Updating the predefined checklist
      • Deleting the predefined checklist
      • Creating the checklist by uploading a csv
    • Analytics & Reporting
      • Get project analytics
      • Get project analytics data
    • Task Tracking
      • Get inspector availability
      • Create Inspector availability
      • Creating Bulk inspector availability
      • Update Inspector availability
  • Edge Mode
    • Models
      • Create the Model
      • Get All the models
      • Getting the child models of a parent
      • Fetching models based on user role
      • Clone model by root model Id
      • Generate Model through AI by Uploading Image for specific trained models
      • Fetching the model Attributes
      • Deleting the attributes
      • Fetching a particular model by Id
      • Creating the Model Attributes
      • Deleting A Model By Id
      • Updating a Model by Id
      • Creating the model Annotations
      • Updating the model annotation
      • Deleting the Model annotation
      • fetching the model annotations
      • Fetching the Model Components
      • Saving completion status for models
    • Projects
      • Fetching the project model components
      • Get the recent projects
      • Get the completed projects
      • Get the shared project
      • Fetching the projects
      • Creating the project
      • Fetching the project by project Id
      • Deleting the project by projectId
      • Updating the project by Id
      • Get project model
      • create project model
      • Get project Model
      • Delete Project Model
      • Update the project model
      • Skip the project model
      • Complete the project
      • Upload pdf for project model
      • Adding project model attribute
      • Get the project model component
      • Downloading pdf in project
      • Upload image and get url
      • Get project settings
    • Icon
      • Creating the Icon
      • Deleting the icon
      • Get the Icons
      • Updating the Icon
      • Fetch all icons
      • Uplaod an Icon
    • Templates
      • Get template
      • Create the Template
      • Get template attributes
      • Create Template attribute
      • Delete template attribute
      • Update template attribute
      • Get template
      • Delete a Template
      • Update a template
      • Create template header
      • Get all template headers
      • Update the template header
      • Delete template header
    • Checklists
      • Creating the Checklist
      • Get project checklist
      • Create project checklist
      • Delete project checklist
      • Get All checklist by Project Id
      • Update project checklist
      • Reset project checklist
      • Getting the relevant checklists
      • Fetching the predefined checklists
      • Creating the predefined checklist
      • Updating the predefined checklist
      • Deleting the predefined checklist
      • Creating the checklist by uploading a csv
    • Annotations
      • get the annotaion
        GET
      • get annotation by Id
        GET
      • Create the annotation
        POST
      • Saving annotation in canvas
        POST
      • Updating the Annotation
        PUT
      • Delete annotation by page number
        DELETE
      • Delete annotation
        DELETE
      • Get annotations with component
        GET
    • Analytics & Reporting
      • Get project analytics
      • Get project analytics data
    • Project Management Tool
      • Get project access
      • Update project access
      • Get the project model access
      • Updating the project model access
      • Delete project access
      • Get project invitation
      • send project invitation
      • Validate project invitation
      • Project Invitation Accept
      • Cancel Project Invitation
    • Task Tracking
      • Get inspector availability
      • Create Inspector availability
      • Creating Bulk inspector availability
      • Update Inspector availability
    • Estimations And Analytics
      • Fetching the project estimations
      • Creating the project estimations
      • Fetching the project estimations analytics
      • Download the project estimation analytics
      • Updating the project estimations
      • Deleting the project estimation by Id
  1. Annotations

Get annotations with component

Developing
GET
/project/{projectId}/annotation/components
Fetches annotations linked to specific components within a model. Each annotation provides additional metadata, comments, or insights about that component, aiding collaborative review and analysis.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/project//annotation/components'
Response Response Example
{
    "status": 200,
    "message": "Annotations retrieved successfully",
    "data": [
        {
            "id": "annotation_123abc",
            "projectModelId": "projectModel_456def",
            "pickModelComponentId": "component_789ghi",
            "annotationData": {
                "type": "polygon",
                "coordinates": [
                    [
                        100,
                        100
                    ],
                    [
                        150,
                        100
                    ],
                    [
                        150,
                        150
                    ],
                    [
                        100,
                        150
                    ]
                ]
            },
            "pageNumber": 1,
            "createdById": "user_001",
            "approvedById": "user_002",
            "status": "Approved",
            "totalComponents": 5,
            "completedComponents": 3,
            "estimatedStartDate": "2025-06-10T08:00:00.000Z",
            "estimatedEndDate": "2025-06-15T18:00:00.000Z",
            "startedAt": "2025-06-10T08:00:00.000Z",
            "completedAt": null,
            "completionPercentage": 60,
            "parentAnnotationId": null,
            "createdAt": "2025-06-01T10:00:00.000Z",
            "updatedAt": "2025-06-02T15:30:00.000Z"
        },
        {
            "id": "annotation_456def",
            "projectModelId": "projectModel_789ghi",
            "pickModelComponentId": "component_012jkl",
            "annotationData": {
                "type": "rectangle",
                "coordinates": [
                    [
                        200,
                        200
                    ],
                    [
                        250,
                        200
                    ],
                    [
                        250,
                        250
                    ],
                    [
                        200,
                        250
                    ]
                ]
            },
            "pageNumber": 2,
            "createdById": "user_003",
            "approvedById": null,
            "status": "Pending",
            "totalComponents": 3,
            "completedComponents": 0,
            "estimatedStartDate": "2025-06-12T08:00:00.000Z",
            "estimatedEndDate": "2025-06-20T18:00:00.000Z",
            "startedAt": null,
            "completedAt": null,
            "completionPercentage": 0,
            "parentAnnotationId": "annotation_123abc",
            "createdAt": "2025-06-05T12:00:00.000Z",
            "updatedAt": "2025-06-05T12:00:00.000Z"
        }
    ]
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
projectId
string 
required

Responses

🟢200Success
application/json
Body
object {0}
Modified at 2025-06-06 15:14:55
Previous
Delete annotation
Next
Get project analytics
Built with