Get an organisation.

Path Parameters

organisationSlugRequiredstring

Pattern: "^[a-z0-9-]+$"

Response Body

Request was successfully processed. The response body contains the requested data.

TypeScript Definitions

Use the response body type in TypeScript.

idDeprecatedstring

Format: "uuid"

identitystring

Format: "uuid"

namestring

vatCodestring

companyNamestring

companyAddressstring

contactEmailstring

billingEmailstring

vatCodeValidatedboolean

vatCodeValidatedAtstring

Format: "date-time"

phoneNumberstring

createdAtstring

Format: "date-time"

acceptedTermsboolean

acceptedTermsAtstring

Format: "date-time"

hasStripeCustomerboolean

restrictedToAvailableCloudProvidersboolean

typestring

Value in: "BUSINESS" | "ENTERPRISE" | "INDIVIDUAL" | "TRIAL"

slugobject

curl -X GET "https://api.avisi.cloud/api/v1/organisations/string"

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "identity": "10a80a7a-1a32-4a74-b592-aa2a4ef691c5",
  "name": "string",
  "vatCode": "string",
  "companyName": "string",
  "companyAddress": "string",
  "contactEmail": "string",
  "billingEmail": "string",
  "vatCodeValidated": true,
  "vatCodeValidatedAt": "2019-08-24T14:15:22Z",
  "phoneNumber": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "acceptedTerms": true,
  "acceptedTermsAt": "2019-08-24T14:15:22Z",
  "hasStripeCustomer": true,
  "restrictedToAvailableCloudProviders": true,
  "type": "BUSINESS",
  "slug": {
    "slugValue": "string"
  }
}