Customers

List All Customers

get

https://api.brouwervos.nlhttps://staging.api.brouwervos.nl

/v1/companies/{companyId}/customers

Retrieve a list of all customers associated with a specific company.

Authorizations

bearerAuth

Path parameters

companyIdstringRequired

Unique identifier of the company.

Responses

200

An array of customers.

application/json

404

Company not found.

get

/v1/companies/{companyId}/customers

HTTPcURLJavaScriptPython

GET /v1/companies/{companyId}/customers HTTP/1.1
Host: api.brouwervos.nl
Accept: */*

[
  {
    "id": "text",
    "first_name": "text",
    "last_name": "text",
    "email": "text",
    "phone": "text",
    "company": "text",
    "address": {
      "premise": "text",
      "building": "text",
      "sub_premise": "text",
      "address2": "text",
      "postal_code": "text",
      "thoroughfare": "text",
      "locality": "text",
      "state": "text",
      "country": "text"
    },
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
]

Create a New Customer

post

https://api.brouwervos.nlhttps://staging.api.brouwervos.nl

/v1/companies/{companyId}/customers

Add a new customer to a specific company.

Authorizations

bearerAuth

Path parameters

companyIdstringRequired

Unique identifier of the company.

Body

application/json

first_namestringOptional

First name of the customer.

last_namestringOptional

Last name of the customer.

emailstring · emailOptional

Email address of the customer.

phonestringOptional

Phone number of the customer.

companystringOptional

Company name associated with the customer, if applicable.

Responses

201

Customer created successfully.

application/json

400

Invalid request data.

404

Company not found.

post

/v1/companies/{companyId}/customers

HTTPcURLJavaScriptPython

POST /v1/companies/{companyId}/customers HTTP/1.1
Host: api.brouwervos.nl
Content-Type: application/json
Accept: */*
Content-Length: 322

{
  "first_name": "text",
  "last_name": "text",
  "email": "[email protected]",
  "phone": "text",
  "company": "text",
  "address": {
    "premise": "text",
    "building": "text",
    "sub_premise": "text",
    "address2": "text",
    "postal_code": "text",
    "thoroughfare": "text",
    "locality": "text",
    "state": "text",
    "country": "text"
  },
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "id": "text",
  "first_name": "text",
  "last_name": "text",
  "email": "text",
  "phone": "text",
  "company": "text",
  "address": {
    "premise": "text",
    "building": "text",
    "sub_premise": "text",
    "address2": "text",
    "postal_code": "text",
    "thoroughfare": "text",
    "locality": "text",
    "state": "text",
    "country": "text"
  },
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Retrieve Specific Customer

get

https://api.brouwervos.nlhttps://staging.api.brouwervos.nl

/v1/companies/{companyId}/customers/{customerId}

Get details of a specific customer associated with a particular company.

Authorizations

bearerAuth

Path parameters

companyIdstringRequired

Unique identifier of the company.

customerIdstringRequired

Unique identifier of the customer.

Responses

200

Customer details.

application/json

404

Customer or company not found.

get

/v1/companies/{companyId}/customers/{customerId}

HTTPcURLJavaScriptPython

GET /v1/companies/{companyId}/customers/{customerId} HTTP/1.1
Host: api.brouwervos.nl
Accept: */*

{
  "id": "text",
  "first_name": "text",
  "last_name": "text",
  "email": "text",
  "phone": "text",
  "company": "text",
  "address": {
    "premise": "text",
    "building": "text",
    "sub_premise": "text",
    "address2": "text",
    "postal_code": "text",
    "thoroughfare": "text",
    "locality": "text",
    "state": "text",
    "country": "text"
  },
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Delete a Customer

delete

https://api.brouwervos.nlhttps://staging.api.brouwervos.nl

/v1/companies/{companyId}/customers/{customerId}

Delete a specific customer from a company.

Authorizations

bearerAuth

Path parameters

companyIdstringRequired

Unique identifier of the company.

customerIdstringRequired

Unique identifier of the customer.

Responses

204

Customer deleted successfully.

404

Customer or company not found.

delete

/v1/companies/{companyId}/customers/{customerId}

HTTPcURLJavaScriptPython

DELETE /v1/companies/{companyId}/customers/{customerId} HTTP/1.1
Host: api.brouwervos.nl
Accept: */*

No content