Skip to main content
GET
/
v1
/
profiles
/
{profileId}
Retrieve participant profile
curl --request GET \
  --url https://api-staging.respondent.io/v1/profiles/{profileId} \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-api-secret: <x-api-secret>'
{
  "id": "<string>",
  "userId": "<string>",
  "firstName": "<string>",
  "lastInitial": "<string>",
  "skills": [],
  "companySize": "selfemployed",
  "location": {
    "city": {
      "id": "<string>",
      "country": "AF",
      "city": "<string>",
      "formattedAddress": "<string>",
      "location": {
        "latitude": 123,
        "longitude": 123
      },
      "state": "<string>",
      "administrative_area_level_1": "<string>",
      "postal_code": "<string>",
      "locality": "<string>",
      "zip": "<string>"
    },
    "loc": {
      "type": "<string>",
      "coordinates": [
        123
      ]
    },
    "zipcode": null,
    "state": "<string>"
  },
  "gender": "male",
  "educationLevel": "somehighschool",
  "ethnicity": "americanindianalaskannative",
  "householdIncome": "<30000",
  "industry": [
    "<string>"
  ],
  "picture": "<string>",
  "jobTitle": "<string>",
  "jobFunctions": [
    "accountingAuditing"
  ],
  "linkedinUrl": "<string>",
  "topics": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "company": "<string>",
  "age": "<string>",
  "seniorityLevel": "unpaid",
  "gdprDeletedAt": "<string>",
  "socialLinks": {}
}

Headers

​
x-api-key
string
required
​
x-api-secret
string
required

Path Parameters

​
profileId
string
required

Response

200 - application/json
​
id
string<ObjectId>
required
​
userId
string<ObjectId>
required
​
firstName
string
required
​
lastInitial
string
required
​
skills
object[]
required
​
companySize
enum<string>
required
Available options:
selfemployed,
1-10,
11-50,
51-200,
201-500,
501-1000,
1001-5000,
5001-10000,
10000+,
all
​
location
object
required
​
gender
enum<string>
required
Available options:
male,
female,
other,
nonbinary,
transmale,
transfemale,
prefernottoanswer,
N/A
​
educationLevel
enum<string>
required
Available options:
somehighschool,
highschoolgraduate,
somecollegenodegree,
tradetechnicalvocationaltraining,
associatedegree,
bachelordegree,
masterdegree,
doctoratedegree,
N/A
​
ethnicity
enum<string>
required
Available options:
americanindianalaskannative,
hispaniclatino,
blackorafricanamerican,
asianpacificislander,
whitecaucasian,
middleeastern,
multipleethnicity,
prefernotdisclose,
N/A
​
householdIncome
enum<string>
required
Available options:
<30000,
30000-39999,
40000-59999,
60000-79999,
80000-99999,
100000-149999,
150000-199999,
200000+,
all,
all
​
industry
string[]
required
​
picture
string | null
​
jobTitle
string
​
jobFunctions
enum<string>[]
Available options:
accountingAuditing,
administrative,
advertising,
analyst,
artCreative,
businessDevelopment,
consulting,
customerService,
distribution,
design,
education,
finance,
generalBusiness,
healthcareProvider,
humanResources,
informationTechnology,
legal,
management,
manufacturing,
marketing,
other,
publicRelations,
purchasing,
productManagement,
projectManagement,
production,
qualityAssurance,
research,
sales,
science,
strategyPlanning,
supplyChain,
training,
writingEditing
​
linkedinUrl
string
​
topics
object[]
​
company
string
​
age
string
​
seniorityLevel
enum<string>
Available options:
unpaid,
student,
training,
entrylevel,
senior,
manager,
director,
chiefofficer,
partner,
vicepresident
​
gdprDeletedAt
string

Indicates this profile was GDPR deleted, and their data has been anonymized. Their associated screeners will also be deleted.

​
socialLinks
object