Contacts

Overview

In Ziflow we have two type of contacts. One of them are Ziflow users and second one are all the guests that might have been invited to your proofs. Each contact contains following set of information:

Field

Description

Read-only

id

Unique ID of a contact.

type

In Ziflow there are two contacts types.

user / guest

first-name

'Mark'

For contact type 'guest' null value is also allowed

 

last-name

'Smith'

For contact type 'guest' null value is also allowed

 

email

Contact email address.

'user@domain.com'

roles

For contact type 'user' there are 4 roles available 

[

'admin',

'manager',

'billing',

'user'

]

For contact type 'guest' value is 'null'.

phone

'+4412345678911' / null

 

 

company

'ABC Inc' / null

 

tenant

For Ziflow users object contains information about Ziflow tenant_id, subdomain and company name

{

tenant_id: 'tenant_id',

subdomain: 'yoursubdomain',

company_name: 'yourcompany'

}

For guests value is null

verified

true / false

For guest always false

blocked

true / false

If contact type is guest then value is 'false'

 

timezone

'Europe/London'

If not specified in the app the value is 'null'

 

Get contact

Method Details
HTTP methods GET
Response format json
Requires authentication Yes
Rate limited Yes

GET /v1/contacts/{contact-id}

Returns information about specific contact in the account.

Required parameters How to use Description
API Token apikey=[key] query parameter Used to authenticate the request
Contact ID Used in the request URL (see above) Unique identifier of a specific contact

Get all contacts

Method Details
HTTP methods GET
Response format json
Requires authentication Yes
Rate limited Yes

GET /v1/contacts

Returns list of all contacts in the account.

 Required parameters  How to use  Description
API Token apikey=[key] query parameter Used to authenticate the request