organisation

Get the current organisation

Returns the information of the organisation associated with the API key used for the request.

Required API key permissions: Platform (select when creating API key in Account Settings)

get/organisation

Request

Base URL
https://cyber-risk.upguard.com/api/public
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/docs/organisation/get.ts
A function with typed inputs. Its response is checked against the schema.

Information about the current organisation

automatedScoreinteger

The automated score of the organisation. Omitted if no current scanning score.

idinteger

The id of the organisation

namestring

The name of the organisation

primary_hostnamestring

The primary hostname of the organisation

{
  "id": 12345678,
  "name": "UpGuard",
  "primary_hostname": "upguard.com"
}

No recorded changes to this operation across all 1 revision of this API.