Retrieve lookup values - Respondent API

GET

lookups

Retrieve lookup values

curl --request GET \
  --url https://api-staging.respondent.io/v1/lookups \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-secret: <x-api-secret>'

{
  "ageGroup": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "companySize": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "country": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "educationLevel": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "employmentStatus": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "ethnicity": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "gender": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "householdIncome": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "industries": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "jobTitles": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "skills": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "topics": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "seniorityLevel": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "jobFunction": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "income": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "programmingLanguage": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "browser": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "smartphoneOS": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "tabletOS": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "computerOS": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "relationshipStatus": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "language": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "livingSituation": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "pet": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "keyQualifier": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "screenerResponseStatus": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "typeOfResearch": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "marketType": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "researchMethodology": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ]
}

Headers

x-api-key

string

required

x-api-secret

string

required

Query Parameters

pick

enum<string>[]

required

Available options:

marketType,

researchMethodology,

typeOfResearch,

ageGroup,

companySize,

country,

educationLevel,

employmentStatus,

ethnicity,

gender,

householdIncome,

industries,

jobFunction,

jobTitles,

keyQualifier,

seniorityLevel,

skills,

topics

contexts

enum<string>[]

Available options:

project,

profile

lang

enum<string>

default:en

Available options:

en

Response

200 - application/json

ageGroup

object[]

Show child attributes

companySize

object[]

Show child attributes

country

object[]

Show child attributes

educationLevel

object[]

Show child attributes

employmentStatus

object[]

Show child attributes

ethnicity

object[]

Show child attributes

gender

object[]

Show child attributes

householdIncome

object[]

Show child attributes

industries

object[]

Show child attributes

jobTitles

object[]

Show child attributes

skills

object[]

Show child attributes

topics

object[]

Show child attributes

seniorityLevel

object[]

Show child attributes

jobFunction

object[]

Show child attributes

income

object[]

Show child attributes

programmingLanguage

object[]

Show child attributes

browser

object[]

Show child attributes

smartphoneOS

object[]

Show child attributes

tabletOS

object[]

Show child attributes

computerOS

object[]

Show child attributes

relationshipStatus

object[]

Show child attributes

language

object[]

Show child attributes

livingSituation

object[]

Show child attributes

pet

object[]

Show child attributes

keyQualifier

object[]

Show child attributes

screenerResponseStatus

object[]

Show child attributes

typeOfResearch

object[]

Show child attributes

marketType

object[]

Show child attributes

researchMethodology

object[]

Show child attributes

Create webhookRegister a webhook URL for your organization to receive real-time event notifications. Only **one active webhook** is allowed per organization. Failed deliveries are retried up to 5 times at 10-minute intervals.

⌘I

Retrieve lookup values

curl --request GET \
  --url https://api-staging.respondent.io/v1/lookups \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-secret: <x-api-secret>'

{
  "ageGroup": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "companySize": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "country": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "educationLevel": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "employmentStatus": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "ethnicity": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "gender": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "householdIncome": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "industries": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "jobTitles": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "skills": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "topics": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "seniorityLevel": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "jobFunction": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "income": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "programmingLanguage": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "browser": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "smartphoneOS": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "tabletOS": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "computerOS": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "relationshipStatus": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "language": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "livingSituation": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "pet": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "keyQualifier": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "screenerResponseStatus": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "typeOfResearch": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "marketType": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ],
  "researchMethodology": [
    {
      "code": "<string>",
      "value": "<string>",
      "weight": 123,
      "disabled": true
    }
  ]
}