Skip to main content

Fetch Campaign Details

POST 
/fetchCampaignDetails

This API return details of a particular campaign required for employee verification.

The Authorization must have Bearer followed by Token.

Mandatory params:

campaignId

Optional params:

certifierUsername

certkey

max

offset

showCampaignConfig (True/ False) Returns the campaign configuration details when set to True.

Note: The user attributes in the response is driven by the attributes selected during the campaign launch.

Request​

Path Parameters

    path stringrequired

Body

    campaignId string

Responses​

Fetch Campaign Details

Response Headers

  • Date

    string

  • Server

    string

  • Set-Cookie

    string

  • Transfer-Encoding

    string

  • X-Content-Type-Options

    string

  • X-Frame-Options

    string

Schema

    Total Preview Certification string[]

    campaignDetails

    object[]

  • Array [

    • certificationame string
    certifier string
    certkey string
    progress string
    status string
    usercount number

    users

    object[]

  • Array [

    • certfied string
    comment string
    comments string
    consulted string
    displayname string
    firstname string
    totalaccount number
    updateuser string
    username string

  • ]

  • ]

    • campaignId string
    complete string
    count number
    errorCode string
    msg string
Loading...