Links
CRUD endpoints for a user's custom links
Please note that in all urls & code samples you'll need to replace:username
and :corporation
with appropriate values
Get All Links
GET
/v2/organization/:corporation/staff/:username/link
Headers
Name | Value |
---|---|
Content-Type |
|
Authorization |
|
Url
Name | Type | Description |
---|---|---|
corporation | number | Corporation ID |
username | string | Unique username |
Response
Code
Get Individual Link
GET
/v2/organization/:corporation/staff/:username/link/:id
Headers
Name | Value |
---|---|
Content-Type |
|
Authorization |
|
Url
Name | Type | Description |
---|---|---|
corporation | number | Corporation ID |
username | string | Unique username |
id | number | Link ID |
Response
Code
Create Link
POST
/v2/organization/:corporation/staff/:username/link
Headers
Name | Value |
---|---|
Content-Type |
|
Authorization |
|
Url
Name | Type | Description |
---|---|---|
corporation | number | Corporation ID |
username | string | Unique username |
Body
Name | Type | Description |
---|---|---|
name* | string | Link Name |
url* | string | Link Url *must be valid url |
Response
Code
Update Link
PUT
/v2/organization/:corporation/staff/:username/link/:id
Headers
Name | Value |
---|---|
Content-Type |
|
Authorization |
|
Url
Name | Type | Description |
---|---|---|
corporation | number | Corporation ID |
username | string | Unique username |
id | number | Link ID |
Body
Name | Type | Description |
---|---|---|
name* | string | Link Name |
url* | string | Link Url *must be valid url |
Response
Code
Delete Link
DELETE
/v2/organization/:corporation/staff/:username/link/:id
Headers
Name | Value |
---|---|
Content-Type |
|
Authorization |
|
Url
Name | Type | Description |
---|---|---|
corporation | number | Corporation ID |
username | string | Unique username |
id | number | Link ID |
Response
Code
Last updated