> ## Documentation Index > Fetch the complete documentation index at: https://docs.publisher.miratsquanto.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Survey Qualification > Retrieve the qualification criteria for a specific survey. ## Get Survey Qualification Retrieve the qualification criteria for a specific survey. ### Endpoint ```http theme={null} POST /surveys/{surveyNumber}/qualification ``` ### Headers ```json theme={null} { "publisher-authentication-key": "your_project_secret_key" } ``` > **Note:** The `publisher-authentication-key` header corresponds to your **Secret Key**. The `authorizationKey` in the request body corresponds to your **Web API Key**. ### Request Body ```json theme={null} { "authorizationKey": "DqcInvhIFAl5WtUNwihFUIgUH77EL2hTNRU" } ``` ### Response ```json theme={null} { "surveyNumber": 17633734077335336, "qualification": [ { "question": "AGE", "validOptions": [ { "from": 18, "to": 99 } ], "displayOptions": [], "quotas": {}, "questionType": "Numeric - Open-end", "preCodes": [ "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "46", "47", "48", "49", "50", "51", "52", "53", "54", "55", "56", "57", "58", "59", "60", "61", "62", "63", "64", "65", "66", "67", "68", "69", "70", "71", "72", "73", "74", "75", "76", "77", "78", "79", "80", "81", "82", "83", "84", "85", "86", "87", "88", "89", "90", "91", "92", "93", "94", "95", "96", "97", "98", "99" ] }, { "question": "GENDER", "validOptions": [ "Male", "Female" ], "displayOptions": [ "Male", "Female" ], "quotas": {}, "questionType": "Single Punch", "preCodes": [] }, { "question": "STATE", "validOptions": [ "CALIFORNIA" ], "displayOptions": [ "ALABAMA", "ALASKA", "American Samoa", "ARIZONA", "ARKANSAS", "CALIFORNIA", "COLORADO", "CONNECTICUT", "DELAWARE", "DISTRICT OF COLUMBIA", "Federated States of Micronesia", "FLORIDA", "GEORGIA", "Guam", "HAWAII", "IDAHO", "ILLINOIS", "INDIANA", "IOWA", "KANSAS", "KENTUCKY", "LOUISIANA", "MAINE", "Marshall Islands", "MARYLAND", "MASSACHUSETTS", "MICHIGAN", "MINNESOTA", "MISSISSIPPI", "MISSOURI", "MONTANA", "NEBRASKA", "NEVADA", "NEW HAMPSHIRE", "NEW JERSEY", "NEW MEXICO", "NEW YORK", "NORTH CAROLINA", "NORTH DAKOTA", "Northern Mariana Islands", "NOT APPLICABLE", "OHIO", "OKLAHOMA", "OREGON", "Palau", "PENNSYLVANIA", "Puerto Rico", "RHODE ISLAND", "SOUTH CAROLINA", "SOUTH DAKOTA", "TENNESSEE", "TEXAS", "UTAH", "VERMONT", "Virgin Islands", "VIRGINIA", "WASHINGTON", "WEST VIRGINIA", "WISCONSIN", "WYOMING" ], "quotas": {}, "questionType": "Dummy", "preCodes": [] }, { "question": "ETHNICITY", "validOptions": [ "White", "Asian *** Asian Indian", "Asian *** Chinese", "Asian *** Filipino", "Asian *** Japanese", "Asian *** Korean", "Asian *** Vietnamese", "Asian *** Other", "Pacific Islander *** Native Hawaiian", "Pacific Islander *** Guamanian", "Pacific Islander *** Samoan", "Pacific Islander *** Other Pacific Islander" ], "displayOptions": [ "White", "Black, or African American", "American Indian or Alaska Native", "Asian *** Asian Indian", "Asian *** Chinese", "Asian *** Filipino", "Asian *** Japanese", "Asian *** Korean", "Asian *** Vietnamese", "Asian *** Other", "Pacific Islander *** Native Hawaiian", "Pacific Islander *** Guamanian", "Pacific Islander *** Samoan", "Pacific Islander *** Other Pacific Islander", "Some other race", "Prefer not to answer" ], "quotas": {}, "questionType": "Single Punch", "preCodes": [] }, { "question": "STANDARD_EMPLOYMENT", "validOptions": [ "Employed full-time", "Employed part-time", "Self-employed full-time", "Self-employed part-time" ], "displayOptions": [ "Parental leave", "Leave of absence", "Unable to work", "Other type of paid work", "Bringing up a family", "Unpaid full-time carer", "Working unpaid", "In-between jobs / looking for work", "Pursuing own goals", "Employed full-time", "Employed part-time", "Self-employed full-time", "Self-employed part-time", "Active military", "Inactive military/Veteran", "Temporarily unemployed", "Full-time homemaker", "Retired", "Student", "Disabled", "Prefer not to answer" ], "quotas": {}, "questionType": "Single Punch", "preCodes": [] }, { "question": "STANDARD_POLITICAL_PARTY", "validOptions": [ "Republican", "Independent", "Democrat" ], "displayOptions": [ "Strong Republican", "Republican", "Independent who leans Republican", "Independent", "Independent who leans Democrat", "Democrat", "Strong Democrat", "Prefer not to say" ], "quotas": {}, "questionType": "Single Punch", "preCodes": [] }, { "question": "STANDARD_EDUCATION_v2", "validOptions": [ "Some high school or less", "High school graduate", "Other post high school vocational training", "Completed some college, but no degree", "Associate's degree", "Bachelor's degree", "Master's or professional degree", "Doctorate degree" ], "displayOptions": [ "Some high school or less", "High school graduate", "Other post high school vocational training", "Completed some college, but no degree", "Associate's degree", "Bachelor's degree", "Master's or professional degree", "Doctorate degree", "None of the above" ], "quotas": {}, "questionType": "Single Punch", "preCodes": [] } ], "projectName": "New Campaign 007", "projectNumber": 10000092, "organisation": "Mirats Quanto" } ``` ### Error Response ```json theme={null} { "message": "internal server error", "code": 500, "success": false } ``` ## OpenAPI ````yaml POST /surveys/{surveyNumber}/qualification openapi: 3.0.0 info: title: Mirats Quanto Publisher API description: API documentation for Mirats Quanto Publisher services version: 1.0.0 servers: - url: https://api.publisher.miratsquanto.com/api/v1/publisher description: Publisher API Base URL security: - publisher-authentication-key: [] paths: /surveys/{surveyNumber}/qualification: post: tags: - Surveys summary: Get Survey Qualification description: Retrieve the qualification criteria for a specific survey. operationId: getSurveyQualification parameters: - name: surveyNumber in: path required: true schema: type: integer example: 17633734077335336 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AuthorizationRequest' responses: '200': description: Successful response with survey qualification details content: application/json: schema: type: object properties: surveyNumber: type: integer example: 17633734077335336 qualification: type: array items: $ref: '#/components/schemas/QualificationItem' projectName: type: string example: New Campaign 007 projectNumber: type: integer example: 10000092 organisation: type: string example: Mirats Quanto required: - surveyNumber - qualification '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: schemas: AuthorizationRequest: type: object description: >- Payload for endpoints that only require the Web API Key in the request body. properties: authorizationKey: type: string description: Web API Key obtained from the Mirats Publisher Platform. example: DqcInvhIFAl5WtUNwihFUIgUH77EL2hTNRU required: - authorizationKey QualificationItem: type: object properties: question: type: string example: AGE validOptions: type: array items: oneOf: - type: object properties: from: type: integer example: 18 to: type: integer example: 55 required: - from - to - type: string example: Male displayOptions: type: array items: type: string example: Male quotas: type: object additionalProperties: type: integer example: Male: 0 Female: 13 questionType: type: string example: Single Punch preCodes: type: array items: type: string example: '18' required: - question - validOptions - displayOptions - quotas ErrorResponse: type: object properties: message: type: string example: internal server error code: type: integer example: 500 success: type: boolean example: false required: - message - code - success securitySchemes: publisher-authentication-key: type: apiKey in: header name: publisher-authentication-key description: >- Send your Secret Key using the `publisher-authentication-key` header. This header is required for every request. ````