get-customer

dci get-customer

Returns the general settings of the customer scoped to the authenticated tenant (from the bearer token). Requires the Settings permission and DoiT API access (platform:externalApi).

Responses

200 (application/json)

OK - Customer general settings returned.

{
  "type": "object",
  "description": "Customer general settings, scoped to the authenticated tenant.",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Customer ID.",
      "x-doit-confidentiality": "customer-data"
    },
    "name": {
      "type": "string",
      "description": "Customer name.",
      "x-doit-confidentiality": "customer-data"
    },
    "primaryDomain": {
      "type": "string",
      "description": "Customer's primary domain.",
      "x-doit-pii": true,
      "x-doit-confidentiality": "customer-data"
    },
    "domains": {
      "type": "array",
      "description": "Domains associated with the customer.",
      "items": {
        "type": "string"
      },
      "x-doit-pii": true,
      "x-doit-confidentiality": "customer-data"
    },
    "urlSlug": {
      "type": "string",
      "description": "The customer's active URL display name, used in Console URLs.",
      "x-doit-confidentiality": "customer-data"
    },
    "settings": {
      "type": "object",
      "properties": {
        "currency": {
          "type": "string",
          "description": "Billing currency code (e.g. `USD`, `EUR`).",
          "x-doit-confidentiality": "customer-data"
        },
        "allowedInviteDomains": {
          "type": "array",
          "description": "Email domains allowed to self-invite into the customer.",
          "items": {
            "type": "string"
          },
          "x-doit-pii": true,
          "x-doit-confidentiality": "customer-data"
        }
      }
    },
    "contact": {
      "type": "object",
      "properties": {
        "emails": {
          "type": "array",
          "description": "Point-of-contact email addresses for the customer.",
          "items": {
            "type": "string",
            "format": "email"
          },
          "x-doit-pii": true,
          "x-doit-confidentiality": "customer-data"
        }
      }
    }
  }
}

400 (application/json)

Bad Request - The server cannot process the request, often due to a malformed request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

401 (application/json)

Unauthorized - Invalid API key.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

403 (application/json)

Forbidden - The client is not authorized to perform the request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

404 (application/json)

Not Found - The requested resource does not exist.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

500 (application/json)

Internal Server Error - Something went wrong with the DoiT API server.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

Aliases: getcustomer