Partner Contact API

Manage contact persons assigned to a partner — retrieval, creation, update, and deletion

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.

GET /api/partner_user/get

Retrieve a single partner contact by identifier, email address, or partner identifier.

Query Parameters

ParameterTypeRequiredDescription
idintUnique identifier of the contact
emailstringSearch by email address
partner_idintPartner identifier — the first contact found is returned

Example Request

GET /api/partner_user/get?id=7
X-API-KEY: {your_api_key}
GET /api/partner_user/list

Retrieve a paginated list of partner contacts with filtering options.

Query Parameters

ParameterTypeRequiredDescription
list_offsetintPagination offset (default: 0)
partner_idintFilter by partner identifier
list_condition[partner_id]intFilter by partner identifier (in the condition object)
list_condition[name]stringFilter by name (LIKE)
list_condition[email]stringFilter by email address (LIKE)
list_condition[telephone]stringFilter by phone number (digits only)
list_condition[fax]stringFilter by fax number (LIKE)
list_condition[invocation]stringFilter by salutation (LIKE)

Example Request

GET /api/partner_user/list?partner_id=42&list_offset=0
X-API-KEY: {your_api_key}
POST /api/partner_user/save

Create or update a partner contact. For a new contact, use data[id] = 0.

POST Fields — data object

FieldTypeRequiredDescription
idint0 = new contact, >0 = update
partner_idintPartner identifier (required for new contacts)
namestringContact name
emailstringEmail address
telephonestringPhone number
faxstringFax number
invocationstringSalutation (e.g. "Dear Sir")
partner_user_status_idintContact status identifier
outer_resource_idstringExternal 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!"
  }
}
POST /api/partner_user/delete

Delete a partner contact by identifier.

POST Fields — data object

FieldTypeRequiredDescription
idintIdentifier 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 } }

Get in touch with us

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

Need help?

If you can't find the answer and need assistance

Create your account now,
pay later!

Try it free for 3 days, no risk, no obligation!