Ir al contenido principal
Contacts

Get contact by ID

Retrieves a single contact by their Featurebase ID.

GET
/v2/contacts/{id}

Returns both customers and leads.

Path Parameters

  • id - The Featurebase contact ID (24-character ObjectId)

Response Format

Returns a single contact object with:

  • object - Always "contact"
  • id - Unique contact identifier
  • userId - External user ID from SSO (if set)
  • email - Contact email address
  • name - Contact display name
  • profilePicture - Profile picture URL
  • type - Contact type ("customer" or "lead")
  • companies - Array of companies the contact belongs to
  • customFields - Custom field values
  • postsCreated - Number of posts created
  • commentsCreated - Number of comments created
  • lastActivity - Last activity timestamp

Example

{
  "object": "contact",
  "id": "676f0f6765bdaa7d7d760f88",
  "email": "john@example.com",
  "name": "John Doe",
  "type": "customer",
  ...
}

Version Availability

This endpoint is only available in API version 2026-01-01.nova and newer.

Autorizaciones

Authorizationstringheaderobligatorio

API key as Bearer token. Use: Authorization: Bearer sk_...

Parámetros de ruta

idstringobligatorio

Featurebase contact ID

Ejemplo: 507f1f77bcf86cd799439011

Encabezados

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Opciones disponibles: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover
Ejemplo: 2026-08-19.orbit

Respuesta

application/json

Success

commentsCreatednumber

Number of comments created

Ejemplo: 0
companiesobject[]

Companies the contact belongs to

customFieldsobject

Custom field values on the contact

descriptionstring

Contact description/bio

Ejemplo:
emailstring | null

Contact email

Ejemplo: john@example.com
idstringobligatorio

Unique identifier

Ejemplo: 676f0f6765bdaa7d7d760f88
lastActivitystring

Last activity ISO timestamp

Ejemplo: 2025-01-03T21:42:30.181Z
localestring

Contact locale

Ejemplo: en
manuallyOptedOutFromChangelogboolean

Whether manually opted out from changelog

Ejemplo: false
namestringobligatorio

Contact display name

Ejemplo: John Steezy
objectenum<string>obligatorio

Object type identifier

Opciones disponibles: contact
Ejemplo: contact
organizationIdstring

Organization ID the contact belongs to

Ejemplo: 5febde12dc56d60012d47db6
postsCreatednumber

Number of posts created

Ejemplo: 0
profilePicturestring | null

Profile picture URL

Ejemplo: https://fb-usercontent.fra1.cdn.digitaloceanspaces.com/anon_23.png
rolesstring[]

Contact roles

subscribedToChangelogboolean

Whether subscribed to changelog

Ejemplo: true
typeenum<string>obligatorio

Type of contact

Opciones disponibles: customer, lead
Ejemplo: customer
userIdstring

External user ID from SSO

Ejemplo: 676f0f673dbb299c8a4f3057
verifiedboolean

Whether email is verified

Ejemplo: true

¿Aún necesitas ayuda? Pregunta al equipo