Pular para o conteúdo principal
GET
/
client
Get all clients of a company
curl --request GET \
  --url https://api.cliquepay.app/client
[
  {
    "id": "0502ef53-ddc3-429b-b480-01cb1bbd81e0",
    "cpfCnpj": "05305405364",
    "name": "Cliente Bola",
    "email": "bola@email.com",
    "phone": "41999999999",
    "status": "ACTIVE",
    "companyId": "f96a489c-8a4d-4c7b-a1f6-347acbd832df",
    "createdAt": "2025-02-03T10:00:00Z",
    "updatedAt": "2025-02-03T10:00:00Z"
  }
]

Response

200 - application/json

All clients of a company in App

​
id
string
required

Client id

Example:

"0502ef53-ddc3-429b-b480-01cb1bbd81e0"

​
cpfCnpj
string
required

Client id

Example:

"05305405364"

​
name
string
required

Client Name

Example:

"Cliente Bola"

​
email
string
required

Client Email

Example:

"bola@email.com"

​
phone
string
required

Client Phone

Example:

"41999999999"

​
status
string
required

Client Status

Example:

"ACTIVE"

​
companyId
string
required

Company id

Example:

"f96a489c-8a4d-4c7b-a1f6-347acbd832df"

​
createdAt
string<date-time>
required

Client created at date

Example:

"2025-02-03T10:00:00Z"

​
updatedAt
string<date-time>
required

Client updated at date

Example:

"2025-02-03T10:00:00Z"

⌘I