Category: User Endpoints

UT /api/users/:id, parameters: PARAMS KEY MANDATORY TYPE Description Example ID (in URL) yes integer User uniq ID 8 first_name no string first_name John last_name no string last_name Doe subscriber no string User extension 1001 email no string email john@doe@email.ca department_id no | can be default per install string Actually department name … finance realm_id yes […]

GET /api/users/:id, more info: MANDATORY TYPE Description Example (with URL) yes integer User uniq ID /api/users/8 Result example: JSON – output Example:

GET /api/users, parameters: PARAMS KEY MANDATORY TYPE Description Example realm yes string Client unique domain office.modulis.clusterpbx.ca Result example: JSON – output Example:

DELETE /api/users/:id, more info: URL PARAMS MANDATORY TYPE Description Example (with URL) yes yes integer User uniq ID /api/users/8

POST /api/users, parameters: PARAMS KEY MANDATORY TYPE Description Example first_name yes string first_name John last_name yes string last_name Doe subscriber yes string User extension 1001 email yes string email john@doe@email.ca department_id yes | can be default per install string department name … finance realm_id yes | can be default per install integer Uniq ID of […]

HTTP METHOD PATH Description DELETE /api/users/:id DELETE A USER GET /api/users GET ALL END USERS IN A GIVEN REALM GET /api/users/:id GET A USER BY ID POST /api/users CREATE A USER PUT /api/users/:id UPDATE A USER