Skip to main content
GET
/
project-profile
Get Project Profile
curl --request GET \
  --url https://api.peec.ai/customer/v1/project-profile \
  --header 'X-API-Key: <api-key>'
{
  "profile": {
    "occupation": "<string>",
    "industry": "<string>",
    "brandPresentation": [
      "<string>"
    ],
    "productsAndServices": [
      "<string>"
    ],
    "targetMarkets": [
      {
        "location": "<string>",
        "osmId": "<string>"
      }
    ],
    "audienceDistribution": {
      "simpleRecommendationSeeker": 4503599627370495,
      "informedShopper": 4503599627370495,
      "evaluativeResearcher": 4503599627370495
    },
    "name": "<string>",
    "usedPreparedProfile": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.peec.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
project_id
string

Required if using a company api key

Example:

"or_f45b94ba-5e35-4982-93ed-285e72ee14eb"

Response

Project profile fetched successfully

Project profile fetched successfully

​
profile
object
required