id.sifa.getProfileView

sifa.id

Documentation

Get the aggregated public profile view for an actor.

main query

Get the aggregated public profile view for an actor.

Parameters

actor string at-identifier Required

The handle or DID of the profile to fetch.

Output

Encodingapplication/json

Errors

ProfileNotFound No profile exists for the given actor, or the actor could not be resolved.
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
The handle or DID of the profile to fetch.
View raw schema
{
  "description": "Get the aggregated public profile view for an actor.",
  "errors": [
    {
      "description": "No profile exists for the given actor, or the actor could not be resolved.",
      "name": "ProfileNotFound"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "ref": "#profileView",
      "type": "ref"
    }
  },
  "parameters": {
    "properties": {
      "actor": {
        "description": "The handle or DID of the profile to fetch.",
        "format": "at-identifier",
        "type": "string"
      }
    },
    "required": [
      "actor"
    ],
    "type": "params"
  },
  "type": "query"
}
activeAppView object

An AT Protocol app the account has recently created records in.

Properties

category string Optional

App category.

id string Required

App identifier.

latestRecordAt string datetime Optional

Timestamp of the latest record.

name string Required

App display name.

recentCount integer Optional

Recent record count.

View raw schema
{
  "description": "An AT Protocol app the account has recently created records in.",
  "properties": {
    "category": {
      "description": "App category.",
      "type": "string"
    },
    "id": {
      "description": "App identifier.",
      "type": "string"
    },
    "latestRecordAt": {
      "description": "Timestamp of the latest record.",
      "format": "datetime",
      "type": "string"
    },
    "name": {
      "description": "App display name.",
      "type": "string"
    },
    "recentCount": {
      "description": "Recent record count.",
      "type": "integer"
    }
  },
  "required": [
    "id",
    "name"
  ],
  "type": "object"
}
atfundLink object

A contribution or funding link.

Properties

label string Optional

Optional display label.

url string uri Required

Contribution URL.

