Get basic information over the instance

GET 
https://$CUSTOM-DOMAIN/v2/settings

Return the basic information of the instance for the requested context

Responses

200

OK

application/json

Schema

Schema

defaultOrgId string

default organization for the current context

defaultLanguage string

default language for the current context

supportedLanguages string[]

Example (from schema)

{
  "defaultOrgId": "string",
  "defaultLanguage": "en",
  "supportedLanguages": [
    "en",
    "de",
    "it"
  ]
}

application/grpc

Schema

Schema

defaultOrgId string

default organization for the current context

defaultLanguage string

default language for the current context

supportedLanguages string[]

Example (from schema)

{
  "defaultOrgId": "string",
  "defaultLanguage": "en",
  "supportedLanguages": [
    "en",
    "de",
    "it"
  ]
}

application/grpc-web+proto

Schema

Schema

defaultOrgId string

default organization for the current context

defaultLanguage string

default language for the current context

supportedLanguages string[]

Example (from schema)

{
  "defaultOrgId": "string",
  "defaultLanguage": "en",
  "supportedLanguages": [
    "en",
    "de",
    "it"
  ]
}

403

Returned when the user does not have permission to access the resource.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

404

Returned when the resource does not exist.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://$CUSTOM-DOMAIN/v2/settings' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

https://$CUSTOM-DOMAIN

Auth

Bearer Token

ResponseClear

Click the Send API Request button above and see the response here!