Skip to main content
GET
/
v1
/
counterparties
Get Counterparties
curl --request GET \
  --url https://api.bookeeping.ai/public-api/v1/counterparties \
  --header 'Authorization: Bearer <token>'
{
  "message": "<string>",
  "metaData": {
    "warnings": [
      "<string>"
    ]
  },
  "data": {
    "counterparts": [
      {
        "_id": "<string>",
        "projectId": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "accountName": "<string>",
        "accountNumber": "<string>",
        "email": "jsmith@example.com",
        "phone": "<string>",
        "otherEmails": [
          "jsmith@example.com"
        ],
        "type": "customer",
        "taxId": "<string>",
        "address": {}
      }
    ],
    "count": 123
  }
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Get your key from the Dashboard > Settings > API Access.

Query Parameters

​
page
string

The page number 1 - n

​
limit
string

The number of items per page. Max is 250. Default is 10.

​
sortKey
enum<string>

The key to sort the items by. Default is _id.

Available options:
_id,
name,
createdAt,
updatedAt,
transactionDate
​
sortOrder
enum<string>

The order to sort the items by. Default is 1. -1 for descending. 1 for ascending.

Available options:
1,
-1
​
query
string

The query to search the counterparties by account name

Response

Get Counterparties executed successfully

​
message
string

Success message

​
metaData
object
​
data
object