Skip to main content
GET
/
customer
Get the customer record for the current organization
curl --request GET \
  --url https://api.eu.bronto.io/customer \
  --header 'X-BRONTO-API-KEY: <api-key>'
{
  "customer_id": "cust_12345",
  "org_id": "org_67890",
  "customer_name": "Acme Inc.",
  "billing_emails": [
    "billing@acme.com",
    "finance@acme.com"
  ],
  "contract_type": "Enterprise",
  "ou_id": "ou_34567",
  "parent": "parent_98765",
  "metadata": {
    "created_at": 123,
    "created_by": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "modified_at": 123,
    "modified_by": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "deleted_at": 123,
    "deleted_by": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "last_heartbeat_at": 123
  },
  "organisations": [
    {
      "org_id": "org_67890",
      "region": "eu-west-1",
      "name": "Acme EU"
    }
  ]
}

Authorizations

​
X-BRONTO-API-KEY
string
header
required

Response

Customer details retrieved successfully

​
customer_id
string
required

Unique identifier for the customer

Example:

"cust_12345"

​
org_id
string
required

Identifier for the organization associated with the customer

Example:

"org_67890"

​
customer_name
string
required

Name of the customer or company

Example:

"Acme Inc."

​
billing_emails
string<email>[]
required

List of email addresses that receive billing information

Example:
["billing@acme.com", "finance@acme.com"]
​
contract_type
string

The type of contract associated with the customer

Example:

"Enterprise"

​
ou_id
string

Organizational Unit (OU) identifier associated with the customer

Example:

"ou_34567"

​
parent
string

Identifier for the parent organization, if applicable

Example:

"parent_98765"

​
metadata
object

Common metadata attached to all persisted resources.

​
organisations
object[]

List of associated organisations