Clients
API for managing Clients (Sub-User Accounts)
List Clients
GET
https://www.magloft.com/api/portal/v1/clients/
This endpoint returns a list of clients
Retrieve paginated list of clients
GET
https://www.magloft.com/api/portal/v1/clients/page/:page
This endpoint returns a page list of all clients
Path Parameters
Name | Type | Description |
---|---|---|
page | Integer | The page number to list |
Query Parameters
Name | Type | Description |
---|---|---|
per_page | Integer | Number of items to show per page |
order_by | Symbol | Field to sort results by |
order_dir | Symbol | Direction (asc, desc) to sort results by |
filter | String | Text filter to search results by |
publication_id | Integer | Filter by publications ID |
GET Client
GET
https://www.magloft.com/api/portal/v1/clients/:id
This endpoint returns a specific client
by id
Path Parameters
Name | Type | Description |
---|---|---|
id | Integer | Client ID |
Create new client
POST
https://www.magloft.com/api/portal/v1/clients/
This endpoint creates a new client
and returns the saved client
Request Body
Name | Type | Description |
---|---|---|
String | Client email address | |
firstname | String | Client Firstname |
lastname | String | Client Lastname |
password | String | Client Password |
Update Client
PUT
https://www.magloft.com/api/portal/v1/clients/:id
This endpoint updates a specific client
by id
and returns the updated client
Path Parameters
Name | Type | Description |
---|---|---|
id | Integer | Client ID |
Request Body
Name | Type | Description |
---|---|---|
firstname | String | Client Firstname |
lastname | String | Client Lastname |
password | String | Client Password |
password_confirmation | String | Client Password Confirmation |
Delete Client
DELETE
https://www.magloft.com/api/portal/v1/clients/:id
This endpoint deletes a specific client
by id
and returns an empty response
with status 204
Path Parameters
Name | Type | Description |
---|---|---|
id | Integer | Client ID |
Become Client
GET
https://www.magloft.com/api/portal/v1/clients/:id/become
This endpoint logs in as a client
by id
and returns the new client
user
Path Parameters
Name | Type | Description |
---|---|---|
id | Integer | Client ID |
Last updated