Skip to content
CommonGrants

Organization

OrganizationBase

Section titled “OrganizationBase”

An organization that can apply to or host funding opportunities.

Table

Section titled “Table”
Property Type Required Description
id uuid Yes The organization’s unique identifier.
name string Yes The organization’s legal name as registered with relevant authorities.
orgType PCSOrgType No The organization’s type within the Philanthropy Classification System (PCS).
identifiers OrgIds No Identifiers associated with the organization, keyed by registry code.
addresses AddressCollection No Collection of physical addresses associated with the organization.
phones PhoneCollection No Collection of phone numbers associated with the organization.
emails EmailCollection No Collection of email addresses associated with the organization.
mission string No The organization’s mission statement.
yearFounded calendarYear No The calendar year the organization was founded.
socials OrgSocialLinks No The organization’s social media and web presence links.
customFields Record<CustomField> No Custom fields for the organization.

Formats

Section titled “Formats”

A JSON example of this model.

{
  "id": "083b4567-e89d-42c8-a439-6c1234567890",
  "name": "Example Organization",
  "orgType": {
    "term": "Nonprofit",
    "class": "Organization types",
    "code": "UC000000",
    "description": "Nonprofit organization"
  },
  "identifiers": {
    "org:us:ein": {
      "registry": {
        "code": "org:us:ein",
        "url": "https://commongrants.org/registries/org-us-ein"
      },
      "id": "191234567"
    },
    "org:us:uei": {
      "registry": {
        "code": "org:us:uei",
        "url": "https://commongrants.org/registries/org-us-uei"
      },
      "id": "ABCD12345678"
    },
    "org:xi:duns": {
      "registry": {
        "code": "org:xi:duns",
        "url": "https://commongrants.org/registries/org-xi-duns"
      },
      "id": "123456789"
    }
  },
  "addresses": {
    "primary": {
      "street1": "456 Main St",
      "street2": "Suite 100",
      "city": "Anytown",
      "stateOrProvince": "CA",
      "country": "US",
      "postalCode": "12345"
    },
    "otherAddresses": {
      "satellite": {
        "street1": "456 Main St",
        "street2": "Suite 100",
        "city": "Anytown",
        "stateOrProvince": "CA",
        "country": "US",
        "postalCode": "12345"
      },
      "international": {
        "street1": "123 Rue Principale",
        "city": "Montreal",
        "stateOrProvince": "QC",
        "country": "CA",
        "postalCode": "H2Y 1C6"
      }
    }
  },
  "phones": {
    "primary": {
      "countryCode": "+1",
      "number": "444-456-1230",
      "isMobile": true
    },
    "fax": {
      "countryCode": "+1",
      "number": "555-123-4567",
      "extension": "123",
      "isMobile": false
    },
    "otherPhones": {
      "support": {
        "countryCode": "+1",
        "number": "333-456-1230",
        "isMobile": false
      },
      "marketing": {
        "countryCode": "+1",
        "number": "444-456-1230",
        "isMobile": true
      }
    }
  },
  "emails": {
    "primary": "info@example.com",
    "otherEmails": {
      "support": "support@example.com",
      "marketing": "marketing@example.com"
    }
  },
  "mission": "To provide support and resources to the community.",
  "yearFounded": "2024",
  "socials": {
    "website": "https://www.example.com",
    "facebook": "https://www.facebook.com/example",
    "twitterOrX": "https://x.com/example",
    "instagram": "https://www.instagram.com/example",
    "linkedin": "https://www.linkedin.com/company/example",
    "otherSocials": {
      "youtube": "https://www.youtube.com/example"
    }
  }
}

Changelog

Section titled “Changelog”
VersionChangesSchema
0.4.0
  • Added identifiers field
  • Removed ein field
  • Removed uei field
  • Removed duns field
OrganizationBase.yaml
0.2.0
  • Added OrganizationBase model
OrganizationBase.yaml

OrgIds

Section titled “OrgIds”

