Avisi cloud logo
Organisations

Get an organisation.

GET
/api/v1/organisations/{organisationSlug}

Path Parameters

organisationSlugstring
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.

id?stringDeprecated
Format"uuid"
identity?string
Format"uuid"
name?string
vatCode?string
companyName?string
companyAddress?string
contactEmail?string
billingEmail?string
vatCodeValidated?boolean
vatCodeValidatedAt?string
Format"date-time"
phoneNumber?string
createdAt?string
Format"date-time"
acceptedTerms?boolean
acceptedTermsAt?string
Format"date-time"
hasStripeCustomer?boolean
restrictedToAvailableCloudProviders?boolean
type?string
Value in"BUSINESS" | "ENTERPRISE" | "INDIVIDUAL" | "TRIAL"
slug?object

Invalid request parameters. Please review the documentation for valid parameter values.

TypeScript Definitions

Use the response body type in TypeScript.

response?unknown

You do not have the necessary permissions to access this resource.

TypeScript Definitions

Use the response body type in TypeScript.

response?unknown

The requested resource could not be found. Please check the resource URL or identifier.

TypeScript Definitions

Use the response body type in TypeScript.

response?unknown

An internal error occurred on the server.

TypeScript Definitions

Use the response body type in TypeScript.

response?unknown
curl -X GET "https://api.avisi.cloud/api/v1/organisations/string"
fetch("https://api.avisi.cloud/api/v1/organisations/string")
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "https://api.avisi.cloud/api/v1/organisations/string"

  req, _ := http.NewRequest("GET", url, nil)
  
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}
import requests

url = "https://api.avisi.cloud/api/v1/organisations/string"

response = requests.request("GET", url)

print(response.text)
{
  "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"
  }
}
{
  "message": "string",
  "details": [
    "string"
  ]
}
{
  "message": "string",
  "details": [
    "string"
  ]
}
{
  "message": "string",
  "details": [
    "string"
  ]
}
{
  "message": "string",
  "details": [
    "string"
  ]
}