Skip to content
Navigation

Get reporter profile availability

GET
https://api.sureshake.com/v2/entities/{id}/reporter-profiles

Path parameters

  • id
    string
    required
    format: uuid

Query parameters

  • profileId
    optional
    string
    format: uuid
  • sourceKey
    optional
    string

Returns

200

Default Response

JSON
  • data
    required

    Any of the following:

    • object
      • entityId
        string
        required
        format: uuid
      • entityType
        string
        required
      • playbookAccess
        object
        required
        • isPremium
          boolean
          required
        • canCreateDrafts
          boolean
          required
        • canPreview
          boolean
          required
        • canPublish
          boolean
          required
      • sources
        array of
        object
        required
        • key
          string
          required
        • label
          string
          required
        • description
          string
          required
        • isConnected
          boolean
          required
        • availableIntentKeys
          array of
          string
          required
      • intents
        array of
        object
        required
        • key
          string
          required
        • label
          string
          required
        • description
          string
          required
        • sourceKeys
          optional
          array of
          string
          default: []
        • isEnabled
          optional
          boolean
          default: true
        • strategySummary
          optional
          string
        • setupGuide
          optional
          array of
          string
          default: []
      • status
        available
        required
      • profileId
        optional
        string
        or null
        format: uuid
      • versionId
        optional
        string
        or null
        format: uuid
      • sourceKey
        optional
        string
        or null
      • profiles
        optional
        array of
        object
        default: []
        • id
          string
          required
          format: uuid
        • name
          string
          required
        • description
          optional
          string
          or null
        • origin
          optional
          string
          default: "custom"
        • marketplaceListingId
          optional
          string
          or null
        • marketplaceListingVersion
          optional
          string
          or null
        • publishedVersionId
          optional
          string
          or null
          format: uuid
        • latestDraftVersionId
          optional
          string
          or null
          format: uuid
        • defaultSourceKey
          optional
          string
          or null
        • defaultIntentKey
          optional
          string
          or null
        • enabledIntentKeys
          optional
          array of
          string
          default: []
    • object
      • entityId
        string
        required
        format: uuid
      • entityType
        string
        required
      • playbookAccess
        object
        required
        • isPremium
          boolean
          required
        • canCreateDrafts
          boolean
          required
        • canPreview
          boolean
          required
        • canPublish
          boolean
          required
      • sources
        array of
        object
        required
        • key
          string
          required
        • label
          string
          required
        • description
          string
          required
        • isConnected
          boolean
          required
        • availableIntentKeys
          array of
          string
          required
      • intents
        array of
        object
        required
        • key
          string
          required
        • label
          string
          required
        • description
          string
          required
        • sourceKeys
          optional
          array of
          string
          default: []
        • isEnabled
          optional
          boolean
          default: true
        • strategySummary
          optional
          string
        • setupGuide
          optional
          array of
          string
          default: []
      • status
        unavailable
        required
      • reason
        profile_store_unavailable
        required
      • message
        string
        required
        minLength: 1
      • profileId
        optional
        string
        or null
        format: uuid
      • versionId
        optional
        string
        or null
        format: uuid
      • sourceKey
        optional
        string
        or null
      • profiles
        optional
        array of
        object
        default: []
        • id
          string
          required
          format: uuid
        • name
          string
          required
        • description
          optional
          string
          or null
        • origin
          optional
          string
          default: "custom"
        • marketplaceListingId
          optional
          string
          or null
        • marketplaceListingVersion
          optional
          string
          or null
        • publishedVersionId
          optional
          string
          or null
          format: uuid
        • latestDraftVersionId
          optional
          string
          or null
          format: uuid
        • defaultSourceKey
          optional
          string
          or null
        • defaultIntentKey
          optional
          string
          or null
        • enabledIntentKeys
          optional
          array of
          string
          default: []
  • 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

422

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

Type to search…

↑↓ navigate↵ selectEsc close