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
descriptionstringNo
avatar_urlstringNo
web_urlstringNo
user_idsstring[]Noid values of the users/employees associated with this organization

TypeScript

TypeScript
export type RepoOrganization = {
	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;
	description?: string;
	avatar_url?: string;
	web_url?: string;
	user_ids?: string[]; // id values of the users/employees associated with this organization
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodRepoOrganization = 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(),
	description: z.string().optional(),
	avatar_url: z.string().optional(),
	web_url: z.string().optional(),
	user_ids: z.array().optional().describe("id values of the users/employees associated with this organization"),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class RepoOrganization:
	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]
	description: Optional[str]
	avatar_url: Optional[str]
	web_url: Optional[str]
	"""id values of the users/employees associated with this organization"""
	user_ids: Optional[List[List[str]]]
Are we missing anything? Let us know
Was this page helpful?