Organization data model

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

FieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNo
currencystringNo
timezonestringNo
parent_idstringNo
statusenumNoValues: UNSPECIFIED, ACTIVE, PAUSED, ARCHIVED, DRAFT, SCHEDULED_FOR_DELETION, PROCESSING, PROCESSING_FAILED
account_numberstringNoIntegration-specific account number distinct from id (Microsoft AccountNumber)
managersAdsManager[]NoManager/agency chain, top-most manager first, closest manager last (SA360 manager/sub_manager)
managers[].idstringNo
managers[].namestringNo

TypeScript

TypeScript
export type AdsOrganization = {
	id?: string;
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	name?: string;
	currency?: string;
	timezone?: string;
	parent_id?: string;
	status?: 'UNSPECIFIED' | 'ACTIVE' | 'PAUSED' | 'ARCHIVED' | 'DRAFT' | 'SCHEDULED_FOR_DELETION' | 'PROCESSING' | 'PROCESSING_FAILED';
	account_number?: string; // Integration-specific account number distinct from id (Microsoft AccountNumber)
	managers?: []; // Manager/agency chain, top-most manager first, closest manager last (SA360 manager/sub_manager)
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodAdsOrganization = z.object({
	id: z.string().optional(),
	created_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	name: z.string().optional(),
	currency: z.string().optional(),
	timezone: z.string().optional(),
	parent_id: z.string().optional(),
	status: z.enum("UNSPECIFIED", "ACTIVE", "PAUSED", "ARCHIVED", "DRAFT", "SCHEDULED_FOR_DELETION", "PROCESSING", "PROCESSING_FAILED").optional(),
	account_number: z.string().optional().describe("Integration-specific account number distinct from id (Microsoft AccountNumber)"),
	managers: z.array().optional().describe("Manager/agency chain, top-most manager first, closest manager last (SA360 manager/sub_manager)"),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class AdsOrganizationStatus(str, Enum):
	UNSPECIFIED = 'UNSPECIFIED'
	ACTIVE = 'ACTIVE'
	PAUSED = 'PAUSED'
	ARCHIVED = 'ARCHIVED'
	DRAFT = 'DRAFT'
	SCHEDULED_FOR_DELETION = 'SCHEDULED_FOR_DELETION'
	PROCESSING = 'PROCESSING'
	PROCESSING_FAILED = 'PROCESSING_FAILED'

@dataclasses.dataclass
class AdsOrganization:
	id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	name: Optional[str]
	currency: Optional[str]
	timezone: Optional[str]
	parent_id: Optional[str]
	status: Optional[AdsOrganizationStatus]
	"""Integration-specific account number distinct from id (Microsoft AccountNumber)"""
	account_number: Optional[str]
	"""Manager/agency chain, top-most manager first, closest manager last (SA360 manager/sub_manager)"""
	managers: Optional[PropertyAdsOrganizationManagers]
Are we missing anything? Let us know
Was this page helpful?