JSON API » urls » urls/get
Gets the fields of a web URL.
Input parameters
Requires authentication and the urls or user role privileges.
| Name | Type | Description | Required | Default value |
|---|---|---|---|---|
| auth_username | String | Authentication username. | Yes | |
| auth_password | String | Authentication password. | Yes | |
| id | Integer | ID of web URL to get. | Yes |
Responses
| Code | Description |
|---|---|
| 200 | Success. |
| 401 | The authentication details provided are invalid. |
| 402 | Your role does not allow this. |
| 404 | The web URL does not exist, or you do not have permission to view it. |
Data returned
Fields of web URL.
Example: With required parameters
https://www.015pbx.net/local/api/json/urls/get/?auth_username=user;auth_password=password;id=123{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "id":"123", "name":"example1", ... } }