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​

Body

    campaignIdstring
    Example: 232

Responses​

Fetch Campaign Details

Response Headers

  • Date

    string

  • Server

    string

  • Set-Cookie

    string

  • X-Content-Type-Options

    string

Schema

    Total Preview Certificationstring[]
    Example: ["testLock2 - dbailey (Damien Bailey)"]

    campaignDetails

    object[]

  • Array [

    • certificationamestring
    Example: testLock2 - dbailey (Damien Bailey)
    certifierstring
    Example: dlogan
    certkeystring
    Example: 12258
    progressstring
    Example: 100%
    statusstring
    Example: Locked And Task Created
    usercountnumber
    Example: 5

    users

    object[]

  • Array [

    • certfiedstring
    Example: WORKSFORME
    commentstring
    Example:
    commentsstring
    Example:
    consultedstring
    Example: true
    displaynamestring
    Example: Tabitha Bowers
    firstnamestring
    Example: Tabitha
    totalaccountnumber
    Example: 5
    updateuserstring
    Example: dbailey
    usernamestring
    Example: tbowers

  • ]

  • ]

    • campaignIdstring
    Example: 232
    completestring
    Example: Yes
    countnumber
    Example: 1
    errorCodestring
    Example: 0
    msgstring
    Example: successful