List relations
Customers and suppliers (relations) with code, name, city and email, filtered by name, email, code, city or type.
GET https://cotlet.dev/api/v1/e-boekhouden/relations
read
Returns relations from the administration you are signed in to. Filter by name, email, relation code, city or type (B for business, P for private) to find one before you invoice it. Use limit and offset for the next page. The relation_id from each item goes into the other tools.
Parameters
| Name | Type | Description |
|---|---|---|
| name string | string | Company or person name. Wildcards ? and % are allowed. |
| email string | string | Exact email address. |
| code string | string | Relation code. |
| city string | string | Primary city. |
| type enum | enum | B (business) or P (private). |
| limit integer | integer | Number of items to return. |
| offset integer | integer | Number of items to skip, for the next page. |
Request
curl https://cotlet.dev/api/v1/e-boekhouden/relations \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("e-boekhouden", "list_relations")const result = await cotlet.call('e-boekhouden', 'list_relations');cotlet call e-boekhouden list_relationsExample response
{
"relations": [
{
"relation_id": 1042,
"code": "STN001",
"type": "B",
"name": "Studio Noord BV",
"city": "Utrecht",
"email": "admin@studionoord.example",
"term_of_payment": 14,
"inactive": false
}
],
"total": 1
}