Get peer groups

GET

https://api.sureshake.com/v2/entities/{id}/peer-groups

Path parameters

id
string
required
format: uuid

Returns

200

Default Response

JSON

entity
object
required
- id
  string
  required
  format: uuid
- name
  string
  required
- entityType
  string
  required
}
similarCompanies
array of
object
required
- id
  string
  required
- name
  string
  required
- entityType
  string
  or null
  required
- website
  string
  or null
  required
- score
  number
  required
- sharedSectorCount
  number
  required
- sharedInvestorCount
  number
  required
}
peerGroups
array of
unknown
required
suggestedGroups
array of
unknown
required
source
graph
or
placeholder
required
message
string
required
analytics
optional
unknown
or null

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

422

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

429

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

503

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

{ "entity": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "entityType": "string" }, "similarCompanies": [ { "id": "string", "name": "string", "entityType": "string", "website": "string", "score": 0, "sharedSectorCount": 0, "sharedInvestorCount": 0 } ], "peerGroups": [], "suggestedGroups": [], "analytics": null, "source": "graph", "message": "string" }