Profile data model

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

FieldTypeRequiredDescription
idstringNoUnique identifier for the profile
created_atstring (date-time)NoWhen the profile was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoWhen the profile was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNoDisplay name of the profile
usernamestringNoHandle/username/store code
parent_idstringNoParent profile id when profiles are nested (e.g. account → location)
descriptionstringNoBio or description of the profile
urlstringNoPublic URL of the profile
website_urlstringNoExternal website linked from the profile
avatar_urlstringNoProfile image URL
phonestringNoContact phone number
locationstringNoFree-text location/locale string
addressobjectNoStructured postal address
address.address1stringNo
address.address2stringNo
address.citystringNo
address.regionstringNo
address.postal_codestringNo
address.countrystringNo
categorystringNoPrimary category of the profile
is_verifiedbooleanNoWhether the profile is verified
is_privatebooleanNoWhether the profile is private/protected
metricsobjectNoAudience metrics for the profile
metrics.follower_countnumberNoNumber of followers
metrics.following_countnumberNoNumber of accounts this profile follows
metrics.post_countnumberNoTotal number of posts published by this profile

TypeScript

TypeScript
export type SocialProfile = {
	id?: string; // Unique identifier for the profile
	created_at?: string-time; // When the profile was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // When the profile was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	name?: string; // Display name of the profile
	username?: string; // Handle/username/store code
	parent_id?: string; // Parent profile id when profiles are nested (e.g. account → location)
	description?: string; // Bio or description of the profile
	url?: string; // Public URL of the profile
	website_url?: string; // External website linked from the profile
	avatar_url?: string; // Profile image URL
	phone?: string; // Contact phone number
	location?: string; // Free-text location/locale string
	address?: {
		address1?: string; 
		address2?: string; 
		city?: string; 
		region?: string; 
		postal_code?: string; 
		country?: string; 
	}; // Structured postal address
	category?: string; // Primary category of the profile
	is_verified?: boolean; // Whether the profile is verified
	is_private?: boolean; // Whether the profile is private/protected
	metrics?: {
		follower_count?: number; // Number of followers 
		following_count?: number; // Number of accounts this profile follows 
		post_count?: number; // Total number of posts published by this profile 
	}; // Audience metrics for the profile
	raw?: any; // Raw data from integration
} 

Zod

Zod
import { z } from 'zod';

export const ZodSocialProfile = z.object({
	id: z.string().optional().describe("Unique identifier for the profile"),
	created_at: z.string-time().optional().describe("When the profile was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("When the profile was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	name: z.string().optional().describe("Display name of the profile"),
	username: z.string().optional().describe("Handle/username/store code"),
	parent_id: z.string().optional().describe("Parent profile id when profiles are nested (e.g. account → location)"),
	description: z.string().optional().describe("Bio or description of the profile"),
	url: z.string().optional().describe("Public URL of the profile"),
	website_url: z.string().optional().describe("External website linked from the profile"),
	avatar_url: z.string().optional().describe("Profile image URL"),
	phone: z.string().optional().describe("Contact phone number"),
	location: z.string().optional().describe("Free-text location/locale string"),
	address: z.object({
			address1: z.string().optional(),
			address2: z.string().optional(),
			city: z.string().optional(),
			region: z.string().optional(),
			postal_code: z.string().optional(),
			country: z.string().optional()
}).optional().describe("Structured postal address"),
	category: z.string().optional().describe("Primary category of the profile"),
	is_verified: z.boolean().optional().describe("Whether the profile is verified"),
	is_private: z.boolean().optional().describe("Whether the profile is private/protected"),
	metrics: z.object({
			follower_count: z.number().optional().describe("Number of followers"),
			following_count: z.number().optional().describe("Number of accounts this profile follows"),
			post_count: z.number().optional().describe("Total number of posts published by this profile")
}).optional().describe("Audience metrics for the profile"),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class PropertySocialProfileAddress:
	address1: Optional[str]
	address2: Optional[str]
	city: Optional[str]
	region: Optional[str]
	postal_code: Optional[str]
	country: Optional[str]

@dataclasses.dataclass
class PropertySocialProfileMetrics:
	"""Number of followers"""
	follower_count: Optional[int]
	"""Number of accounts this profile follows"""
	following_count: Optional[int]
	"""Total number of posts published by this profile"""
	post_count: Optional[int]

@dataclasses.dataclass
class SocialProfile:
	"""Unique identifier for the profile"""
	id: Optional[str]
	"""When the profile was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""When the profile was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""Display name of the profile"""
	name: Optional[str]
	"""Handle/username/store code"""
	username: Optional[str]
	"""Parent profile id when profiles are nested (e.g. account → location)"""
	parent_id: Optional[str]
	"""Bio or description of the profile"""
	description: Optional[str]
	"""Public URL of the profile"""
	url: Optional[str]
	"""External website linked from the profile"""
	website_url: Optional[str]
	"""Profile image URL"""
	avatar_url: Optional[str]
	"""Contact phone number"""
	phone: Optional[str]
	"""Free-text location/locale string"""
	location: Optional[str]
	"""Structured postal address"""
	address: Optional[PropertySocialProfileAddress]
	"""Primary category of the profile"""
	category: Optional[str]
	"""Whether the profile is verified"""
	is_verified: Optional[bool]
	"""Whether the profile is private/protected"""
	is_private: Optional[bool]
	"""Audience metrics for the profile"""
	metrics: Optional[PropertySocialProfileMetrics]
Are we missing anything? Let us know
Was this page helpful?