A collection of identifiers associated with an organization, keyed by registry code. It extends the generic IdentifierCollection collection with the base identifiers CommonGrants defines for organizations. Additional registries can be published under otherIds.

Table

Section titled “Table”
PropertyTypeRequiredDescription
systemIdSystemIdNoThe hosting system's own identifier for this record.
otherIdsrecord<Identifier>NoAdditional identifiers keyed by their registry code, for registries the protocol does not define as a base identifier on the model.
org:us:einOrgIdEinNoThe organization's Employer Identification Number (EIN), assigned by the IRS.
org:us:ueiOrgIdUeiNoThe organization's Unique Entity Identifier (UEI) from SAM.gov.
org:xi:dunsOrgIdDunsNoThe organization's Data Universal Numbering System (DUNS) number.

Formats

Section titled “Formats”

A JSON example of this model.

{
  "org:us:ein": {
    "registry": {
      "code": "org:us:ein",
      "url": "https://commongrants.org/registries/org-us-ein"
    },
    "id": "123456789"
  },
  "org:us:uei": {
    "registry": {
      "code": "org:us:uei",
      "url": "https://commongrants.org/registries/org-us-uei"
    },
    "id": "AB0123456789"
  },
  "org:xi:duns": {
    "registry": {
      "code": "org:xi:duns",
      "url": "https://commongrants.org/registries/org-xi-duns"
    },
    "id": "123456789"
  },
  "systemId": {
    "registry": {
      "code": "org:grants.gov:system",
      "url": "https://commongrants.org/registries/org-grants-gov-system"
    },
    "id": "01912a8b-7c3d-7890-abcd-ef1234567890"
  },
  "otherIds": {
    "org:candid:bridge": {
      "registry": {
        "code": "org:candid:bridge"
      },
      "id": "1234567"
    }
  }
}

Changelog

Section titled “Changelog”
VersionChangesSchema
0.4.0
  • Added OrgIds model
OrgIds.yaml

OrgIdEin

Section titled “OrgIdEin”

An organization’s Employer Identification Number (EIN), assigned by the IRS. It pins registry.code to org:us:ein and constrains the identifier value to the employerTaxId format.

Table

Section titled “Table”
PropertyTypeRequiredDescription
registryrecordNoRegistry-level facts shared by every record in this registry.
idemployerTaxIdNoThe primary identifier string, when the registry has a single canonical value. May be omitted for registries with no natural primary; consumers should read `allIds` in that case.
allIdsarray<object>NoEvery known identifier for this record in this registry, including archived values.

Formats

Section titled “Formats”

A JSON example of this model.

{
  "registry": {
    "code": "org:us:ein",
    "url": "https://commongrants.org/registries/org-us-ein"
  },
  "id": "123456789"
}

Changelog

Section titled “Changelog”
VersionChangesSchema
0.4.0
  • Added OrgIdEin model
OrgIdEin.yaml

OrgIdUei

Section titled “OrgIdUei”

An organization’s Unique Entity Identifier (UEI) from SAM.gov. It pins registry.code to org:us:uei and constrains the identifier value to the samUEI format.

Table

Section titled “Table”
PropertyTypeRequiredDescription
registryrecordNoRegistry-level facts shared by every record in this registry.
idsamUEINoThe primary identifier string, when the registry has a single canonical value. May be omitted for registries with no natural primary; consumers should read `allIds` in that case.
allIdsarray<object>NoEvery known identifier for this record in this registry, including archived values.

Formats

Section titled “Formats”

A JSON example of this model.

{
  "registry": {
    "code": "org:us:uei",
    "url": "https://commongrants.org/registries/org-us-uei"
  },
  "id": "AB0123456789"
}

Changelog

Section titled “Changelog”
VersionChangesSchema
0.4.0
  • Added OrgIdUei model
OrgIdUei.yaml

OrgIdDuns

Section titled “OrgIdDuns”

An organization’s Data Universal Numbering System (DUNS) number. It pins registry.code to org:xi:duns and constrains the identifier value to the duns format.

