Workspace API: Sites

Retrieves one specific site

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

sitestring · uuidRequired

Responses

200

OK

application/jsontext/json

get

/api/workspace/sites/{site}

HTTPcURLJavaScriptPython

GET /v2/e01/api/workspace/sites/{site} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "siteId": "123e4567-e89b-12d3-a456-426614174000",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "siteDomain": "text",
  "siteTitle": "text",
  "lastChangeTime": "2026-01-29T17:49:11.460Z"
}

Checks for the existence of one specific site

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

sitestring · uuidRequired

Responses

200

OK

application/jsontext/json

Responseboolean

head

/api/workspace/sites/{site}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/workspace/sites/{site} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collects the list of sites that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

lastChangeTypestring · nullableOptional

lastChangeUserstring · nullableOptional

siteDomainstring · nullableOptional

siteTitlestring · nullableOptional

lastChangeTimestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/workspace/sites/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/workspace/sites/collect HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 627

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T17:49:11.460Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "siteDomain": "text",
  "siteTitle": "text",
  "lastChangeTime": "2026-01-29T17:49:11.460Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "siteId": "123e4567-e89b-12d3-a456-426614174000",
    "lastChangeType": "text",
    "lastChangeUser": "text",
    "siteDomain": "text",
    "siteTitle": "text",
    "lastChangeTime": "2026-01-29T17:49:11.460Z"
  }
]

Counts the sites that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

lastChangeTypestring · nullableOptional

lastChangeUserstring · nullableOptional

siteDomainstring · nullableOptional

siteTitlestring · nullableOptional

lastChangeTimestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/workspace/sites/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/workspace/sites/count HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 627

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T17:49:11.460Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "siteDomain": "text",
  "siteTitle": "text",
  "lastChangeTime": "2026-01-29T17:49:11.460Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "count": 1,
  "summary": "text"
}

Downloads the list of sites that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

lastChangeTypestring · nullableOptional

lastChangeUserstring · nullableOptional

siteDomainstring · nullableOptional

siteTitlestring · nullableOptional

lastChangeTimestring · date-time · nullableOptional

Responses

200

OK

No content

post

/api/workspace/sites/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/workspace/sites/download HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 627

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T17:49:11.460Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "siteDomain": "text",
  "siteTitle": "text",
  "lastChangeTime": "2026-01-29T17:49:11.460Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of sites that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid · nullableOptional

organizationIdstring · uuid · nullableOptional

lastChangeTypestring · nullableOptional

lastChangeUserstring · nullableOptional

siteDomainstring · nullableOptional

siteTitlestring · nullableOptional

lastChangeTimestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/workspace/sites/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/workspace/sites/search HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 627

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-29T17:49:11.460Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "siteDomain": "text",
  "siteTitle": "text",
  "lastChangeTime": "2026-01-29T17:49:11.460Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "siteIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]