List business requests (admin)

GET

/api/BusinessRequest/GetRequests

GET

/api/BusinessRequest/GetRequests

curl https://api.vlenseg.com/api/BusinessRequest/GetRequests \
     -H "ApiKey: <apiKey>"

200Retrieved

{
  "data": {
    "totalCount": 1,
    "items": [
      {
        "id": "string",
        "idNumber": "string",
        "requestNumber": "string",
        "fullName": "string",
        "requestStatusName": "string",
        "creationTime": "2024-01-15T09:30:00Z",
        "lastModificationTime": "2024-01-15T09:30:00Z",
        "creatorUserFullName": "string",
        "businessRequestType": 1,
        "parentId": "string",
        "typeName": "string",
        "contractTypeId": 1,
        "contractTypeName": "string",
        "groupedId": "string",
        "children": [
          {
            "id": "string",
            "idNumber": "string",
            "requestNumber": "string",
            "fullName": "string",
            "requestStatusName": "string",
            "creationTime": "2024-01-15T09:30:00Z",
            "lastModificationTime": "2024-01-15T09:30:00Z",
            "creatorUserFullName": "string",
            "businessRequestType": 1,
            "parentId": "string",
            "typeName": "string",
            "contractTypeId": 1,
            "contractTypeName": "string",
            "groupedId": "string"
          }
        ]
      }
    ]
  },
  "error_code": 1,
  "error_message": "string",
  "error_descriptions": [
    {}
  ]
}

Paged list of the tenant’s business requests, as shown on the portal’s Business Requests page. Requires ApiKey and an admin bearer token.

Filter by signing date with CustomerSignedFrom / CustomerSignedTo (when the customer signed) and ServiceProviderSignedFrom / ServiceProviderSignedTo (when the service provider signed).

Authentication

ApiKeystring

Static API key issued to your tenant. Required on every request.

AuthorizationBearer

Admin JWT from /api/credentials/Login. Required for admin operations.

Query parameters

RequestTypeintegerOptional

FilterTextstringOptional

Free-text search.

CreatorUserIdlongOptional

CreatedFromdatetimeOptional

Created on or after this date.

CreatedTodatetimeOptional

Created on or before this date.

ModifiedFromdatetimeOptional

Last modified on or after this date.

ModifiedTodatetimeOptional

Last modified on or before this date.

CustomerSignedFromdatetimeOptional

Customer signed on or after this date.

CustomerSignedTodatetimeOptional

Customer signed on or before this date.

ServiceProviderSignedFromdatetimeOptional

Service provider signed on or after this date.

ServiceProviderSignedTodatetimeOptional

Service provider signed on or before this date.

RequestStatuseslist of integersOptional

One or more request status IDs. See Request statuses.

ApiKeyIdslist of integersOptional

IsFlattenedbooleanOptional

SortingstringOptional

MaxResultCountintegerOptional1-1000

SkipCountintegerOptional>=0

Response

A page of business requests.

dataobjectOptional

error_codeinteger or nullOptional

error_messagestring or nullOptional

error_descriptionslist of objects or nullOptional