Table

Section titled “Table”
PropertyTypeRequiredDescription
registryrecordNoRegistry-level facts shared by every record in this registry.
iddunsNoThe primary identifier string, when the registry has a single canonical value. May be omitted for registries with no natural primary; consumers should read `allIds` in that case.
allIdsarray<object>NoEvery known identifier for this record in this registry, including archived values.

Formats

Section titled “Formats”

A JSON example of this model.

{
  "registry": {
    "code": "org:xi:duns",
    "url": "https://commongrants.org/registries/org-xi-duns"
  },
  "id": "123456789"
}

Changelog

Section titled “Changelog”
VersionChangesSchema
0.4.0
  • Added OrgIdDuns model
OrgIdDuns.yaml

OrgRef

Section titled “OrgRef”

A reference to an organization, previewing the key fields a consumer needs to identify it and look it up or join it to another response. Appears wherever another record points to an organization, such as an award’s funder or recipient.

Table

Section titled “Table”
PropertyTypeRequiredDescription
iduuidYesThe organization's unique identifier.
namestringYesThe organization's legal name as registered with relevant authorities.
identifiersOrgIdsNoIdentifiers associated with the organization, keyed by registry code.

Formats

Section titled “Formats”

A JSON example of this model.

{
  "id": "018f2e77-4b5c-7d2e-9f3a-bcdef1234567",
  "name": "Health Resources and Services Administration",
  "identifiers": {
    "otherIds": {
      "org:grants.gov:agency": {
        "registry": {
          "code": "org:grants.gov:agency"
        },
        "id": "HRSA"
      }
    }
  }
}

Changelog

Section titled “Changelog”
VersionChangesSchema
0.4.0
  • Added identifiers field
OrgRef.yaml
0.2.0
  • Added OrgRef model
OrgRef.yaml

OrgRefCollection

Section titled “OrgRefCollection”

A group of organization references, with a primary organization and optional others. Appears wherever several organizations share a role on a record, such as an award’s funders or recipient organizations.

Table

Section titled “Table”
PropertyTypeRequiredDescription
primaryOrgRefYesThe primary organization in the collection.
otherOrgsrecord<OrgRef>NoOther organizations in the collection, keyed by an implementation-defined role.

Formats

Section titled “Formats”

A JSON example of this model.

{
  "primary": {
    "id": "018f2e77-4b5c-7d2e-9f3a-bcdef1234567",
    "name": "Health Resources and Services Administration",
    "identifiers": {
      "otherIds": {
        "org:grants.gov:agency": {
          "registry": {
            "code": "org:grants.gov:agency"
          },
          "id": "HRSA"
        }
      }
    }
  }
}

Changelog

Section titled “Changelog”
VersionChangesSchema
0.4.0
  • Added OrgRefCollection model
OrgRefCollection.yaml
Section titled “OrgSocialLinks”

A collection of social media and web presence links for an organization.

Table

Section titled “Table”
Property Type Required Description
website url No The organization’s primary website URL.
facebook url No The organization’s Facebook profile URL.
twitterOrX url No The organization’s Twitter/X profile URL.
bluesky url No The organization’s Bluesky profile URL.
instagram url No The organization’s Instagram profile URL.
linkedin url No The organization’s LinkedIn profile URL.
otherSocials Record<url> No Additional social media profiles not covered by the standard fields.

Formats

Section titled “Formats”

A JSON example of this model.

{
  "website": "https://www.example.com",
  "facebook": "https://www.facebook.com/example",
  "twitterOrX": "https://x.com/example",
  "bluesky": "https://bsky.app/profile/example",
  "instagram": "https://www.instagram.com/example",
  "linkedin": "https://www.linkedin.com/company/example",
  "otherSocials": {
    "youtube": "https://www.youtube.com/example",
    "tiktok": "https://tiktok.com/example"
  }
}

Changelog

Section titled “Changelog”
VersionChangesSchema
0.2.0
  • Added OrgSocialLinks model
OrgSocialLinks.yaml