Sign up Log in

CRM API

Managing CRM entries and customer relationships — retrieval, creation, modification, closing and download

Endpoints

Authentication

Every API request requires sending the X-API-KEY header.

X-API-KEY: {your_api_key}

Still have questions?

Open a ticket with us, or browse our help center.

If you liked it, share it with others

Base URL

https://{tenant}.logzi.com/api/crm/

Every request returns a JSON response. On success result.code == 1, on error result.code == 0.

GET /api/crm/get

Retrieves a single CRM entry by ID, with full details.

Query parameters

Parameter Type Required Description
id int Unique identifier of the CRM entry

Example request

GET /api/crm/get?id=15
X-API-KEY: {your_api_key}

Example response

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 15,
    "identify": "CRM-2024-0015",
    "date_create": "2024-05-01 10:00:00",
    "date_perform": "2024-05-10",
    "status_id": 1,
    "subject": "Ügyféltárgyalás",
    "partner_company_name": "Minta Kft.",
    "company_user_name": "Kovács János",
    "crm_source_name": "Telefon",
    "comment_top": "Előzetes egyeztetés.",
    "comment_bottom": "Belső megjegyzés."
  }
}
GET /api/crm/list

Retrieves a paginated list of CRM entries, with filtering options.

Query parameters

Parameter Type Required Description
list_offset int Pagination offset (default: 0)
list_condition[identify] string Filter by identifier (LIKE)
list_condition[company_name] string Filter by partner name (LIKE)
list_condition[status_id] int Filter by status (1=open, 2=closed)
list_condition[crm_source_id] int Filter by source ID
list_condition[company_user_id] int Filter by responsible staff member ID
list_condition[date_create_from] date Creation date — from (YYYY-MM-DD)
list_condition[date_create_to] date Creation date — to (YYYY-MM-DD)

Example request

GET /api/crm/list?list_offset=0&list_condition[status_id]=1
X-API-KEY: {your_api_key}

Example response

{
  "result": { "code": 1, "message": "success" },
  "data": [
    {
      "id": 15,
      "identify": "CRM-2024-0015",
      "date_create": "2024-05-01",
      "status_name": "Nyitott",
      "subject": "Ügyféltárgyalás",
      "partner_company_name": "Minta Kft."
    }
  ],
  "params": {
    "list_count": 10,
    "list_offset": 0,
    "list_all": 42
  }
}
POST /api/crm/save

Creates or updates a CRM entry. For a new entry use data[id] = 0, for an update provide the existing ID.

POST fields — data object

Field Type Required Description
id int 0 = new CRM entry, >0 = update
company_id int Company identifier
company_user_id int ID of the responsible staff member
partner_id int Partner/customer identifier
crm_source_id int Source identifier
subject string Subject
date_perform datetime Performance date (YYYY-MM-DD HH:MM:SS)
comment_top string Comment visible to the customer
comment_bottom string Internal comment
status_id int Status identifier

POST fields — params object (optional)

Field Type Required Description
close int 1 = automatically close after saving
download int 1 = generate PDF after saving

Example request

POST /api/crm/save
X-API-KEY: {your_api_key}
Content-Type: application/json

{
  "data": {
    "id": 0,
    "company_id": 1,
    "company_user_id": 3,
    "partner_id": 12,
    "crm_source_id": 2,
    "subject": "Termékbemutató egyeztetés",
    "date_perform": "2024-06-20 14:00:00",
    "comment_top": "Ügyfél érdeklődik az új termékcsalád iránt.",
    "status_id": 1
  },
  "params": {
    "close": 0,
    "download": 0
  }
}

Example response

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "id": 16,
    "identify": "CRM-2024-0016"
  }
}
POST /api/crm/delete

Deletes a CRM entry. Only an entry with open status can be deleted.

POST fields — data object

Field Type Required Description
receipt_id int Identifier of the CRM entry to delete

Example request

POST /api/crm/delete
X-API-KEY: {your_api_key}
Content-Type: application/json

{
  "data": {
    "receipt_id": 15
  }
}

Example response

{
  "result": { "code": 1, "message": "success" },
  "data": {}
}
POST /api/crm/close

Closes an open CRM entry. Only an entry with status_id = 1 (open) can be closed.

POST fields — data object

Field Type Required Description
receipt_id int Identifier of the CRM entry to close

Example request

POST /api/crm/close
X-API-KEY: {your_api_key}
Content-Type: application/json

{
  "data": {
    "receipt_id": 15
  }
}

Example response

{
  "result": { "code": 1, "message": "success" },
  "data": {}
}
GET /api/crm/download

Downloads/generates the CRM entry document in various formats (PDF, base64 string, stream).

Query parameters

Parameter Type Required Description
receipt_id int Identifier of the CRM entry
file_type string Output format: pdf, pdf-string, stream
language string Name of the template language folder (e.g. hungarian)
template_id int Custom print template ID

Example request

GET /api/crm/download?receipt_id=15&file_type=pdf
X-API-KEY: {your_api_key}

Example response (file_type=pdf)

{
  "result": { "code": 1, "message": "success" },
  "data": {
    "name": "CRM-2024-0015.pdf",
    "content": "JVBERi0xLjQK...",
    "receipt": { ... }
  }
}

Get in touch with us

Interested in our software? Feel free to write to us!

Send an inquiry

Need help?

If you can't find the answer and need assistance

Browse the help center

Create your account now,
pay later!

Try it free for 3 days, no risk, no obligation!
Create an account
Register