View raw schema
{
  "description": "A contribution or funding link.",
  "properties": {
    "label": {
      "description": "Optional display label.",
      "type": "string"
    },
    "url": {
      "description": "Contribution URL.",
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "url"
  ],
  "type": "object"
}
certificationView object

A certification or license.

Properties

agentRef ref id.sifa.defs#agentRef Optional

Canonical issuing-authority reference (name plus optional did/entityRef). Mirrors the flat authority/entityRef fields during the migration; the two always agree.

credentialUrl string uri Optional

URL of the credential.

currentCompanyName string Optional

Current canonical name of the linked entity, when it resolves. The web shows it as a "Now {name}" hint when it differs from the saved snapshot name (#516).

entityRef string uri Optional

Pointer URI to the resolved issuer entity.

expiryDate string Optional

Expiry date. Partial date.

issueDate string Optional

Issue date. Partial date.

issuingOrg string Optional

Issuing organization.

name string Required

Certification name.

rkey string Required

Record key of the certification record.

View raw schema
{
  "description": "A certification or license.",
  "properties": {
    "agentRef": {
      "description": "Canonical issuing-authority reference (name plus optional did/entityRef). Mirrors the flat authority/entityRef fields during the migration; the two always agree.",
      "ref": "id.sifa.defs#agentRef",
      "type": "ref"
    },
    "credentialUrl": {
      "description": "URL of the credential.",
      "format": "uri",
      "type": "string"
    },
    "currentCompanyName": {
      "description": "Current canonical name of the linked entity, when it resolves. The web shows it as a \"Now {name}\" hint when it differs from the saved snapshot name (#516).",
      "type": "string"
    },
    "entityRef": {
      "description": "Pointer URI to the resolved issuer entity.",
      "format": "uri",
      "type": "string"
    },
    "expiryDate": {
      "description": "Expiry date. Partial date.",
      "type": "string"
    },
    "issueDate": {
      "description": "Issue date. Partial date.",
      "type": "string"
    },
    "issuingOrg": {
      "description": "Issuing organization.",
      "type": "string"
    },
    "name": {
      "description": "Certification name.",
      "type": "string"
    },
    "rkey": {
      "description": "Record key of the certification record.",
      "type": "string"
    }
  },
  "required": [
    "rkey",
    "name"
  ],
  "type": "object"
}
coSpeakerView object

A co-speaker on a presentation delivery.

Properties

avatar string uri Optional

Avatar URL, when linked.

did string did Optional

DID of the co-speaker, when linked to a Sifa profile.

displayName string Optional

Display name, when linked.

handle string handle Optional

Handle, when linked.

name string Optional

Free-text co-speaker name, when not linked.

View raw schema
{
  "description": "A co-speaker on a presentation delivery.",
  "properties": {
    "avatar": {
      "description": "Avatar URL, when linked.",
      "format": "uri",
      "type": "string"
    },
    "did": {
      "description": "DID of the co-speaker, when linked to a Sifa profile.",
      "format": "did",
      "type": "string"
    },
    "displayName": {
      "description": "Display name, when linked.",
      "type": "string"
    },
    "handle": {
      "description": "Handle, when linked.",
      "format": "handle",
      "type": "string"
    },
    "name": {
      "description": "Free-text co-speaker name, when not linked.",
      "type": "string"
    }
  },
  "type": "object"
}
contributorView object

A linked publication contributor.

Properties

did string did Optional

Sifa/AT Protocol DID, when linked.

handle string handle Optional

Handle, when linked.

name string Required

Contributor name.

orcidId string Optional

ORCID identifier.

View raw schema
{
  "description": "A linked publication contributor.",
  "properties": {
    "did": {
      "description": "Sifa/AT Protocol DID, when linked.",
      "format": "did",
      "type": "string"
    },
    "handle": {
      "description": "Handle, when linked.",
      "format": "handle",
      "type": "string"
    },
    "name": {
      "description": "Contributor name.",
      "type": "string"
    },
    "orcidId": {
      "description": "ORCID identifier.",
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}
courseView object

A course entry.

Properties

agentRef ref id.sifa.defs#agentRef Optional

Canonical institution reference (name plus optional did/entityRef). Mirrors the flat institution/entityRef fields during the migration; the two always agree.

completedAt string Optional

Completion date of a taken course (YYYY-MM or YYYY-MM-DD).

credentialRkey string Optional

Record key of a linked certification, when present.

currentCompanyName string Optional

Current canonical name of the linked entity, when it resolves. The web shows it as a "Now {name}" hint when it differs from the saved snapshot name (#516).

educationRkey string Optional

Record key of the linked education record the course was part of, when present.

endedAt string Optional

When the user last taught the course; absent if ongoing.

entityRef string uri Optional

Pointer URI to the resolved institution entity.

institution string Optional

Institution name.

name string Required

Course name.

number string Optional

Course number or code.

positionRkey string Optional

Record key of the linked position the course was part of, when present.

rkey string Required

Record key of the course record.

role string Optional

The user's role in the course (id.sifa.defs#courseRole). Absent means taken.

startedAt string Optional

When the user started teaching the course (YYYY, YYYY-MM or YYYY-MM-DD).

View raw schema
{
  "description": "A course entry.",
  "properties": {
    "agentRef": {
      "description": "Canonical institution reference (name plus optional did/entityRef). Mirrors the flat institution/entityRef fields during the migration; the two always agree.",
      "ref": "id.sifa.defs#agentRef",
      "type": "ref"
    },
    "completedAt": {
      "description": "Completion date of a taken course (YYYY-MM or YYYY-MM-DD).",
      "type": "string"
    },
    "credentialRkey": {
      "description": "Record key of a linked certification, when present.",
      "type": "string"
    },
    "currentCompanyName": {
      "description": "Current canonical name of the linked entity, when it resolves. The web shows it as a \"Now {name}\" hint when it differs from the saved snapshot name (#516).",
      "type": "string"
    },
    "educationRkey": {
      "description": "Record key of the linked education record the course was part of, when present.",
      "type": "string"
    },
    "endedAt": {
      "description": "When the user last taught the course; absent if ongoing.",
      "type": "string"
    },
    "entityRef": {
      "description": "Pointer URI to the resolved institution entity.",
      "format": "uri",
      "type": "string"
    },
    "institution": {
      "description": "Institution name.",
      "type": "string"
    },
    "name": {
      "description": "Course name.",
      "type": "string"
    },
    "number": {
      "description": "Course number or code.",
      "type": "string"
    },
    "positionRkey": {
      "description": "Record key of the linked position the course was part of, when present.",
      "type": "string"
    },
    "rkey": {
      "description": "Record key of the course record.",
      "type": "string"
    },
    "role": {
      "description": "The user's role in the course (id.sifa.defs#courseRole). Absent means taken.",
      "type": "string"
    },
    "startedAt": {
      "description": "When the user started teaching the course (YYYY, YYYY-MM or YYYY-MM-DD).",
      "type": "string"
    }
  },
  "required": [
    "rkey",
    "name"
  ],
  "type": "object"
}
durationView object

A duration range in minutes.

Properties

maxMinutes integer Optional

Maximum duration in minutes.

minMinutes integer Required

Minimum duration in minutes.

View raw schema
{
  "description": "A duration range in minutes.",
  "properties": {
    "maxMinutes": {
      "description": "Maximum duration in minutes.",
      "type": "integer"
    },
    "minMinutes": {
      "description": "Minimum duration in minutes.",
      "type": "integer"
    }
  },
  "required": [
    "minMinutes"
  ],
  "type": "object"
}
educationView object

An education-history entry.

Properties

activities string Optional

Activities and societies.

agentRef ref id.sifa.defs#agentRef Optional

Canonical institution reference (name plus optional did/entityRef). Mirrors the flat institution/institutionDid/entityRef fields during the migration; the two always agree.

currentCompanyName string Optional

Current canonical name of the linked entity, when it resolves. The web shows it as a "Now {name}" hint when it differs from the saved snapshot name (#516).

degree string Optional

Degree earned.

description string Optional

Additional description.

endedAt string Optional

End date. Partial date.

entityRef string uri Optional

Pointer URI to the resolved institution entity.

eqfLevel integer Optional

European Qualifications Framework level of the degree (1 to 8, 8 is doctoral), when set.

minimum: 1maximum: 8
fieldOfStudy string Optional

Field of study.

institution string Optional

Institution name.

institutionDid string did Optional

DID of the institution, when known.

primary boolean Optional

Whether this is the user's primary education entry.

rkey string Required

Record key of the education record.

startedAt string Optional

Start date. Partial date.

View raw schema
{
  "description": "An education-history entry.",
  "properties": {
    "activities": {
      "description": "Activities and societies.",
      "type": "string"
    },
    "agentRef": {
      "description": "Canonical institution reference (name plus optional did/entityRef). Mirrors the flat institution/institutionDid/entityRef fields during the migration; the two always agree.",
      "ref": "id.sifa.defs#agentRef",
      "type": "ref"
    },
    "currentCompanyName": {
      "description": "Current canonical name of the linked entity, when it resolves. The web shows it as a \"Now {name}\" hint when it differs from the saved snapshot name (#516).",
      "type": "string"
    },
    "degree": {
      "description": "Degree earned.",
      "type": "string"
    },
    "description": {
      "description": "Additional description.",
      "type": "string"
    },
    "endedAt": {
      "description": "End date. Partial date.",
      "type": "string"
    },
    "entityRef": {
      "description": "Pointer URI to the resolved institution entity.",
      "format": "uri",
      "type": "string"
    },
    "eqfLevel": {
      "description": "European Qualifications Framework level of the degree (1 to 8, 8 is doctoral), when set.",
      "maximum": 8,
      "minimum": 1,
      "type": "integer"
    },
    "fieldOfStudy": {
      "description": "Field of study.",
      "type": "string"
    },
    "institution": {
      "description": "Institution name.",
      "type": "string"
    },
    "institutionDid": {
      "description": "DID of the institution, when known.",
      "format": "did",
      "type": "string"
    },
    "primary": {
      "description": "Whether this is the user's primary education entry.",
      "type": "boolean"
    },
    "rkey": {
      "description": "Record key of the education record.",
      "type": "string"
    },
    "startedAt": {
      "description": "Start date. Partial date.",
      "type": "string"
    }
  },
  "required": [
    "rkey"
  ],
  "type": "object"
}
externalAccountView object

A linked external account with verification state.

Properties

feedUrl string uri Optional

Feed URL (RSS/Atom), when applicable.

label string Optional

Optional custom label.

primary boolean Optional

Whether this is the primary external account.

rkey string Required

Record key of the external account record.

url string uri Required

Account URL.

verifiable boolean Optional

Whether the account can be verified.

verified boolean Optional

Whether the account is verified.

verifiedVia string Optional

Verification method, when verified.

View raw schema
{
  "description": "A linked external account with verification state.",
  "properties": {
    "feedUrl": {
      "description": "Feed URL (RSS/Atom), when applicable.",
      "format": "uri",
      "type": "string"
    },
    "label": {
      "description": "Optional custom label.",
      "type": "string"
    },
    "platform": {
      "description": "Platform type.",
      "ref": "id.sifa.defs#externalPlatform",
      "type": "ref"
    },
    "primary": {
      "description": "Whether this is the primary external account.",
      "type": "boolean"
    },
    "rkey": {
      "description": "Record key of the external account record.",
      "type": "string"
    },
    "url": {
      "description": "Account URL.",
      "format": "uri",
      "type": "string"
    },
    "verifiable": {
      "description": "Whether the account can be verified.",
      "type": "boolean"
    },
    "verified": {
      "description": "Whether the account is verified.",
      "type": "boolean"
    },
    "verifiedVia": {
      "description": "Verification method, when verified.",
      "type": "string"
    }
  },
  "required": [
    "rkey",
    "url"
  ],
  "type": "object"
}
honorView object

An honor or award.

Properties

agentRef ref id.sifa.defs#agentRef Optional

Canonical issuer reference (name plus optional did/entityRef). Mirrors the flat issuer/entityRef fields during the migration; the two always agree.

currentCompanyName string Optional

Current canonical name of the linked entity, when it resolves. The web shows it as a "Now {name}" hint when it differs from the saved snapshot name (#516).

date string Optional

Date received. Partial date.

description string Optional

Description.

entityRef string uri Optional

Pointer URI to the resolved issuer entity.

issuer string Optional

Issuing organization.

rkey string Required

Record key of the honor record.

title string Required

Honor or award title.

View raw schema
{
  "description": "An honor or award.",
  "properties": {
    "agentRef": {
      "description": "Canonical issuer reference (name plus optional did/entityRef). Mirrors the flat issuer/entityRef fields during the migration; the two always agree.",
      "ref": "id.sifa.defs#agentRef",
      "type": "ref"
    },
    "currentCompanyName": {
      "description": "Current canonical name of the linked entity, when it resolves. The web shows it as a \"Now {name}\" hint when it differs from the saved snapshot name (#516).",
      "type": "string"
    },
    "date": {
      "description": "Date received. Partial date.",
      "type": "string"
    },
    "description": {
      "description": "Description.",
      "type": "string"
    },
    "entityRef": {
      "description": "Pointer URI to the resolved issuer entity.",
      "format": "uri",
      "type": "string"
    },
    "issuer": {
      "description": "Issuing organization.",
      "type": "string"
    },
    "rkey": {
      "description": "Record key of the honor record.",
      "type": "string"
    },
    "title": {
      "description": "Honor or award title.",
      "type": "string"
    }
  },
  "required": [
    "rkey",
    "title"
  ],
  "type": "object"
}
involvementLinkView object

A proof link on an involvement.

Properties

kind string Optional

What the link points to (e.g. pull-request, talk, article).

label string Optional

Optional human-readable label.

url string uri Required

Artifact URL.

verified boolean Optional

True if the link host matches a verified external account.

verifiedPlatform string Optional

Platform token of the verified host, when verified.

View raw schema
{
  "description": "A proof link on an involvement.",
  "properties": {
    "kind": {
      "description": "What the link points to (e.g. pull-request, talk, article).",
      "type": "string"
    },
    "label": {
      "description": "Optional human-readable label.",
      "type": "string"
    },
    "url": {
      "description": "Artifact URL.",
      "format": "uri",
      "type": "string"
    },
    "verified": {
      "description": "True if the link host matches a verified external account.",
      "type": "boolean"
    },
    "verifiedPlatform": {
      "description": "Platform token of the verified host, when verified.",
      "type": "string"
    }
  },
  "required": [
    "url"
  ],
  "type": "object"
}
involvementView object

A community, open-source, charity, or civic involvement.

Properties

agentRef ref id.sifa.defs#agentRef Optional

Canonical upstream reference (name plus optional did/entityRef). Mirrors the flat upstream/upstreamDid/entityRef fields during the migration; the two always agree.

currentCompanyName string Optional

Current canonical name of the linked entity, when it resolves. The web shows it as a "Now {name}" hint when it differs from the saved snapshot name (#516).

description string Optional

Description.

endedAt string Optional

End date. Partial date.

legacy boolean Required

True if mapped from a legacy volunteering record.

primary boolean Optional

Whether this is the user's primary current involvement.

rkey string Required

Record key of the involvement (or legacy volunteering) record.

role string Optional

Role in the involvement.

startedAt string Optional

Start date. Partial date.

upstream string Optional

Name of the community, org, or person the involvement is with.

upstreamDid string did Optional

DID of the upstream, when known.

upstreamUrl string uri Optional

URL of the upstream, when provided.

View raw schema
{
  "description": "A community, open-source, charity, or civic involvement.",
  "properties": {
    "agentRef": {
      "description": "Canonical upstream reference (name plus optional did/entityRef). Mirrors the flat upstream/upstreamDid/entityRef fields during the migration; the two always agree.",
      "ref": "id.sifa.defs#agentRef",
      "type": "ref"
    },
    "currentCompanyName": {
      "description": "Current canonical name of the linked entity, when it resolves. The web shows it as a \"Now {name}\" hint when it differs from the saved snapshot name (#516).",
      "type": "string"
    },
    "description": {
      "description": "Description.",
      "type": "string"
    },
    "endedAt": {
      "description": "End date. Partial date.",
      "type": "string"
    },
    "kind": {
      "description": "The nature of the involvement.",
      "ref": "id.sifa.defs#involvementKind",
      "type": "ref"
    },
    "legacy": {
      "description": "True if mapped from a legacy volunteering record.",
      "type": "boolean"
    },
    "links": {
      "description": "Public artifact links proving the work.",
      "items": {
        "ref": "#involvementLinkView",
        "type": "ref"
      },
      "type": "array"
    },
    "primary": {
      "description": "Whether this is the user's primary current involvement.",
      "type": "boolean"
    },
    "rkey": {
      "description": "Record key of the involvement (or legacy volunteering) record.",
      "type": "string"
    },
    "role": {
      "description": "Role in the involvement.",
      "type": "string"
    },
    "startedAt": {
      "description": "Start date. Partial date.",
      "type": "string"
    },
    "upstream": {
      "description": "Name of the community, org, or person the involvement is with.",
      "type": "string"
    },
    "upstreamDid": {
      "description": "DID of the upstream, when known.",
      "format": "did",
      "type": "string"
    },
    "upstreamUrl": {
      "description": "URL of the upstream, when provided.",
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "rkey",
    "kind",
    "links",
    "legacy"
  ],
  "type": "object"
}
languageView object

A language with proficiency.

Properties

language string Required

Language name or BCP-47 tag.

rkey string Required

Record key of the language record.

View raw schema
{
  "description": "A language with proficiency.",
  "properties": {
    "language": {
      "description": "Language name or BCP-47 tag.",
      "type": "string"
    },
    "proficiency": {
      "description": "Proficiency level.",
      "ref": "id.sifa.defs#proficiency",
      "type": "ref"
    },
    "rkey": {
      "description": "Record key of the language record.",
      "type": "string"
    }
  },
  "required": [
    "rkey",
    "language"
  ],
  "type": "object"
}
locationView object

A professional location on the profile.

Properties

countryCode string Optional

ISO 3166-1 alpha-2 country code.

isPrimary boolean Optional

Whether this is the primary location.

label string Optional

Optional custom label.

location string Optional

Assembled human-readable location string.

locationCountry string Optional

Country name.

locationLocality string Optional

City or locality.

locationRegion string Optional

Region, state, or province.

rkey string Required

Record key of the location record.

View raw schema
{
  "description": "A professional location on the profile.",
  "properties": {
    "countryCode": {
      "description": "ISO 3166-1 alpha-2 country code.",
      "type": "string"
    },
    "isPrimary": {
      "description": "Whether this is the primary location.",
      "type": "boolean"
    },
    "label": {
      "description": "Optional custom label.",
      "type": "string"
    },
    "location": {
      "description": "Assembled human-readable location string.",
      "type": "string"
    },
    "locationCountry": {
      "description": "Country name.",
      "type": "string"
    },
    "locationLocality": {
      "description": "City or locality.",
      "type": "string"
    },
    "locationRegion": {
      "description": "Region, state, or province.",
      "type": "string"
    },
    "rkey": {
      "description": "Record key of the location record.",
      "type": "string"
    },
    "type": {
      "description": "The role this location plays.",
      "ref": "id.sifa.defs#locationType",
      "type": "ref"
    }
  },
  "required": [
    "rkey"
  ],
  "type": "object"
}
pdsProviderView object

A PDS provider descriptor.

Properties

host string Optional

PDS hostname.

name string Required

Human-readable provider name.

View raw schema
{
  "description": "A PDS provider descriptor.",
  "properties": {
    "host": {
      "description": "PDS hostname.",
      "type": "string"
    },
    "name": {
      "description": "Human-readable provider name.",
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}
positionVerification object

Summary of the id.sifa.verification.employment record Sifa issued for a position.

Properties

expiresAt string datetime Optional

Present only while the verification rests on email alone.

uri string at-uri Optional

AT-URI of the issued id.sifa.verification.employment record in Sifa's issuer repository.

verifiedAt string datetime Required

An RFC 3339 formatted timestamp.

View raw schema
{
  "description": "Summary of the id.sifa.verification.employment record Sifa issued for a position.",
  "properties": {
    "expiresAt": {
      "description": "Present only while the verification rests on email alone.",
      "format": "datetime",
      "type": "string"
    },
    "methods": {
      "description": "Every method that currently backs the verification.",
      "items": {
        "ref": "id.sifa.defs#verificationMethod",
        "type": "ref"
      },
      "type": "array"
    },
    "status": {
      "ref": "id.sifa.defs#employmentStatus",
      "type": "ref"
    },
    "uri": {
      "description": "AT-URI of the issued id.sifa.verification.employment record in Sifa's issuer repository.",
      "format": "at-uri",
      "type": "string"
    },
    "verifiedAt": {
      "format": "datetime",
      "type": "string"
    }
  },
  "required": [
    "methods",
    "status",
    "verifiedAt"
  ],
  "type": "object"
}
positionView object

A work-history entry.

Properties

agentRef ref id.sifa.defs#agentRef Optional

Canonical organization reference (name plus optional did/entityRef). Mirrors the flat company/companyDid/entityRef fields during the migration; the two always agree.

company string Optional

Organization name.

companyDid string did Optional

DID of the organization, when known.

countryCode string Optional

ISO 3166-1 alpha-2 country code.

currentCompanyName string Optional

Current canonical name of the linked entity, when it resolves. The web shows it as a "Now {name}" hint when it differs from the saved snapshot name (#516).

description string Optional

Role description.

endedAt string Optional

End date. Partial date, absent if current.

entityName string Optional

Resolved canonical organization name.

entityRef string uri Optional

Pointer URI to the resolved organization entity.

location string Optional

Assembled human-readable location string.

locationCountry string Optional

Country name.

locationLocality string Optional

City or locality.

locationRegion string Optional

Region, state, or province.

onBehalfOf string Optional

Party this role is held on behalf of, when the person represents someone else — most often a fund whose board seat this is. A disclosure, not a role type. Absent for independent roles.

onBehalfOfDid string did Optional

DID of the represented party, when known. May be an organization or a person.

onBehalfOfEntityName string Optional

Resolved canonical name for the represented party. Present only when the reference resolves; clients render onBehalfOf otherwise, never the raw URI.

onBehalfOfEntityRef string uri Optional

Pointer URI to the resolved entity for the represented party.

primary boolean Optional

Whether this is the user's primary current position.

rkey string Required

Record key of the position record.

skillRkeys array of string Optional

Record keys of skills linked to this position.

startedAt string Optional

Start date. Partial date (YYYY, YYYY-MM, or YYYY-MM-DD).

title string Required

Job title or role.

verification ref #positionVerification Optional

Sifa's verification of this position, when one is issued. Absent when the position is not verified; absence is not a negative signal.

View raw schema
{
  "description": "A work-history entry.",
  "properties": {
    "agentRef": {
      "description": "Canonical organization reference (name plus optional did/entityRef). Mirrors the flat company/companyDid/entityRef fields during the migration; the two always agree.",
      "ref": "id.sifa.defs#agentRef",
      "type": "ref"
    },
    "company": {
      "description": "Organization name.",
      "type": "string"
    },
    "companyDid": {
      "description": "DID of the organization, when known.",
      "format": "did",
      "type": "string"
    },
    "countryCode": {
      "description": "ISO 3166-1 alpha-2 country code.",
      "type": "string"
    },
    "currentCompanyName": {
      "description": "Current canonical name of the linked entity, when it resolves. The web shows it as a \"Now {name}\" hint when it differs from the saved snapshot name (#516).",
      "type": "string"
    },
    "description": {
      "description": "Role description.",
      "type": "string"
    },
    "employmentType": {
      "description": "Employment arrangement.",
      "ref": "id.sifa.defs#employmentType",
      "type": "ref"
    },
    "endedAt": {
      "description": "End date. Partial date, absent if current.",
      "type": "string"
    },
    "entityName": {
      "description": "Resolved canonical organization name.",
      "type": "string"
    },
    "entityRef": {
      "description": "Pointer URI to the resolved organization entity.",
      "format": "uri",
      "type": "string"
    },
    "location": {
      "description": "Assembled human-readable location string.",
      "type": "string"
    },
    "locationCountry": {
      "description": "Country name.",
      "type": "string"
    },
    "locationLocality": {
      "description": "City or locality.",
      "type": "string"
    },
    "locationRegion": {
      "description": "Region, state, or province.",
      "type": "string"
    },
    "onBehalfOf": {
      "description": "Party this role is held on behalf of, when the person represents someone else — most often a fund whose board seat this is. A disclosure, not a role type. Absent for independent roles.",
      "type": "string"
    },
    "onBehalfOfDid": {
      "description": "DID of the represented party, when known. May be an organization or a person.",
      "format": "did",
      "type": "string"
    },
    "onBehalfOfEntityName": {
      "description": "Resolved canonical name for the represented party. Present only when the reference resolves; clients render onBehalfOf otherwise, never the raw URI.",
      "type": "string"
    },
    "onBehalfOfEntityRef": {
      "description": "Pointer URI to the resolved entity for the represented party.",
      "format": "uri",
      "type": "string"
    },
    "primary": {
      "description": "Whether this is the user's primary current position.",
      "type": "boolean"
    },
    "rkey": {
      "description": "Record key of the position record.",
      "type": "string"
    },
    "skillRkeys": {
      "description": "Record keys of skills linked to this position.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "startedAt": {
      "description": "Start date. Partial date (YYYY, YYYY-MM, or YYYY-MM-DD).",
      "type": "string"
    },
    "title": {
      "description": "Job title or role.",
      "type": "string"
    },
    "verification": {
      "description": "Sifa's verification of this position, when one is issued. Absent when the position is not verified; absence is not a negative signal.",
      "ref": "#positionVerification",
      "type": "ref"
    },
    "workplaceType": {
      "description": "Workplace arrangement.",
      "ref": "id.sifa.defs#workplaceType",
      "type": "ref"
    }
  },
  "required": [
    "rkey",
    "title"
  ],
  "type": "object"
}
presentationDeliveryView object

A single delivery of a presentation at an occasion.

Properties

coSpeakers array of ref#coSpeakerView Optional

Co-speakers on this delivery.

date string Optional

Delivery date. Partial date.

eventName string Optional

Name of the event or occasion.

eventUri string at-uri Optional

AT-URI of a linked event record.

location string Optional

Event location.

mode string Optional

Delivery mode (e.g. in-person, remote, hybrid).

presentationRkey string Optional

Record key of the parent presentation, when grouped.

rkey string Required

Record key of the delivery record.

status string Optional

Delivery status.

title string Optional

Delivery title (may differ from the presentation title).

View raw schema
{
  "description": "A single delivery of a presentation at an occasion.",
  "properties": {
    "coSpeakers": {
      "description": "Co-speakers on this delivery.",
      "items": {
        "ref": "#coSpeakerView",
        "type": "ref"
      },
      "type": "array"
    },
    "date": {
      "description": "Delivery date. Partial date.",
      "type": "string"
    },
    "eventName": {
      "description": "Name of the event or occasion.",
      "type": "string"
    },
    "eventUri": {
      "description": "AT-URI of a linked event record.",
      "format": "at-uri",
      "type": "string"
    },
    "links": {
      "description": "Related links for this delivery.",
      "items": {
        "ref": "id.sifa.defs#presentationLink",
        "type": "ref"
      },
      "type": "array"
    },
    "location": {
      "description": "Event location.",
      "type": "string"
    },
    "mode": {
      "description": "Delivery mode (e.g. in-person, remote, hybrid).",
      "type": "string"
    },
    "presentationRkey": {
      "description": "Record key of the parent presentation, when grouped.",
      "type": "string"
    },
    "rkey": {
      "description": "Record key of the delivery record.",
      "type": "string"
    },
    "role": {
      "description": "The user's role in the delivery.",
      "ref": "id.sifa.defs#presentationRole",
      "type": "ref"
    },
    "status": {
      "description": "Delivery status.",
      "type": "string"
    },
    "title": {
      "description": "Delivery title (may differ from the presentation title).",
      "type": "string"
    }
  },
  "required": [
    "rkey"
  ],
  "type": "object"
}
presentationView object

A talk or session (content), with its deliveries grouped underneath.

Properties

description string Optional

Presentation description.

intendedAudiences array of string Optional

Intended audiences.

primary boolean Optional

Whether this is the user's primary talk.

rkey string Required

Record key of the presentation record.

title string Required

Presentation title.

writeupUri string at-uri Optional

AT-URI of a linked write-up record.

View raw schema
{
  "description": "A talk or session (content), with its deliveries grouped underneath.",
  "properties": {
    "deliveries": {
      "description": "Deliveries of this presentation.",
      "items": {
        "ref": "#presentationDeliveryView",
        "type": "ref"
      },
      "type": "array"
    },
    "description": {
      "description": "Presentation description.",
      "type": "string"
    },
    "duration": {
      "description": "Duration range in minutes.",
      "ref": "#durationView",
      "type": "ref"
    },
    "intendedAudiences": {
      "description": "Intended audiences.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "links": {
      "description": "Related links (slides, recording, etc.).",
      "items": {
        "ref": "id.sifa.defs#presentationLink",
        "type": "ref"
      },
      "type": "array"
    },
    "primary": {
      "description": "Whether this is the user's primary talk.",
      "type": "boolean"
    },
    "rkey": {
      "description": "Record key of the presentation record.",
      "type": "string"
    },
    "title": {
      "description": "Presentation title.",
      "type": "string"
    },
    "writeupUri": {
      "description": "AT-URI of a linked write-up record.",
      "format": "at-uri",
      "type": "string"
    }
  },
  "required": [
    "rkey",
    "title",
    "deliveries"
  ],
  "type": "object"
}
profileView object

The aggregated public professional profile view.

Properties

about string Optional

Longer professional summary or bio.

maxLength: 50000 bytesmaxGraphemes: 5000 graphemes
activeApps array of ref#activeAppView Optional

AT Protocol apps this account has recently created records in.

atfundContribute ref #atfundLink Optional

Optional contribution/funding link.

atprotoFollowersCount integer Optional

Number of app.bsky.graph followers.

availableFromUtc integer Optional

Start of an availability window, as a UTC offset, if set.

availableToUtc integer Optional

End of an availability window, as a UTC offset, if set.

avatar string uri Optional

URL of the profile avatar image.

blueskyVerified boolean Optional

Whether the account holds a Bluesky verification.

blueskyVerifiedAt string datetime Optional

When the Bluesky verification was issued.

claimed boolean Optional

Whether the profile has been claimed by its owner on Sifa.

connectionsCount integer Optional

Number of confirmed professional connections.

countryCode string Optional

ISO 3166-1 alpha-2 country code for the primary location.

courses array of ref#courseView Optional

Courses, optionally linked to a credential.

createdAt string datetime Optional

When the profile record was created.

did string did Required

The account DID. Stable identifier for the profile.

displayName string Optional

Display name shown on the profile.

maxLength: 1280 bytesmaxGraphemes: 128 graphemes
education array of ref#educationView Optional

Education history entries.

externalAccounts array of ref#externalAccountView Optional

Linked external accounts, with verification state.

familyName string Optional

Family (last) name, when provided.

maxLength: 1280 bytesmaxGraphemes: 128 graphemes
followersCount integer Optional

Number of Sifa graph followers.

followingCount integer Optional

Number of accounts this profile follows on the Sifa graph.

givenName string Optional

Given (first) name, when provided.

maxLength: 1280 bytesmaxGraphemes: 128 graphemes
handle string handle Required

The current handle for the account.

headline string Optional

Short professional headline.

maxLength: 3000 bytesmaxGraphemes: 300 graphemes
honors array of ref#honorView Optional

Honors and awards.

involvement array of ref#involvementView Optional

Community, open-source, charity, and civic involvement.

langs array of string Optional

BCP-47 language tags the user has indicated.

languages array of ref#languageView Optional

Spoken/written languages with proficiency.

location string Optional

Assembled human-readable primary location string.

locationCountry string Optional

Primary location country name.

locationLocality string Optional

Primary location city or locality.

locationRegion string Optional

Primary location region, state, or province.

locations array of ref#locationView Optional

All professional locations on the profile.

metInPersonCount integer Optional

Number of confirmed in-person meetings.

positions array of ref#positionView Optional

Work history entries.

presentationDeliveries array of ref#presentationDeliveryView Optional

Standalone deliveries that reference no owned presentation.

presentations array of ref#presentationView Optional

Talks and sessions (content), each with its deliveries grouped underneath.

projects array of ref#projectView Optional

Personal or professional projects.

pronouns string Optional

Self-described pronouns.

maxLength: 640 bytesmaxGraphemes: 64 graphemes
publications array of ref#publicationView Optional

Publications, merged from Sifa records and linked ORCID works.

skills array of ref#skillView Optional

Skills, optionally linked to positions.

volunteering array of ref#volunteeringView Optional

Legacy volunteering entries. New entries are surfaced under involvement.

website string uri Optional

Primary personal or professional website.

View raw schema
{
  "description": "The aggregated public professional profile view.",
  "properties": {
    "about": {
      "description": "Longer professional summary or bio.",
      "maxGraphemes": 5000,
      "maxLength": 50000,
      "type": "string"
    },
    "activeApps": {
      "description": "AT Protocol apps this account has recently created records in.",
      "items": {
        "ref": "#activeAppView",
        "type": "ref"
      },
      "type": "array"
    },
    "atfundContribute": {
      "description": "Optional contribution/funding link.",
      "ref": "#atfundLink",
      "type": "ref"
    },
    "atprotoFollowersCount": {
      "description": "Number of app.bsky.graph followers.",
      "type": "integer"
    },
    "availableFromUtc": {
      "description": "Start of an availability window, as a UTC offset, if set.",
      "type": "integer"
    },
    "availableToUtc": {
      "description": "End of an availability window, as a UTC offset, if set.",
      "type": "integer"
    },
    "avatar": {
      "description": "URL of the profile avatar image.",
      "format": "uri",
      "type": "string"
    },
    "blueskyVerified": {
      "description": "Whether the account holds a Bluesky verification.",
      "type": "boolean"
    },
    "blueskyVerifiedAt": {
      "description": "When the Bluesky verification was issued.",
      "format": "datetime",
      "type": "string"
    },
    "certifications": {
      "description": "Certifications and licenses.",
      "items": {
        "ref": "#certificationView",
        "type": "ref"
      },
      "type": "array"
    },
    "claimed": {
      "description": "Whether the profile has been claimed by its owner on Sifa.",
      "type": "boolean"
    },
    "connectionsCount": {
      "description": "Number of confirmed professional connections.",
      "type": "integer"
    },
    "countryCode": {
      "description": "ISO 3166-1 alpha-2 country code for the primary location.",
      "type": "string"
    },
    "courses": {
      "description": "Courses, optionally linked to a credential.",
      "items": {
        "ref": "#courseView",
        "type": "ref"
      },
      "type": "array"
    },
    "createdAt": {
      "description": "When the profile record was created.",
      "format": "datetime",
      "type": "string"
    },
    "did": {
      "description": "The account DID. Stable identifier for the profile.",
      "format": "did",
      "type": "string"
    },
    "displayName": {
      "description": "Display name shown on the profile.",
      "maxGraphemes": 128,
      "maxLength": 1280,
      "type": "string"
    },
    "education": {
      "description": "Education history entries.",
      "items": {
        "ref": "#educationView",
        "type": "ref"
      },
      "type": "array"
    },
    "externalAccounts": {
      "description": "Linked external accounts, with verification state.",
      "items": {
        "ref": "#externalAccountView",
        "type": "ref"
      },
      "type": "array"
    },
    "familyName": {
      "description": "Family (last) name, when provided.",
      "maxGraphemes": 128,
      "maxLength": 1280,
      "type": "string"
    },
    "followersCount": {
      "description": "Number of Sifa graph followers.",
      "type": "integer"
    },
    "followingCount": {
      "description": "Number of accounts this profile follows on the Sifa graph.",
      "type": "integer"
    },
    "givenName": {
      "description": "Given (first) name, when provided.",
      "maxGraphemes": 128,
      "maxLength": 1280,
      "type": "string"
    },
    "handle": {
      "description": "The current handle for the account.",
      "format": "handle",
      "type": "string"
    },
    "headline": {
      "description": "Short professional headline.",
      "maxGraphemes": 300,
      "maxLength": 3000,
      "type": "string"
    },
    "honors": {
      "description": "Honors and awards.",
      "items": {
        "ref": "#honorView",
        "type": "ref"
      },
      "type": "array"
    },
    "industries": {
      "description": "Industry/domain pairs the user works in.",
      "items": {
        "ref": "id.sifa.defs#industryDomain",
        "type": "ref"
      },
      "type": "array"
    },
    "involvement": {
      "description": "Community, open-source, charity, and civic involvement.",
      "items": {
        "ref": "#involvementView",
        "type": "ref"
      },
      "type": "array"
    },
    "langs": {
      "description": "BCP-47 language tags the user has indicated.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "languages": {
      "description": "Spoken/written languages with proficiency.",
      "items": {
        "ref": "#languageView",
        "type": "ref"
      },
      "type": "array"
    },
    "location": {
      "description": "Assembled human-readable primary location string.",
      "type": "string"
    },
    "locationCountry": {
      "description": "Primary location country name.",
      "type": "string"
    },
    "locationLocality": {
      "description": "Primary location city or locality.",
      "type": "string"
    },
    "locationRegion": {
      "description": "Primary location region, state, or province.",
      "type": "string"
    },
    "locations": {
      "description": "All professional locations on the profile.",
      "items": {
        "ref": "#locationView",
        "type": "ref"
      },
      "type": "array"
    },
    "metInPersonCount": {
      "description": "Number of confirmed in-person meetings.",
      "type": "integer"
    },
    "openTo": {
      "description": "The kinds of opportunities the user is open to.",
      "items": {
        "ref": "id.sifa.defs#openToWorkStatus",
        "type": "ref"
      },
      "type": "array"
    },
    "pdsProvider": {
      "description": "The account PDS provider.",
      "ref": "#pdsProviderView",
      "type": "ref"
    },
    "positions": {
      "description": "Work history entries.",
      "items": {
        "ref": "#positionView",
        "type": "ref"
      },
      "type": "array"
    },
    "preferredWorkplace": {
      "description": "Preferred workplace arrangements.",
      "items": {
        "ref": "id.sifa.defs#workplaceType",
        "type": "ref"
      },
      "type": "array"
    },
    "presentationDeliveries": {
      "description": "Standalone deliveries that reference no owned presentation.",
      "items": {
        "ref": "#presentationDeliveryView",
        "type": "ref"
      },
      "type": "array"
    },
    "presentations": {
      "description": "Talks and sessions (content), each with its deliveries grouped underneath.",
      "items": {
        "ref": "#presentationView",
        "type": "ref"
      },
      "type": "array"
    },
    "projects": {
      "description": "Personal or professional projects.",
      "items": {
        "ref": "#projectView",
        "type": "ref"
      },
      "type": "array"
    },
    "pronouns": {
      "description": "Self-described pronouns.",
      "maxGraphemes": 64,
      "maxLength": 640,
      "type": "string"
    },
    "publications": {
      "description": "Publications, merged from Sifa records and linked ORCID works.",
      "items": {
        "ref": "#publicationView",
        "type": "ref"
      },
      "type": "array"
    },
    "skills": {
      "description": "Skills, optionally linked to positions.",
      "items": {
        "ref": "#skillView",
        "type": "ref"
      },
      "type": "array"
    },
    "volunteering": {
      "description": "Legacy volunteering entries. New entries are surfaced under involvement.",
      "items": {
        "ref": "#volunteeringView",
        "type": "ref"
      },
      "type": "array"
    },
    "website": {
      "description": "Primary personal or professional website.",
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "did",
    "handle"
  ],
  "type": "object"
}
projectEventView object

No description available.

Properties

country string Optional

ISO 3166-1 alpha-2 country code, from the event's first address.

locality string Optional

City, from the event's first address.

mode string Optional

Event mode token, from the event record.

name string Optional

Event name, from the event record.

role string Optional

The user's role at this occurrence, if it differs from the project's role.

startsAt string datetime Optional

Event start, from the event record.

uri string at-uri Required

AT-URI of the linked community.lexicon.calendar.event.

url string uri Optional

Event website, from the event's first uri.

View raw schema
{
  "properties": {
    "country": {
      "description": "ISO 3166-1 alpha-2 country code, from the event's first address.",
      "type": "string"
    },
    "locality": {
      "description": "City, from the event's first address.",
      "type": "string"
    },
    "mode": {
      "description": "Event mode token, from the event record.",
      "type": "string"
    },
    "name": {
      "description": "Event name, from the event record.",
      "type": "string"
    },
    "role": {
      "description": "The user's role at this occurrence, if it differs from the project's role.",
      "type": "string"
    },
    "startsAt": {
      "description": "Event start, from the event record.",
      "format": "datetime",
      "type": "string"
    },
    "uri": {
      "description": "AT-URI of the linked community.lexicon.calendar.event.",
      "format": "at-uri",
      "type": "string"
    },
    "url": {
      "description": "Event website, from the event's first uri.",
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "uri"
  ],
  "type": "object"
}
projectView object

A project entry.

Properties

description string Optional

Project description.

endDate string Optional

End date. Partial date.

events array of ref#projectEventView Optional

Events this project organized or hosted (from the record's events field), with display fields resolved from the referenced event records.

maxLength: 200 items
name string Required

Project name.

primary boolean Optional

Whether this is the user's primary ongoing project.

rkey string Required

Record key of the project record.

role string Optional

The user's own role on the project.

startDate string Optional

Start date. Partial date.

url string uri Optional

Project URL.

View raw schema
{
  "description": "A project entry.",
  "properties": {
    "description": {
      "description": "Project description.",
      "type": "string"
    },
    "endDate": {
      "description": "End date. Partial date.",
      "type": "string"
    },
    "events": {
      "description": "Events this project organized or hosted (from the record's events field), with display fields resolved from the referenced event records.",
      "items": {
        "ref": "#projectEventView",
        "type": "ref"
      },
      "maxLength": 200,
      "type": "array"
    },
    "name": {
      "description": "Project name.",
      "type": "string"
    },
    "primary": {
      "description": "Whether this is the user's primary ongoing project.",
      "type": "boolean"
    },
    "rkey": {
      "description": "Record key of the project record.",
      "type": "string"
    },
    "role": {
      "description": "The user's own role on the project.",
      "type": "string"
    },
    "startDate": {
      "description": "Start date. Partial date.",
      "type": "string"
    },
    "url": {
      "description": "Project URL.",
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "rkey",
    "name"
  ],
  "type": "object"
}
publicationView object

A publication, merged from Sifa and linked ORCID works.

Properties

contributors array of ref#contributorView Optional

Linked contributors (co-authors).

date string Optional

Publication date. Partial date.

description string Optional

Description or abstract.

doi string Optional

Digital Object Identifier.

image string uri Optional

Cover or preview image URL.

orcidCorroborated boolean Optional

Whether an ORCID work corroborates a Sifa record.

primary boolean Optional

Whether this is the user's primary publication.

publicationName string Optional

Name of the source publication venue, when present.

publicationUri string at-uri Optional

AT-URI of the source publication record, when present.

publicationUrl string uri Optional

Canonical publication URL, when present.

publisher string Optional

Publisher or journal.

relatedIdentifiers array of refid.sifa.defs#relatedIdentifier Optional

Other versions or forms of this work: the relations declared on the record plus, for a DOI, those registered with DataCite or Crossref. Clients can fold a preprint under its published version.

rkey string Required

Record key, or a synthetic key for ORCID-only works.

subtitle string Optional

Subtitle.

title string Required

Publication title.

type string Optional

Publication type token.

typeLabel string Optional

Human-readable publication type.

url string uri Optional

Publication URL.

verified boolean Required

Whether the publication is verified (e.g. via ORCID).

verifiedVia string Optional

Verification source, when verified.

View raw schema
{
  "description": "A publication, merged from Sifa and linked ORCID works.",
  "properties": {
    "contributors": {
      "description": "Linked contributors (co-authors).",
      "items": {
        "ref": "#contributorView",
        "type": "ref"
      },
      "type": "array"
    },
    "date": {
      "description": "Publication date. Partial date.",
      "type": "string"
    },
    "description": {
      "description": "Description or abstract.",
      "type": "string"
    },
    "doi": {
      "description": "Digital Object Identifier.",
      "type": "string"
    },
    "image": {
      "description": "Cover or preview image URL.",
      "format": "uri",
      "type": "string"
    },
    "orcidCorroborated": {
      "description": "Whether an ORCID work corroborates a Sifa record.",
      "type": "boolean"
    },
    "primary": {
      "description": "Whether this is the user's primary publication.",
      "type": "boolean"
    },
    "publicationName": {
      "description": "Name of the source publication venue, when present.",
      "type": "string"
    },
    "publicationUri": {
      "description": "AT-URI of the source publication record, when present.",
      "format": "at-uri",
      "type": "string"
    },
    "publicationUrl": {
      "description": "Canonical publication URL, when present.",
      "format": "uri",
      "type": "string"
    },
    "publisher": {
      "description": "Publisher or journal.",
      "type": "string"
    },
    "relatedIdentifiers": {
      "description": "Other versions or forms of this work: the relations declared on the record plus, for a DOI, those registered with DataCite or Crossref. Clients can fold a preprint under its published version.",
      "items": {
        "ref": "id.sifa.defs#relatedIdentifier",
        "type": "ref"
      },
      "type": "array"
    },
    "rkey": {
      "description": "Record key, or a synthetic key for ORCID-only works.",
      "type": "string"
    },
    "subtitle": {
      "description": "Subtitle.",
      "type": "string"
    },
    "title": {
      "description": "Publication title.",
      "type": "string"
    },
    "type": {
      "description": "Publication type token.",
      "type": "string"
    },
    "typeLabel": {
      "description": "Human-readable publication type.",
      "type": "string"
    },
    "url": {
      "description": "Publication URL.",
      "format": "uri",
      "type": "string"
    },
    "verified": {
      "description": "Whether the publication is verified (e.g. via ORCID).",
      "type": "boolean"
    },
    "verifiedVia": {
      "description": "Verification source, when verified.",
      "type": "string"
    }
  },
  "required": [
    "rkey",
    "title",
    "verified"
  ],
  "type": "object"
}
skillView object

A skill entry.

Properties

name string Required

Skill name.

positionRkeys array of string Optional

Record keys of positions this skill is linked to.

rkey string Required

Record key of the skill record.

View raw schema
{
  "description": "A skill entry.",
  "properties": {
    "category": {
      "description": "Broad category.",
      "ref": "id.sifa.defs#skillCategory",
      "type": "ref"
    },
    "name": {
      "description": "Skill name.",
      "type": "string"
    },
    "positionRkeys": {
      "description": "Record keys of positions this skill is linked to.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "rkey": {
      "description": "Record key of the skill record.",
      "type": "string"
    }
  },
  "required": [
    "rkey",
    "name"
  ],
  "type": "object"
}
volunteeringView object

A legacy volunteering entry.

Properties

agentRef ref id.sifa.defs#agentRef Optional

Canonical organization reference (name plus optional did/entityRef). Mirrors the flat organization/entityRef fields during the migration; the two always agree.

cause string Optional

Cause supported.

currentCompanyName string Optional

Current canonical name of the linked entity, when it resolves. The web shows it as a "Now {name}" hint when it differs from the saved snapshot name (#516).

description string Optional

Description.

endDate string Optional

End date. Partial date.

entityRef string uri Optional

Pointer URI to the resolved organization entity.

organization string Required

Organization name.

rkey string Required

Record key of the volunteering record.

role string Optional

Role held.

startDate string Optional

Start date. Partial date.

View raw schema
{
  "description": "A legacy volunteering entry.",
  "properties": {
    "agentRef": {
      "description": "Canonical organization reference (name plus optional did/entityRef). Mirrors the flat organization/entityRef fields during the migration; the two always agree.",
      "ref": "id.sifa.defs#agentRef",
      "type": "ref"
    },
    "cause": {
      "description": "Cause supported.",
      "type": "string"
    },
    "currentCompanyName": {
      "description": "Current canonical name of the linked entity, when it resolves. The web shows it as a \"Now {name}\" hint when it differs from the saved snapshot name (#516).",
      "type": "string"
    },
    "description": {
      "description": "Description.",
      "type": "string"
    },
    "endDate": {
      "description": "End date. Partial date.",
      "type": "string"
    },
    "entityRef": {
      "description": "Pointer URI to the resolved organization entity.",
      "format": "uri",
      "type": "string"
    },
    "organization": {
      "description": "Organization name.",
      "type": "string"
    },
    "rkey": {
      "description": "Record key of the volunteering record.",
      "type": "string"
    },
    "role": {
      "description": "Role held.",
      "type": "string"
    },
    "startDate": {
      "description": "Start date. Partial date.",
      "type": "string"
    }
  },
  "required": [
    "rkey",
    "organization"
  ],
  "type": "object"
}

Lexicon Garden

@