Getting started-Add your organization

1. Add organization

Getting started-Add your API specification

2. Add API specification version 3. Add declaration of conformity 1. Add API specification 4. Set API specification mainVersionId

Getting started-Invite user to your organization

1. Add invitation

Getting started-Accept invitation to join an organization

2. Accept pending invitation 1. Get pending invitations

v1beta2-users-me-invitations-{invitationId}

Decline a pending user invitation Get a user invitation by ID

v1beta2-users-me-invitations

List all user invitations

v1beta2-users-me-memberships-{membershipId}

Get a user membership by ID Delete a user membership

v1beta2-users-me-memberships

List all user memberships

v1beta2-users-me

Get user information for authenticated user

v1beta2-organizations-{organizationId}-invitations-{invitationId}

Cancel a pending organization invitation Get an organization invitation by ID

v1beta2-organizations-{organizationId}-invitations

List all organization invitations Add an organization invitation

v1beta2-organizations-{organizationId}-memberships-{membershipId}

Get an organization membership by ID Delete an organization membership

v1beta2-organizations-{organizationId}-memberships

List all organization memberships

v1beta2-organizations-{organizationId}

Get an organization by ID Update an organization

v1beta2-organizations

List all organizations Add an organization

v1beta2-api-requirements-versions-{versionName}-api-requirements

List all API requirements version API requirements

v1beta2-api-requirements-versions-{versionName}

Get an API requirements version by name Update an API requirements version

v1beta2-api-requirements-versions

Add an API requirements version List all API requirements versions

v1beta2-api-specifications-{apiSpecificationId}

Get an API specification by ID Update an API specification

v1beta2-api-specifications

Add an API specification List all API specifications

v1beta2-api-specification-versions-{apiSpecificationVersionId}-urls-{urlId}

Update an API specification version URL Delete an API specification version URL Get an API specification version URL by ID

v1beta2-api-specification-versions-{apiSpecificationVersionId}-urls

Add an API specification version URL List all API specification version URLs

v1beta2-api-specification-versions-{apiSpecificationVersionId}-declarations-of-conformity-{declarationOfConformityId}

Get an API specification version declaration of conformity by ID

v1beta2-api-specification-versions-{apiSpecificationVersionId}-declarations-of-conformity

Add an API specification version declaration of conformity List all API specification version declarations of conformity

v1beta2-api-specification-versions-{apiSpecificationVersionId}-communication-standard-versions-{communicationStandardVersionId}

Delete a communication standard version from an API specification version Set a communication standard version for an API specification version

v1beta2-api-specification-versions-{apiSpecificationVersionId}-information-standard-versions-{informationStandardVersionId}

Delete an information standard version from an API specification version Set an information standard version for an API specification version

v1beta2-api-specification-versions-{apiSpecificationVersionId}-trust-framework-versions-{trustFrameworkVersionId}

Set a trust framework version for an API specification version Delete a trust framework version from an API specification version

v1beta2-api-specification-versions-{apiSpecificationVersionId}

Update an API specification version Get an API specification version by ID

v1beta2-api-specification-versions

List all API specification versions Add an API specification version

v1beta2-communication-standards-{communicationStandardId}

Update a communication standard Get a communication standard by ID

v1beta2-communication-standards

Add a communication standard List all communication standards

v1beta2-communication-standard-versions-{communicationStandardVersionId}

Update a communication standard version Get a communication standard version by ID

v1beta2-communication-standard-versions

List all communication standard versions Add a communication standard version

v1beta2-information-standards-{informationStandardId}

Update an information standard Get an information standard by ID

v1beta2-information-standards

Add an information standard List all information standards

v1beta2-information-standard-versions-{informationStandardVersionId}-communication-standard-versions-{communicationStandardVersionId}

Set a communication standard version for an information standard version Delete a communication standard version from an information standard version

v1beta2-information-standard-versions-{informationStandardVersionId}-trust-framework-versions-{trustFrameworkVersionId}

Delete a trust framework version from an information standard version Set a trust framework version for an information standard version

v1beta2-information-standard-versions-{informationStandardVersionId}

Update an information standard version Get an information standard version by ID

v1beta2-information-standard-versions

Add an information standard version List all information standard versions

v1beta2-trust-frameworks-{trustFrameworkId}

Get a trust framework by ID Update a trust framework

v1beta2-trust-frameworks

List all trust frameworks Add a trust framework

v1beta2-trust-framework-versions-{trustFrameworkVersionId}

Get a trust framework version by ID Update a trust framework version

v1beta2-trust-framework-versions

List all trust framework versions Add a trust framework version

Getting started-Add your organization

1. Add organization

Getting started-Add your API specification

2. Add API specification version 3. Add declaration of conformity 1. Add API specification 4. Set API specification mainVersionId

