Share Point Imports

List SharePoint imports for a project.

get

Returns a paginated list of SharePoint imports for the project, sorted by date added (newest first by default).

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstring · uuidRequired

Query parameters

pageNumberinteger · int32Optional

pageSizeinteger · int32Optional

descbooleanOptionalDefault: true

Responses

200

OK

No content

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

get/projects/{projectIdentifier}/sharepoint-imports

HTTPcURLJavaScriptPython

GET /projects/{projectIdentifier}/sharepoint-imports HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Submit a SharePoint selection for import.

post

Creates a queued SharePoint import for the project, transfers the user's stored refresh token onto the import, and enqueues the worker message.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstring · uuidRequired

Body

application/jsontext/jsonapplication/*+json

ocrEnginestring · enumOptionalPossible values:

ocrStrategystring · enumOptionalPossible values:

coordinateExtractionStrategystring · enumOptionalPossible values:

parentObjectIdentifierstring · uuid · nullableOptional

Responses

201

Created

text/plainapplication/jsontext/json

objectIdentifierstring · uuidOptional

statusstring · enumOptionalPossible values:

failureReasonstring · nullableOptional

failureCodestring · enumOptionalPossible values:

itemsTotalinteger · int32 · nullableOptional

dateAddedstring · date-timeOptional

dateStartedstring · date-time · nullableOptional

dateCompletedstring · date-time · nullableOptional

documentUploadObjectIdentifierstring · uuid · nullableOptional

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

post/projects/{projectIdentifier}/sharepoint-imports

HTTPcURLJavaScriptPython

POST /projects/{projectIdentifier}/sharepoint-imports HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 282

{
  "items": [
    {
      "itemType": "site",
      "siteId": "text",
      "driveId": "text",
      "itemId": "text",
      "displayName": "text",
      "webUrl": "text"
    }
  ],
  "ocrEngine": "azureDocumentIntelligence",
  "ocrStrategy": "never",
  "coordinateExtractionStrategy": "never",
  "parentObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

application/jsontext/jsonapplication/*+json

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "status": "queued",
  "failureReason": "text",
  "failureCode": "unknown",
  "itemsTotal": 1,
  "dateAdded": "2026-07-11T09:32:09.902Z",
  "dateStarted": "2026-07-11T09:32:09.902Z",
  "dateCompleted": "2026-07-11T09:32:09.902Z",
  "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

Get a SharePoint import by identifier.

get

Returns a single SharePoint import scoped to the supplied project. Responds 404 if the import does not exist or belongs to a different project.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstring · uuidRequired

importIdentifierstring · uuidRequired

Responses

200

OK

text/plainapplication/jsontext/json

objectIdentifierstring · uuidOptional

statusstring · enumOptionalPossible values:

failureReasonstring · nullableOptional

failureCodestring · enumOptionalPossible values:

itemsTotalinteger · int32 · nullableOptional

dateAddedstring · date-timeOptional

dateStartedstring · date-time · nullableOptional

dateCompletedstring · date-time · nullableOptional

documentUploadObjectIdentifierstring · uuid · nullableOptional

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

get/projects/{projectIdentifier}/sharepoint-imports/{importIdentifier}

HTTPcURLJavaScriptPython

GET /projects/{projectIdentifier}/sharepoint-imports/{importIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "status": "queued",
  "failureReason": "text",
  "failureCode": "unknown",
  "itemsTotal": 1,
  "dateAdded": "2026-07-11T09:32:09.902Z",
  "dateStarted": "2026-07-11T09:32:09.902Z",
  "dateCompleted": "2026-07-11T09:32:09.902Z",
  "documentUploadObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

List items for a SharePoint import.

get

Returns a paginated list of the user's selections for the supplied import, in insertion order.

Authorizations

Bearer

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstring · uuidRequired

importIdentifierstring · uuidRequired

Query parameters

pageNumberinteger · int32Optional

pageSizeinteger · int32Optional

Responses

200

OK

No content

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

get/projects/{projectIdentifier}/sharepoint-imports/{importIdentifier}/items

HTTPcURLJavaScriptPython

GET /projects/{projectIdentifier}/sharepoint-imports/{importIdentifier}/items HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content