Contacts
List contacts for a website
Authorization
bearerAuth AuthorizationBearer <token>
Use a token created in Settings → API access.
In: header
Path Parameters
workspaceId*string
Workspace ID returned by GET /workspaces.
siteId*string
Site ID returned by GET /workspaces/{workspaceId}/sites.
Query Parameters
search?string
Length
length <= 200page?integer
Range
1 <= valueDefault
1limit?integer
Range
1 <= value <= 100Default
25status?string
Value in
- "active"
- "suppressed"
- "invalid"
verificationStatus?string
Value in
- "unverified"
- "valid"
- "risky"
- "invalid"
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/workspaces/string/sites/string/contacts"{ "ok": true, "data": { "data": [ { "id": "string", "email": "user@example.com", "fullName": "string", "role": "string", "roleCategory": "string", "company": "string", "source": "string", "sourceProvider": "string", "sourceUrl": "http://example.com", "sourceReference": "string", "status": "string", "verificationStatus": "string", "lastVerifiedAt": "2019-08-24T14:15:22Z", "suppressionReason": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "pagination": { "page": 0, "limit": 0, "total": 0, "hasMore": true } }}