Get follow state

GET

https://api.sureshake.com/v2/directory/{subjectType}/{listingId}/follow-state

Path parameters

subjectType
person
or
entity
required

listingId
string
required
format: uuid

Query parameters

actingPrincipal
optional
object

Returns

200

Default Response

JSON

data
object
required
- subject
  object
  required
  listingId
  string
  required
  format: uuid
  subjectType
  person
  or
  entity
  required
- actingPrincipal
  object
  required
  principalType
  user
  or
  entity
  or
  organization
  required
  principalId
  string
  required
  maxLength: 255 · minLength: 1
- state
  not_following
  or
  pending
  or
  provisioning
  or
  active
  or
  paused
  or
  expired
  +6 more
  required
- request
  object
  or null
  required
  id
  string
  required
  format: uuid
  subject
  object
  required
  listingId
  string
  required
  format: uuid
  subjectType
  person
  or
  entity
  required
  actingPrincipal
  object
  required
  principalType
  user
  or
  entity
  or
  organization
  required
  principalId
  string
  required
  maxLength: 255 · minLength: 1
  requestedByUserId
  string
  required
  status
  pending
  or
  approved
  or
  rejected
  or
  cancelled
  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
  requestedPackageId
  string
  or null
  required
  format: uuid
  reviewedByUserId
  string
  or null
  required
  reviewedAt
  string
  or null
  required
  format: date-time
  decisionNotes
  string
  or null
  required
  createdAt
  string
  required
  format: date-time
  updatedAt
  string
  required
  format: date-time
- relationship
  object
  or null
  required
  id
  string
  required
  format: uuid
  status
  provisioning
  or
  active
  or
  paused
  or
  expired
  or
  failed
  or
  revoked
  required
  accessTier
  follower
  or
  capital
  or
  diligence
  or
  custom
  required
  accessDurationDays
  integer
  required
  maximum: 365 · minimum: 1
  accessExpiresAt
  string
  required
  format: date-time
  graphConfirmedAt
  string
  or null
  required
  format: date-time
  graphLastError
  string
  or null
  required
  accessDisabledAt
  string
  or null
  required
  format: date-time
  revokedAt
  string
  or null
  required
  format: date-time
  revocation
  object
  required
  status
  idle
  or
  queued
  or
  running
  or
  completed
  or
  partial
  or
  failed
  required
  counts
  object
  required
  attempted
  integer
  required
  minimum: 0
  succeeded
  integer
  required
  minimum: 0
  failed
  integer
  required
  minimum: 0
  skipped
  integer
  required
  minimum: 0
  lastError
  string
  or null
  required
- workflow
  object
  or null
  required
  id
  string
  required
  format: uuid
  followRequestId
  string
  required
  format: uuid
  relationshipId
  string
  required
  format: uuid
  status
  queued
  or
  running
  or
  completed
  or
  partial
  or
  failed
  required
  counts
  object
  required
  attempted
  integer
  required
  minimum: 0
  succeeded
  integer
  required
  minimum: 0
  failed
  integer
  required
  minimum: 0
  skipped
  integer
  required
  minimum: 0
  fatalError
  string
  or null
  required
  createdAt
  string
  required
  format: date-time
  updatedAt
  string
  required
  format: date-time
  completedAt
  string
  or null
  required
  format: date-time
  grants
  array of
  object
  required
  id
  string
  required
  format: uuid
  collectionId
  string
  required
  format: uuid
  status
  pending
  or
  active
  or
  failed
  or
  expired
  or
  revoked
  required
  expiresAt
  string
  or null
  required
  format: date-time
  tokenId
  string
  or null
  required
  transactionHash
  string
  or null
  required
  revocationTransactionHash
  string
  or null
  required
  error
  string
  or null
  required
- terms
  object
  required
  requested
  object
  or null
  required
  tier
  follower
  or
  capital
  or
  diligence
  or
  custom
  or null
  required
  durationDays
  integer
  or null
  required
  maximum: 365 · minimum: 1
  reason
  string
  or null
  required
  desiredObservation
  string
  or null
  required
  granted
  object
  or null
  required
  tier
  follower
  or
  capital
  or
  diligence
  or
  custom
  required
  durationDays
  integer
  required
  maximum: 365 · minimum: 1
  accessExpiresAt
  string
  or null
  required
  format: date-time
- failure
  object
  or null
  required
  phase
  approval
  or
  revocation
  required
  message
  string
  or null
  required
  retryable
  boolean
  required
- primaryAction
  request
  or
  cancel_request
  or
  retry_approval
  or
  revoke
  or
  retry_revocation
  or null
  required
- permittedActions
  array of
  request
  or
  cancel_request
  or
  retry_approval
  or
  revoke
  or
  retry_revocation
  required
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

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
}

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
}