Getting started-Invite user to your organization

1. Add invitation

Getting started-Accept invitation to join an organization

2. Accept pending invitation 1. Get pending invitations

v1beta2-users-me-invitations-{invitationId}

Decline a pending user invitation Get a user invitation by ID

v1beta2-users-me-invitations

List all user invitations

v1beta2-users-me-memberships-{membershipId}

Get a user membership by ID Delete a user membership

v1beta2-users-me-memberships

List all user memberships

v1beta2-users-me

Get user information for authenticated user

v1beta2-organizations-{organizationId}-invitations-{invitationId}

Cancel a pending organization invitation Get an organization invitation by ID

v1beta2-organizations-{organizationId}-invitations

List all organization invitations Add an organization invitation

v1beta2-organizations-{organizationId}-memberships-{membershipId}

Get an organization membership by ID Delete an organization membership

v1beta2-organizations-{organizationId}-memberships

List all organization memberships

v1beta2-organizations-{organizationId}

Get an organization by ID Update an organization

v1beta2-organizations

List all organizations Add an organization

v1beta2-api-requirements-versions-{versionName}-api-requirements

List all API requirements version API requirements

v1beta2-api-requirements-versions-{versionName}

Get an API requirements version by name Update an API requirements version

v1beta2-api-requirements-versions

Add an API requirements version List all API requirements versions

v1beta2-api-specifications-{apiSpecificationId}

Get an API specification by ID Update an API specification

v1beta2-api-specifications

Add an API specification List all API specifications

v1beta2-api-specification-versions-{apiSpecificationVersionId}-urls-{urlId}

Update an API specification version URL Delete an API specification version URL Get an API specification version URL by ID

v1beta2-api-specification-versions-{apiSpecificationVersionId}-urls

Add an API specification version URL List all API specification version URLs

v1beta2-api-specification-versions-{apiSpecificationVersionId}-declarations-of-conformity-{declarationOfConformityId}

Get an API specification version declaration of conformity by ID

v1beta2-api-specification-versions-{apiSpecificationVersionId}-declarations-of-conformity

Add an API specification version declaration of conformity List all API specification version declarations of conformity

v1beta2-api-specification-versions-{apiSpecificationVersionId}-communication-standard-versions-{communicationStandardVersionId}

Delete a communication standard version from an API specification version Set a communication standard version for an API specification version

v1beta2-api-specification-versions-{apiSpecificationVersionId}-information-standard-versions-{informationStandardVersionId}

Delete an information standard version from an API specification version Set an information standard version for an API specification version

v1beta2-api-specification-versions-{apiSpecificationVersionId}-trust-framework-versions-{trustFrameworkVersionId}

Set a trust framework version for an API specification version Delete a trust framework version from an API specification version

v1beta2-api-specification-versions-{apiSpecificationVersionId}

Update an API specification version Get an API specification version by ID

v1beta2-api-specification-versions

List all API specification versions Add an API specification version

v1beta2-communication-standards-{communicationStandardId}

Update a communication standard Get a communication standard by ID

v1beta2-communication-standards

Add a communication standard List all communication standards

v1beta2-communication-standard-versions-{communicationStandardVersionId}

Update a communication standard version Get a communication standard version by ID

v1beta2-communication-standard-versions

List all communication standard versions Add a communication standard version

v1beta2-information-standards-{informationStandardId}

Update an information standard Get an information standard by ID

v1beta2-information-standards

Add an information standard List all information standards

v1beta2-information-standard-versions-{informationStandardVersionId}-communication-standard-versions-{communicationStandardVersionId}

Set a communication standard version for an information standard version Delete a communication standard version from an information standard version

v1beta2-information-standard-versions-{informationStandardVersionId}-trust-framework-versions-{trustFrameworkVersionId}

Delete a trust framework version from an information standard version Set a trust framework version for an information standard version

v1beta2-information-standard-versions-{informationStandardVersionId}

Update an information standard version Get an information standard version by ID

v1beta2-information-standard-versions

Add an information standard version List all information standard versions

v1beta2-trust-frameworks-{trustFrameworkId}

Get a trust framework by ID Update a trust framework

v1beta2-trust-frameworks

List all trust frameworks Add a trust framework

v1beta2-trust-framework-versions-{trustFrameworkVersionId}

Get a trust framework version by ID Update a trust framework version

v1beta2-trust-framework-versions

List all trust framework versions Add a trust framework version

Home ZorgAPIs API v1beta2-api-specifications-{apiSpecificationId}Get an API specification by ID

Get an API specification by ID

GET {{baseApiUrl}}/v1beta2/api-specifications/:apiSpecificationId

v1beta2-api-specifications-{apiSpecificationId}

Update an API specification