GET
/
o
/
{organisation_id}
/
protocols

Authorizations

Authorization
string
headerrequired

Bearer token authentication used by the Versori Platform. External consumers must provide an API key, however internal consumers must provide a JWT id_token issued by our IdP.

Path Parameters

organisation_id
string
required

Query Parameters

first
integer
default: 20
after
string
before
string

Response

200 - application/json

ProtocolPage is a page of Protocols.

totalCount
integer
required
next
string
prev
string
protocols
object[]
required
protocols.id
string
required

ID is the unique identifier of the Protocol, this is typically only used internally and the protocol slug is used externally.

protocols.slug
string
required

Slug is human-readable unique identifier of the Protocol in kebab-case format.

protocols.name
string
required

Name is a human-friendly name to display for the user.

protocols.description
string
required

Description describes the protocol in human-friendly terminology. This text may be displayed to users via a help tooltip or similar.

protocols.iconURL
string
required

IconURL provides a URL to access an icon/image which represents the protocol.