Skip to content

Org

a company or institution that the user has worked for; The user can serve for one or more roles at an organisation.
Type: object
Properties

id

an identifier for the organisation; In implementations, this can be used as a key to find the logo for the organisation.
Type: string

name *

the name of the organisation
Type: string
Required: yes

shortName

a short informal name for the organisation; This can be an abbreviation like 'CC' instead of 'Creative Commons', for example.
Type: string

summary

a short description or introduction of the organisation; This is used where space is limited such as a résumé.
Type: string

description

long-form description of the organisation; This is used where space is not constrained.
Type: string

url

the public facing URL to access the organisation website; This should be a place where more information about the organisation can be found.
Type: Url

address

the physical location of the organisation; This can be a workplace or the location where the organisation is registered to receive communications.
Type: Address

contact

the contact information to reach the organisation
Type: Contact

roles

a list of roles that are part of this organisation
Type: array
Default: []
Item

Type: Role