Jump to Content
Guides
API Reference
Changelog
Discussions
v2.0
v3.0
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v2.0
Guides
API Reference
Changelog
Discussions
Find all groups
Search
JUMP TO
Clara API - Version 1
Users
Find all users
get
Find user by UUID
get
Locations
Find all locations
get
Find location by UUID
get
Groups
Find all groups
get
Find group by UUID
get
Cards
Find all cards
get
Find cards by UUID
get
Transactions
Find all transactions
get
Find transaction by UUID
get
Logs
📊 How to use it
Get logs for current month
get
Get logs by year and month (path params)
get
Get logs by year, month and day (path params)
get
BOLETO PAYMENTS
DDA (Authorized Direct Debit)
🏦 Getting Started with DDA (Authorized Direct Debit)
Clara API - VERSION 2
Users
Find all users
get
Create an User
post
Find user by UUID
get
Locations
Find all locations
get
Find location by UUID
get
Groups
Find all groups
get
Update group details
put
Create Group
post
Find group by UUID
get
Delete a single group by UUID
delete
Cards
💳 Cards API: How to Use It, and Its Restrictions
🛠️ Cards Configuration API: How to Use It
Find all cards
get
Create Card
post
Find cards by UUID
get
Delete Card
delete
Update Card Threshold
patch
Toggle Card Lock
patch
Transactions
Find all transactions
get
Find transaction by UUID
get
Billing-Statements
Find all transactions in the open billing statement.
get
Find all transactions in a billing statement given the year and month of it's due date.
get
Labels
Find all labels
get
Create multiple labels
post
Find label by UUID
get
Delete a single label by UUID
delete
Update label details
patch
Bulk delete labels
post
Payments
Find payments by parameters
get
Create Payment
post
Invoices
Find all Invoices with optional filters
get
Attachments
Get a list of attachments and it's respective transactions
get
Get a single attachment information with the pre signed URL
get
Get a single attachment in base 64
get
Clara API - VERSION 3
Cards
Find cards by uuid
get
Find all cards
get
Delete Card
delete
Delete Cards
post
Update Cards Threshold
patch
Toggle Cards Lock
patch
Create Cards
post
Single Create Card
post
Transactions
Find all transactions with filters
get
Get a Transaction by UUID
get
Get a billing statement by Contract
get
Get a billing statement by Contract
get
Find all billing statements with filters
get
Find extracted documents for a Transaction by uuid
get
Reimbursements
How to Use It
Find all reimbursements
get
Users
Find all users
get
Create user
post
Find user by Uuid
get
Delete User
delete
Update User
patch
Powered by
Find all groups
get
https://public-api.mx.clara.com/api/v2/groups
Find all groups
Language
Shell
Node
Ruby
PHP
Python
Credentials
OAuth2
OAuth2
Bearer
URL
Base URL
https://public-api.mx.clara.com
/api/v2/groups
RESPONSE
Click
Try It!
to start a request and see the response here!