Skip to main content
GET
/
api
/
v1
/
customers
Listar todos os clientes
curl --request GET \
  --url https://api.payments.bob.company/api/v1/customers/ \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "projectId": "<string>",
      "name": "<string>",
      "document": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "street": "<string>",
      "streetNumber": "<string>",
      "neighborhood": "<string>",
      "complement": "<string>",
      "zipCode": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "<string>",
      "isBlocked": true,
      "blockedAt": "<string>",
      "blockedReason": "<string>",
      "blockExpiresAt": "<string>",
      "blockType": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "meta": {
    "total": 0,
    "page": 0,
    "limit": 0,
    "totalPages": 0
  }
}

Authorizations

Authorization
string
header
required

Autenticação por API Key usando token SK (sk_live_xxx ou sk_test_xxx). Envie como: Authorization: Bearer sk_live_xxx

Query Parameters

page
integer
default:1
Required range: x <= 9007199254740991
limit
integer
default:10
Required range: x <= 100
Required string length: 1 - 200
document
string
Required string length: 1 - 20
phone
string
Required string length: 1 - 20
email
string<email>
Maximum string length: 200
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Response

Default Response

success
boolean
required
data
object[]
required
meta
object
required