Skip to content

orgSchema

type: object

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

id

type: string
optional? yes

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

name

type: string

the name of the organisation

shortName

type: string
optional? yes

a short informal name for the organisation; This can be an abbreviation like ‘CC’ instead of ‘Creative Commons’, for example.

summary

type: string
optional? yes

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

description

type: string
optional? yes

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

url

type: urlSchema
optional? yes

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

address

type: addressSchema
optional? yes

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

contact

type: contactSchema
optional? yes

the contact information to reach the organisation

roles

type: array
optional? yes

a list of roles that are part of this organisation

roles[idx]

type: roleSchema

an experience of working in a role at an organisation