Skip to main content
GET
/
client
Get all clients of a company
curl --request GET \
  --url https://api.clickpay.app.br/client
[
  {
    "id": "clnt_clx1234567890abcdef",
    "taxId": "053.054.053-64",
    "name": "Cliente Bola",
    "email": "[email protected]",
    "phone": "41999999999",
    "status": "ACTIVE",
    "companyId": "comp_clx9876543210fedcba",
    "createdAt": "2025-02-03T10:00:00Z",
    "updatedAt": "2025-02-03T10:00:00Z",
    "postalCode": "80215100",
    "address": "Rua Engenheiros Rebouças",
    "district": "Rebouças",
    "number": "2000",
    "line1": "Green apartment"
  }
]

Headers

​
X-API-KEY
string

API Key for authentication (alternative to Bearer token)

Response

List of clients retrieved successfully

​
id
string
required

Client unique identifier (format: clnt_{cuid2})

Example:

"clnt_clx1234567890abcdef"

​
taxId
string
required

Client tax ID (CPF/CNPJ) - formatted

Example:

"053.054.053-64"

​
name
string
required

Client full name

Maximum string length: 255
Example:

"Cliente Bola"

​
email
string<email>
required

Client email address

Example:

"[email protected]"

​
phone
string
required

Client phone number (Brazilian format)

Example:

"41999999999"

​
status
enum<string>
default:ACTIVE
required

Client status

Available options:
ACTIVE,
INACTIVE
Example:

"ACTIVE"

​
companyId
string
required

Company ID that owns this client (format: comp_{cuid2})

Example:

"comp_clx9876543210fedcba"

​
createdAt
string<date-time>
required

Client creation timestamp

Example:

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

​
updatedAt
string<date-time>
required

Client last update timestamp

Example:

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

​
postalCode
object

Client postal code (CEP)

Example:

"80215100"

​
address
object

Client street address

Example:

"Rua Engenheiros Rebouças"

​
district
object

District/neighborhood

Example:

"Rebouças"

​
number
object

Street number

Example:

"2000"

​
line1
object

Address complement (line 1)

Example:

"Green apartment"