Get customers

Get all customers of a workspace.

GET /company/customers

Try it

cURL

cURL

curl --request GET \
  --url https://api.teamcamp.app/v1.0/company/customers \
  --header 'apiKey: <api-key>'

200

{
  "customerId": "<string>",
  "address": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "companyName": "<string>",
  "phone": "<string>",
  "clients": [
    {
      "clientId": "<string>",
      "name": "<string>",
      "email": "<string>"
    }
  ]
}

Authorizations

apiKey · string · header · required

Response

200

application/json

API Response

customerId · string

The unique id of the customer.

address · string

The address of the customer.

firstName · string

The first name of the customer.

lastName · string

The last name of the customer.

email · string

The email of the customer.

companyName · string

The company name of the customer.

phone · string

The phone no. of the customer.

clients · object[]

Show child attributes

clients. clientId · string

The unique id of the client.

clients. name · string

The name of the client.

clients. email · string

The email of the client.