GET
/
contacts
curl --request GET \
  --url https://app.formbricks.com/api/contacts
[
  {
    "id": "<string>",
    "userId": "<string>",
    "createdAt": "2021-01-01T00:00:00.000Z",
    "updatedAt": "2021-01-01T00:00:00.000Z",
    "environmentId": "<string>"
  }
]

Query Parameters

​
limit
number
default:
10
Required range: 1 < x < 100
​
skip
number
default:
0
Required range: x > 0
​
sortBy
enum<string>
default:
createdAt
Available options:
createdAt,
updatedAt
​
order
enum<string>
default:
desc
Available options:
asc,
desc
​
startDate
string
​
endDate
string

Response

200 - application/json
Contacts retrieved successfully.
​
id
string
required

Unique identifier for the contact

​
userId
string | null
required

Optional external user identifier

​
createdAt
string
required

When the contact was created

​
updatedAt
string
required

When the contact was last updated

​
environmentId
string
required

The environment this contact belongs to

Was this page helpful?

Delete a responseCreate a contact