Skip to main content

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 {
  id: ID!
  name: String!
  shortCode: String! @deprecated
}

Fields​

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.shortCode ● String! deprecated non-null scalar​

DEPRECATED

Use id instead

A short code that uniquely identifies the Organization

Member Of​

CreateOrganizationResult object ● OrganizationsResults object ● UpdateOrganizationResult object

Implemented By​

OrganizationResponse union