Skip to main content
Contact APIs

Introduce the Contact APIs in short.

Updated this week

Development Preparation

Before developing workflow APIs, you need to read the Developer's Guide carefully.


What is the Structure of Contact APIs?

Department Entity Structure (department)

Property

Type

Meaning

Note

dept_no

Number

The number of a department, which is unique within the enterprise

There may be repetitive department numbers between different companies.

parent_ no

Number

Parent department number

/

Type

Number

Department Type

0: Regular department

status

Number

Departmental Status

1: Department in use

seq

Number

Department order

Sort departments in ascending order within their parent department.

name

String

Department name

/

Member Entity Structure (user)

Property

Type

Meaning

Note

username

String

The number of a member, which is unique within the company.

There may be repetitive department numbers between different companies

name

Nickname

/

departments

Number

List of department numbers of members

/

type

Member type

0: regular member

status

Status

  • 0: Unconfirmed members

  • 1 Joined

Role Entity Structure (role)

Property

Type

Meaning

Note

role_no

Number

role ID, unique within the enterprise

There may be repetitive department numbers between different companies.

group_no

Number

role group number, unique within the enterprise

There may be repetitive department numbers between different companies.

type

Number

role's types

0: Regular role

status

Number

role's status

1: In use

name

String

role's name

/

Role Group Entity Structure (role_group)

Property

Type

Meaning

Note

group_no

Number

The number of a role group. It is unique within the enterprise

There may be repetitive department numbers between different companies.

type

Number

role group's types

0: Regular character group

status

Number

role group's status

1: In use

name

String

role group's name

/


More to Know

Each contact is a department tree, and the department number of the root department is 1.


I have finished reading. 🏆

👉I can't wait to SET THE API.

👉I need more HELP in Discord Forum.

Did this answer your question?