Skip to main content
GET
/
searches
/
{search_id}
/
profiles
Retrieve Profiles
curl --request GET \
  --url https://api.goldilocksai.app/searches/{search_id}/profiles \
  --header 'X-API-Key: <api-key>'
import requests

url = "https://api.goldilocksai.app/searches/{search_id}/profiles"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.goldilocksai.app/searches/{search_id}/profiles', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
{
  "success": true,
  "data": {
    "summarised_query": "Software engineers in San Francisco with Python experience",
    "profiles": [
      {
        "people_id": "123e4567-e89b-12d3-a456-426614174000",
        "full_name": "John Doe",
        "headline": "Senior Software Engineer at Tech Corp",
        "current_company": "Tech Corp",
        "current_position": "Senior Software Engineer",
        "location": "San Francisco, CA",
        "relevancy_score": 92,
        "relevancy_summary": "Strong Python experience with 7 years in San Francisco"
      }
    ]
  },
  "metadata": {
    "results": {
      "total_profiles": 20
    }
  },
  "error": null,
  "request_id": "abc12345-e89b-12d3-a456-426614174000",
  "processing_time_ms": 1250
}
{
"success": false,
"data": null,
"metadata": null,
"error": {
"code": "UNAUTHORIZED",
"message": "Missing or invalid API key"
},
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"processing_time_ms": 20
}
{
"success": false,
"data": null,
"metadata": null,
"error": {
"code": "FORBIDDEN",
"message": "Access denied. You don't have permission to access this resource."
},
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"processing_time_ms": 30
}
{
"success": false,
"data": null,
"metadata": null,
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "Search not found or you don't have access to it"
},
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"processing_time_ms": 45
}
{
"success": false,
"data": null,
"metadata": null,
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred. Please try again later."
},
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"processing_time_ms": 100
}

Authorizations

X-API-Key
string
header
required

API key for authentication. Obtain your API key via the web application.

Path Parameters

search_id
string<uuid>
required

Unique identifier of the search

Response

Successfully retrieved search profiles

success
boolean
required
request_id
string<uuid>
required
processing_time_ms
integer
required
data
object

Response data for GET /searches/{search_id}/profiles

metadata
object

Metadata for GET /searches/{search_id}/profiles

error
null