Organization

An Organization manages Benefits Programs on behalf of Individuals. An example of an Organization is an employer, a charity, etc. An Organization has a relationship (e.g. employer-employee) with Individuals.

Organizations are typically customers of the API consumer.

type Organization {
  address: PhysicalAddress
  divisions(
    after: String
    first: Int = 100
    where: OrganizationDivisionsFilterInput
  ): DivisionsResults!
  externalId: String
  id: ID!
  name: String!
  organizationGroup: OrganizationGroup
  shortCode: String! @deprecated
}

Fields

Organization.address ● PhysicalAddress object

The physical address of the Organization

Organization.divisions ● DivisionsResults! non-null object

Divisions belonging to this Organization

Organization.divisions.after ● String scalar

Return the elements in the list that come after the specified cursor

Organization.divisions.first ● Int scalar

The number of elements to retrieve per page

Organization.divisions.where ● OrganizationDivisionsFilterInput input

Filter criteria used to match Divisions

Organization.externalId ● String scalar

A partner-scoped external identifier for the Organization

Organization.id ● ID! non-null scalar

The unique ID for the Organization

Organization.name ● String! non-null scalar

The user-displayable name of the Organization

Organization.organizationGroup ● OrganizationGroup object

The Organization Group this Organization belongs to, if any

Organization.shortCode ● String! deprecated non-null scalar

DEPRECATED

Use id instead

A short code that uniquely identifies the Organization

Member Of

CreateOrganizationResult object ● Division object ● OrganizationGroupOrganizationsResults object ● OrganizationMembership object ● OrganizationsResults object ● UpdateOrganizationResult object

Implemented By

OrganizationResponse union