OrganizationResponse

A union representing the possible return types when querying for an Organization

union OrganizationResponse =
  | BadRequestError
  | InternalServerError
  | Organization

Possible types

OrganizationResponse.BadRequestError object

Returned when there is an error in the request.

OrganizationResponse.InternalServerError object

Returned when an error is encountered that is not expected.

OrganizationResponse.Organization object

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.

Returned By

organization query