Back to API docs

apigetcontacts JSON request body list or single

POST /api/getcontacts returns contacts with merged contact meta.

Fields

key

string, required

Your API key.

id

integer, optional

Fetch one contact by id. When provided, pagination is not used.

code, email, manager, lead

optional filters

Filter the contact list by these fields.

search

string, optional

Searches name, code, phone, email, address, and person.

page, step

integers, optional

step defaults to 20 and is capped at 100.

orderby, order

optional

Allowed order fields: id, name, code, phone, email, created_at, updated_at. Order is ASC or DESC.

Examples

{
  "key": "YOUR_API_KEY",
  "search": "example",
  "page": 1,
  "step": 20,
  "orderby": "created_at",
  "order": "DESC"
}

{
  "key": "YOUR_API_KEY",
  "id": 123
}

Response shape

{
  "status": "ok",
  "data": [
    {
      "id": 123,
      "name": "Example UAB",
      "code": "123456789",
      "contact_meta": [
        { "field": "vat", "value": "LT123456789" }
      ],
      "meta": {
        "vat": "LT123456789"
      },
      "vat": "LT123456789"
    }
  ],
  "page": 1,
  "pages": 1,
  "count": 1
}

Use /api/createcontact to create contacts and /api/editcontact to edit by id. Both support the same core fields and contact meta behavior.