curl --request GET \
--url https://platform.versori.com/api/connect/v1/o/{organisation_id}/protocols \
--header 'Authorization: Bearer <token>'{
"totalCount": 123,
"protocols": [
{
"id": "<string>",
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"iconURL": "<string>"
}
],
"next": "<string>",
"prev": "<string>"
}List Protocols
ListProtocols returns all the supported Protocols for this organisation.
If a desired Protocol is not listed then please contact [email protected] to request it be added.
curl --request GET \
--url https://platform.versori.com/api/connect/v1/o/{organisation_id}/protocols \
--header 'Authorization: Bearer <token>'{
"totalCount": 123,
"protocols": [
{
"id": "<string>",
"slug": "<string>",
"name": "<string>",
"description": "<string>",
"iconURL": "<string>"
}
],
"next": "<string>",
"prev": "<string>"
}Authorizations
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
Response
OK
ProtocolPage is a page of Protocols.
Show child attributes
Show child attributes
ID is the unique identifier of the Protocol, this is typically only used internally and the protocol slug
is used externally.
Slug is human-readable unique identifier of the Protocol in kebab-case format.
Name is a human-friendly name to display for the user.
Description describes the protocol in human-friendly terminology. This text may be displayed to users via a help tooltip or similar.
IconURL provides a URL to access an icon/image which represents the protocol.