My Project
  1. Models
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
        POST
      • Get All the models
        GET
      • Getting the child models of a parent
        GET
      • Fetching models based on user role
        GET
      • Clone model by root model Id
        GET
      • Generate Model through AI by Uploading Image for specific trained models
        POST
      • Fetching the model Attributes
        GET
      • Deleting the attributes
        DELETE
      • Fetching a particular model by Id
        GET
      • Creating the Model Attributes
        POST
      • Deleting A Model By Id
        DELETE
      • Updating a Model by Id
        PUT
      • Creating the model Annotations
        POST
      • Updating the model annotation
        PUT
      • Deleting the Model annotation
        DELETE
      • fetching the model annotations
        GET
      • Fetching the Model Components
        GET
      • Saving completion status for models
        POST
    • 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 annotation by Id
      • Create the annotation
      • Saving annotation in canvas
      • Updating the Annotation
      • Delete annotation by page number
      • Delete annotation
      • Get annotations with component
    • 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. Models

Fetching a particular model by Id

Developing
GET
/model/{modelId}
Retrieves complete details of a specific model using its unique identifier. The response includes metadata, all attributes, and any linked configurations. Commonly used in model detail pages or edit interfaces.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/model/'
Response Response Example
{
    "status": 200,
    "message": "Model retrieved successfully",
    "data": {
        "id": "model_123",
        "name": "Vehicle Model",
        "type": "default",
        "imageUrl": "https://your-storage.com/uploads/vehicle.jpg",
        "iconName": "Car",
        "description": "Main model for vehicle component structure",
        "superStructureId": "super_001",
        "subStructureId": "sub_001",
        "parentModelId": null,
        "rootModelId": null,
        "organizationId": "org_abc",
        "completedLevel": 0.8,
        "isRoot": true,
        "createdById": "user_123",
        "createdAt": "2025-06-01T10:30:00.000Z",
        "updatedAt": "2025-06-01T10:45:00.000Z",
        "isArchived": false,
        "isDeleted": false,
        "status": "active"
    }
}

Request

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

Responses

🟢200Success
application/json
Body
object {0}
Modified at 2025-06-02 14:21:45
Previous
Deleting the attributes
Next
Creating the Model Attributes
Built with