Skip to main content

OrganizationGroup

An Organization Group is an administrative container that groups related Organizations under one umbrella. For example, a holding company with multiple subsidiaries.

type OrganizationGroup {
address: PhysicalAddress
ein: String
externalId: String
id: ID!
name: String!
organizations(
after: String
first: Int = 100
): OrganizationGroupOrganizationsResults!
phone: PhoneNumber
}

Fields​

OrganizationGroup.address ● PhysicalAddress object​

The physical address of the Organization Group

OrganizationGroup.ein ● String scalar​

The Employer Identification Number (EIN) of the Organization Group

OrganizationGroup.externalId ● String scalar​

A partner-scoped external identifier for the Organization Group

OrganizationGroup.id ● ID! non-null scalar​

The unique ID for the Organization Group

OrganizationGroup.name ● String! non-null scalar​

The user-displayable name of the Organization Group

OrganizationGroup.organizations ● OrganizationGroupOrganizationsResults! non-null object​

The Organizations that belong to this group

OrganizationGroup.organizations.after ● String scalar​
OrganizationGroup.organizations.first ● Int scalar​

OrganizationGroup.phone ● PhoneNumber scalar​

The US phone number of the Organization Group (10 digits, no punctuation)

Member Of​

CreateOrganizationGroupResult object ● Organization object ● OrganizationGroupsResults object ● UpdateOrganizationGroupResult object

Implemented By​

OrganizationGroupResponse union