List entity follow requests

GET

https://api.sureshake.com/v2/entities/{entityId}/follow-requests

Path parameters

entityId
string
required
format: uuid

Query parameters

status
optional
pending
or
approved
or
rejected
or
cancelled
limit
optional
number
maximum: 100 · minimum: 1 · default: 50
offset
optional
number
minimum: 0 · default: 0

Returns

200

Default Response

JSON

data
array of
object
required
- id
  string
  required
  format: uuid
- entityId
  string
  required
  format: uuid
- requestedBy
  string
  required
- requesterEntityId
  string
  or null
  required
  format: uuid
- status
  pending
  or
  provisioning
  or
  approved
  or
  paused
  or
  expired
  or
  failed
  +2 more
  required
- requestNote
  string
  or null
  required
- reason
  string
  or null
  required
- requestedTier
  follower
  or
  capital
  or
  diligence
  or
  custom
  or null
  required
- desiredObservation
  string
  or null
  required
- requestedDurationDays
  integer
  or null
  required
  maximum: 365 · minimum: 1
- reviewDecision
  accepted
  or
  narrowed
  or
  declined
  or null
  required
- grantedTier
  follower
  or
  capital
  or
  diligence
  or
  custom
  or null
  required
- grantedDurationDays
  integer
  or null
  required
  maximum: 365 · minimum: 1
- relationshipId
  string
  or null
  required
  format: uuid
- accessExpiresAt
  string
  or null
  required
  format: date-time
- renewalCount
  integer
  required
  minimum: 0
- lastRenewedAt
  string
  or null
  required
  format: date-time
- reviewedBy
  string
  or null
  required
- reviewedAt
  string
  or null
  required
  format: date-time
- reviewNotes
  string
  or null
  required
- createdAt
  string
  required
  format: date-time
- updatedAt
  string
  required
  format: date-time
- requester
  object
  required
  id
  string
  required
  name
  string
  required
  email
  string
  or null
  required
  format: email
  company
  string
  or null
  required
  title
  string
  or null
  required
  avatar
  string
  or null
  required
- requesterEntity
  object
  or null
  required
  id
  string
  required
  format: uuid
  name
  string
  required
  slug
  string
  or null
  required
  logoUrl
  string
  or null
  required
- accessTier
  optional
  follower
  or
  capital
  or
  diligence
  or
  custom
  or null
  default: null
}
meta
object
required
- total
  number
  required
  Total number of items available
- limit
  number
  required
  Number of items per page
- offset
  number
  required
  Number of items skipped
- hasMore
  boolean
  required
  Whether more items are available
- page
  optional
  number
  Current page number
- totalPages
  optional
  number
  Total number of pages
}

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
}

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
}

{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5", "requestedBy": "string", "requesterEntityId": "af12adbd-3666-4602-844a-00328f5c0509", "status": "pending", "requestNote": "string", "reason": "string", "requestedTier": "follower", "desiredObservation": "string", "requestedDurationDays": 1, "reviewDecision": "accepted", "grantedTier": "follower", "accessTier": "follower", "grantedDurationDays": 1, "relationshipId": "928dd5b8-3ead-4528-bdef-9c0b867a5d7d", "accessExpiresAt": "2019-08-24T14:15:22Z", "renewalCount": 0, "lastRenewedAt": "2019-08-24T14:15:22Z", "reviewedBy": "string", "reviewedAt": "2019-08-24T14:15:22Z", "reviewNotes": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "requester": { "id": "string", "name": "string", "email": "user@example.com", "company": "string", "title": "string", "avatar": "string" }, "requesterEntity": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "slug": "string", "logoUrl": "string" } } ], "meta": { "total": 0, "limit": 0, "offset": 0, "hasMore": true, "page": 0, "totalPages": 0 } }