Skip to content
Navigation

Get managed role

GET
https://api.sureshake.com/v2/hiring/roles/{id}/manage

Path parameters

  • id
    string
    required
    format: uuid

Query parameters

  • entityId
    string
    required
    format: uuid

Returns

200

Default Response

JSON
  • data
    object
    required
    • 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
  • 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