Client Operations
❌
Credential Warning
Note: Sys Admin or Client Admin account permissions required to execute client operations. Sys Admin have full control over clients Client Admin can only administer their client
get /AppSpiderEnterprise/rest/v1/Client/GetClients
Description
Retrieves a list of clients. Sys Admins will see all clients. Client Admin will only see their clients
Parameters
No parameters
Response Messages
| Response Status Code | Reason | Description |
|---|---|---|
| 200 | Success | Response contains the list of clients |
Response example:
{
"type": "object",
"properties": {
"Clients": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"ClientId": {
"type": "string"
},
"ClientName": {
"type": "string"
}
},
"required": [
"ClientId",
"ClientName"
]
}
]
},
"IsSuccess": {
"type": "boolean"
},
"Reason": {
"type": "null"
},
"ErrorMessage": {
"type": "null"
},
"Links": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"Rel": {
"type": "string"
},
"Href": {
"type": "string"
}
},
"required": [
"Rel",
"Href"
]
}
]
}
},
"required": [
"Clients",
"IsSuccess",
"Reason",
"ErrorMessage",
"Links"
]
}get /AppSpiderEnterprise/rest/v1/Client/GetClient?clientName=<insert clientname>
Description
Retrieves a client based on it’s name.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| clientName | string | Y | The name of the client |
Response Messages
| Response Status Code | Reason | Description |
|---|---|---|
| 200 | Client found | |
| 400 | Required parameters not provided | |
| 400 | NotFound | No Client Found |
Response example:
{
"type": "object",
"properties": {
"Client": {
"type": "object",
"properties": {
"ClientId": {
"type": "string"
},
"ClientName": {
"type": "string"
},
"LoweredClientName": {
"type": "string"
},
"Address": {
"type": "null"
},
"Email": {
"type": "string"
},
"Phone": {
"type": "null"
},
"Mobile": {
"type": "null"
},
"Notes": {
"type": "null"
},
"DefaultTimeZone": {
"type": "string"
},
"DefendEnabled": {
"type": "boolean"
},
"EnhancedServices": {
"type": "boolean"
}
},
"required": [
"ClientId",
"ClientName",
"LoweredClientName",
"Address",
"Email",
"Phone",
"Mobile",
"Notes",
"DefaultTimeZone",
"DefendEnabled",
"EnhancedServices"
]
},
"IsSuccess": {
"type": "boolean"
},
"Reason": {
"type": "null"
},
"ErrorMessage": {
"type": "null"
},
"Links": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"Rel": {
"type": "string"
},
"Href": {
"type": "string"
}
},
"required": [
"Rel",
"Href"
]
}
]
}
},
"required": [
"Client",
"IsSuccess",
"Reason",
"ErrorMessage",
"Links"
]
}get /AppSpiderEnterprise/rest/v1/Client/GetClient?clientId=<insert clientid>
Description
Retrieves a client based on it’s Id.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| clientId | guid | Y | Client Id |
Response Messages
| Response status code | Reason | Description |
|---|---|---|
| 200 | Client found | |
| 400 | InvalidJsonSchema | Required parameters not provided |
| 400 | NotFound | No Client Found |
Response example:
{
"type": "object",
"properties": {
"Client": {
"type": "object",
"properties": {
"ClientId": {
"type": "string"
},
"ClientName": {
"type": "string"
},
"LoweredClientName": {
"type": "string"
},
"Address": {
"type": "null"
},
"Email": {
"type": "string"
},
"Phone": {
"type": "null"
},
"Mobile": {
"type": "null"
},
"Notes": {
"type": "null"
},
"DefaultTimeZone": {
"type": "string"
},
"DefendEnabled": {
"type": "boolean"
},
"EnhancedServices": {
"type": "boolean"
}
},
"required": [
"ClientId",
"ClientName",
"LoweredClientName",
"Address",
"Email",
"Phone",
"Mobile",
"Notes",
"DefaultTimeZone",
"DefendEnabled",
"EnhancedServices"
]
},
"IsSuccess": {
"type": "boolean"
},
"Reason": {
"type": "null"
},
"ErrorMessage": {
"type": "null"
},
"Links": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"Rel": {
"type": "string"
},
"Href": {
"type": "string"
}
},
"required": [
"Rel",
"Href"
]
}
]
}
},
"required": [
"Client",
"IsSuccess",
"Reason",
"ErrorMessage",
"Links"
]
}get /AppSpiderEnterprise/rest/v1/Client/GetClientAccounts?clientId=<insert clientid>
Description
Retrieves a list of a client’s accounts
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| clientId | guid | Y | Client Id |
Response Messages
| Response status code | Reason | Description |
|---|---|---|
| 200 | Client found | |
| 400 | Required parameters not provided | |
| 400 | NotFound | No Client Accounts Found |
Response example:
{
"type": "object",
"properties": {
"Accounts": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"UserId": {
"type": "string"
},
"UserName": {
"type": "string"
},
"ClientId": {
"type": "string"
}
},
"required": [
"UserId",
"UserName",
"ClientId"
]
}
]
},
"IsSuccess": {
"type": "boolean"
},
"Reason": {
"type": "null"
},
"ErrorMessage": {
"type": "null"
},
"Links": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"Rel": {
"type": "string"
},
"Href": {
"type": "string"
}
},
"required": [
"Rel",
"Href"
]
}
]
}
},
"required": [
"Accounts",
"IsSuccess",
"Reason",
"ErrorMessage",
"Links"
]
}