Get site(s) access

GET 
/sites

Returns the list of sites that the user has access to

Request

Query Parameters

status SiteStatus

Possible values: [ACTIVE, INACTIVE]

Fetch sites with status (only valid when using SitePermissions 'defined'

Responses

200

200 OK

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

username string

Username of request caller

sites

object[]

List of sites

Array [

siteId string

Site Identifier

title string

Site Title

status SiteStatus (string)

Site status

Possible values: [ACTIVE, INACTIVE]

permission string

SiteId permission level

Possible values: [READ_WRITE, READ_ONLY]

permissions SiteGroupPermissions (string)[]

Possible values: [ADMIN, DELETE, READ, WRITE, GOVERN]

uploadEmail string

SiteId document upload email address

config

object

maxContentLengthBytes string

Set Maximum Document Content Length in Bytes

maxDocuments string

Set Maximum number of Documents allowed

maxWebhooks string

Set Maximum number of Webhooks allowed

ocr

object

maxPagesPerTransaction number

Max number of OCR pages (-1 for unlimited)

maxTransactions number

Max number of OCR actions that can be created (-1 for unlimited)

usage

object

documentCount number

The number of documents in the site (only tracked when using MaxDocuments)

ocrTransactionCount number

The number of ocr tx requests in the site (only tracked when using OCR MaxTransactions)

]

Example (from schema)

{
  "username": "string",
  "sites": [
    {
      "siteId": "string",
      "title": "string",
      "status": "ACTIVE",
      "permission": "READ_WRITE",
      "permissions": [
        "ADMIN"
      ],
      "uploadEmail": "string",
      "config": {
        "maxContentLengthBytes": "string",
        "maxDocuments": "string",
        "maxWebhooks": "string",
        "ocr": {
          "maxPagesPerTransaction": 0,
          "maxTransactions": 0
        }
      },
      "usage": {
        "documentCount": 0,
        "ocrTransactionCount": 0
      }
    }
  ]
}

Loading...