Skip to content
Navigation

Apply hiring

POST
https://api.sureshake.com/v2/hiring/applications

Request body JSON required

  • roleId
    string
    required
    format: uuid
  • portfolioIds
    optional
    array of
    string
    format: uuid
  • additionalResponses
    optional
    array of
    object
    • problemSpecId
      string
      required
    • responseText
      string
      required
    • claimTags
      optional
      array of
      string

Returns

201

Default Response

JSON
  • data
    object
    required
    • id
      string
      required
      format: uuid
    • roleId
      string
      required
      format: uuid
    • candidateId
      string
      required
    • status
      submitted
      or
      reviewing
      or
      evaluated
      or
      hired
      or
      rejected
      or
      withdrawn
      required
    • createdAt
      string
      required
      format: date-time
    • updatedAt
      string
      required
      format: date-time
    • submittedAt
      string
      required
      format: date-time
    • role
      optional
      object
      • id
        string
        required
        format: uuid
      • entityId
        string
        required
        format: uuid
      • title
        string
        required
      • description
        string
        or null
        required
      • location
        string
        or null
        required
      • remotePolicy
        remote
        or
        hybrid
        or
        onsite
        or null
        required
      • salaryRange
        object
        or null
        required
        • min
          optional
          number
        • max
          optional
          number
        • currency
          optional
          string
        • period
          optional
          hourly
          or
          monthly
          or
          yearly
      • status
        draft
        or
        published
        or
        closed
        required
      • visibility
        public
        or
        unlisted
        or
        private
        required
      • publishedAt
        string
        or null
        required
        format: date-time
      • closesAt
        string
        or null
        required
        format: date-time
      • createdAt
        string
        required
        format: date-time
      • updatedAt
        string
        required
        format: date-time
      • problemSpecs
        optional
        array of
        object
        • id
          string
          required
        • prompt
          string
          required
        • orderIndex
          number
          required
        • successCriteria
          optional
          string
      • rubric
        optional
        object
        or null
        • version
          number
          required
        • dimensions
          array of
          object
          required
          • id
            string
            required
          • name
            string
            required
          • weight
            number
            required
          • scaleMin
            number
            required
          • scaleMax
            number
            required
          • description
            optional
            string
        • createdAt
          optional
          string
      • entity
        optional
        object
        • id
          string
          required
          format: uuid
        • name
          string
          required
        • slug
          string
          required
        • logoUrl
          string
          or null
          required
        • verified
          boolean
          required
    • candidate
      optional
      object
      • id
        string
        required
      • name
        string
        or null
        required
      • email
        string
        or null
        required
      • avatarUrl
        string
        or null
        required
    • proofPack
      optional
      object
      or null
      • id
        string
        required
        format: uuid
      • portfolioIds
        array of
        string
        required
        format: uuid
      • additionalResponses
        array of
        object
        required
        • problemSpecId
          string
          required
        • responseText
          string
          required
        • claimTags
          optional
          array of
          string
    • feedback
      optional
      object
      or null
      • id
        string
        required
        format: uuid
      • entityId
        string
        required
        format: uuid
      • applicationId
        string
        required
        format: uuid
      • candidateVisible
        boolean
        required
      • summary
        string
        or null
        required
      • tags
        object
        or null
        required
        • strengths
          optional
          array of
          string
        • gaps
          optional
          array of
          string
        • recommendations
          optional
          array of
          string
      • publishedAt
        string
        required
        format: date-time
      • createdAt
        string
        required
        format: date-time
    • reviewStartedAt
      optional
      string
      or null
      format: date-time
    • evaluatedAt
      optional
      string
      or null
      format: date-time
    • closedAt
      optional
      string
      or null
      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

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

Type to search…

↑↓ navigate↵ selectEsc close