Provision listing

POST

https://api.sureshake.com/v2/directory/listings

Request body JSON required

subjectType
person
or
entity
required

subjectId
optional
string
maxLength: 255 · minLength: 1
personSubjectKind
optional
user
or
reference_entity
default: "user"

Returns

200

Default Response

JSON

data
object
required
- created
  boolean
  required
- listing
  object
  required
  id
  string
  required
  format: uuid
  subjectType
  person
  or
  entity
  required
  subjectId
  string
  required
  slug
  string
  required
  ownerPublicationStatus
  draft
  or
  published
  or
  unpublished
  required
  moderationStatus
  allowed
  or
  blocked
  or
  archived
  required
  claimStatus
  not_claimable
  or
  unclaimed
  or
  claim_pending
  or
  claimed
  required
  claimedByUserId
  string
  or null
  required
  claimedAt
  string
  or null
  required
  format: date-time
  publishedVersionId
  string
  or null
  required
  format: uuid
  snapshot
  object
  required
  identity
  object
  required
  displayName
  string
  required
  maxLength: 255 · minLength: 1
  aliases
  optional
  array of
  string
  maxLength: 255 · minLength: 1
  avatarUrl
  optional
  string
  or null
  format: uri
  logoUrl
  optional
  string
  or null
  format: uri
  overview
  optional
  string
  or null
  maxLength: 5000
  location
  optional
  string
  or null
  maxLength: 255
  category
  optional
  string
  or null
  maxLength: 255
  websiteUrl
  optional
  string
  or null
  format: uri
  socialLinks
  optional
  array of
  object
  label
  string
  required
  maxLength: 80 · minLength: 1
  url
  string
  required
  format: uri
  experienceOrTeam
  optional
  array of
  map<unknown>
  credentials
  optional
  array of
  map<unknown>
  businessDetails
  optional
  map of
  unknown
  publicEvidence
  optional
  array of
  map<unknown>
  capitalProviderProfile
  optional
  object
  profileType
  vc_professional
  or
  angel_investor
  or
  scout
  or
  family_office_professional
  or
  accelerator_or_venture_studio
  or
  corporate_venture_professional
  +1 more
  required
  directEmail
  optional
  string
  or null
  format: email
  directPhone
  optional
  string
  or null
  maxLength: 50 · minLength: 3
  streetAddress
  optional
  string
  or null
  maxLength: 500 · minLength: 3
  visibilityPolicy
  object
  required
  sections
  optional
  object
  default: {"identity":true}
  identity
  optional
  boolean
  overview
  optional
  boolean
  location
  optional
  boolean
  websiteSocial
  optional
  boolean
  experienceTeam
  optional
  boolean
  credentials
  optional
  boolean
  businessDetails
  optional
  boolean
  publicEvidence
  optional
  boolean
  sensitiveFields
  optional
  object
  default: {"directEmail":false,"directPhone":false,"streetAddress":false}
  directEmail
  optional
  boolean
  default: false
  directPhone
  optional
  boolean
  default: false
  streetAddress
  optional
  boolean
  default: false
  updatedAt
  string
  required
  format: date-time
}
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
}