Base URL
https://{tenant}.logzi.com/api/partner_user/
Every request returns a JSON response. On success result.code == 1, on failure result.code == 0. A partner contact is a person assigned to a partner — a phone number, email address, and salutation can also be provided.
/api/partner_user/get
Retrieve a single partner contact by identifier, email address, or partner identifier.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int | Unique identifier of the contact | |
email | string | Search by email address | |
partner_id | int | Partner identifier — the first contact found is returned |
Example Request
GET /api/partner_user/get?id=7
X-API-KEY: {your_api_key}
/api/partner_user/list
Retrieve a paginated list of partner contacts with filtering options.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
list_offset | int | Pagination offset (default: 0) | |
partner_id | int | Filter by partner identifier | |
list_condition[partner_id] | int | Filter by partner identifier (in the condition object) | |
list_condition[name] | string | Filter by name (LIKE) | |
list_condition[email] | string | Filter by email address (LIKE) | |
list_condition[telephone] | string | Filter by phone number (digits only) | |
list_condition[fax] | string | Filter by fax number (LIKE) | |
list_condition[invocation] | string | Filter by salutation (LIKE) |
Example Request
GET /api/partner_user/list?partner_id=42&list_offset=0
X-API-KEY: {your_api_key}
/api/partner_user/save
Create or update a partner contact. For a new contact, use data[id] = 0.
POST Fields — data object
| Field | Type | Required | Description |
|---|---|---|---|
id | int | 0 = new contact, >0 = update | |
partner_id | int | Partner identifier (required for new contacts) | |
name | string | Contact name | |
email | string | Email address | |
telephone | string | Phone number | |
fax | string | Fax number | |
invocation | string | Salutation (e.g. "Dear Sir") | |
partner_user_status_id | int | Contact status identifier | |
outer_resource_id | string | External system identifier |
Example Request
POST /api/partner_user/save
X-API-KEY: {your_api_key}
Content-Type: application/json
{
"data": {
"id": 0,
"partner_id": 42,
"name": "Kovács Béla",
"email": "kovacs.bela@minta.hu",
"telephone": "+36301234567",
"invocation": "Tisztelt Kovács Úr!"
}
}
/api/partner_user/delete
Delete a partner contact by identifier.
POST Fields — data object
| Field | Type | Required | Description |
|---|---|---|---|
id | int | Identifier of the contact to delete |
Example Request
POST /api/partner_user/delete
X-API-KEY: {your_api_key}
Content-Type: application/json
{ "data": { "id": 7 } }
Create your account now,
pay later!