Skip to main content
GET
/
chats
List Chats
curl --request GET \
  --url https://api.peec.ai/customer/v1/chats \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "ch_61184892-36ad-4e1a-8178-3a83608f7711",
      "prompt": {
        "id": "pr_93f790de-5b7a-45ee-b782-61103c81f20d"
      },
      "model": {
        "id": "gpt-4o-search"
      },
      "date": "2025-09-17"
    }
  ]
}

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"

​
limit
number
default:1000
Required range: 1 <= x <= 10000
​
offset
number
default:0
Required range: x >= 0
​
start_date
string<date>
default:2026-01-01

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Example:

"2025-09-22"

​
end_date
string<date>
default:2026-01-01

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Example:

"2025-09-22"

​
brand_id
string
​
prompt_id
string
​
model_id
enum<string>
Available options:
chatgpt-scraper,
perplexity-scraper,
google-ai-overview-scraper,
gpt-4o-search,
google-ai-mode-scraper,
gemini-scraper,
claude-sonnet-4,
microsoft-copilot-scraper,
claude-3.5-haiku,
gpt-4o,
gpt-3.5-turbo,
gemini-2.5-flash,
sonar,
deepseek-r1,
llama-3.3-70b-instruct,
grok-scraper,
grok-api,
llama-sonar

Response

200 - application/json

Success

Success

​
data
object[]
required