Contacts (v1, deprecated)

List recent contacts

The 25 most recent contacts for the token's portal, newest first. source is reported as staff here because a stored contact does not record how it was created; the webhook payload carries the real value.

get/api/v1/contacts

Request

  • Base URL: https://app.formaportal.com
  • URL: https://app.formaportal.com/api/v1/contacts
  • Auth: OAuth 2 (authorization code, authorization URL https://app.formaportal.com/oauth/authorize, token URL https://app.formaportal.com/api/oauth/token, scopes: contacts:read)

Response

Contacts, newest first.

idstring required
portalIdstring required
emailstring email required
firstNamestring
lastNamestring
activeboolean
emailVerifiedboolean

Self-registrations are published before the contact confirms their email, so this may be false on a freshly created contact.

createdAtstring date-time required
source'self_registration' | 'invitation' | 'staff' required

How the contact came to exist.

Example response

[
  {
    "id": "cont123456",
    "portalId": "portal1234"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.