> For the complete documentation index, see [llms.txt](https://docs.sprinto.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sprinto.com/api-reference/models.md).

# Models

## The IntegrationStatusCounts object

```json
{"openapi":"3.0.0","info":{"title":"Sprinto Custom Integration Entities Sync API","version":"1.0.0"},"components":{"schemas":{"IntegrationStatusCounts":{"type":"object","properties":{"integration_id":{"type":"string"},"sessions":{"type":"object","properties":{"active":{"type":"integer"},"processing":{"type":"integer"},"processed":{"type":"integer"},"failed":{"type":"integer"},"expired":{"type":"integer"}},"required":["active","processing","processed","failed","expired"]},"last_activity_at":{"type":"string","format":"date-time"}}}}}}
```

## The ActivityLogPage object

```json
{"openapi":"3.0.0","info":{"title":"Sprinto Custom Integration Entities Sync API","version":"1.0.0"},"components":{"schemas":{"ActivityLogPage":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ActivityEvent"}},"page":{"type":"integer"},"page_size":{"type":"integer"},"next_page":{"type":"integer","nullable":true}},"required":["items","page","page_size"]},"ActivityEvent":{"type":"object","properties":{"id":{"type":"string"},"at":{"type":"string","format":"date-time"},"level":{"type":"string","enum":["info","warning","error"]},"type":{"type":"string"},"message":{"type":"string"},"session_id":{"type":"string","nullable":true},"details":{"type":"object","additionalProperties":true}}}}}}
```

## The ActivityEvent object

```json
{"openapi":"3.0.0","info":{"title":"Sprinto Custom Integration Entities Sync API","version":"1.0.0"},"components":{"schemas":{"ActivityEvent":{"type":"object","properties":{"id":{"type":"string"},"at":{"type":"string","format":"date-time"},"level":{"type":"string","enum":["info","warning","error"]},"type":{"type":"string"},"message":{"type":"string"},"session_id":{"type":"string","nullable":true},"details":{"type":"object","additionalProperties":true}}}}}}
```

## The CreateSessionRequest object

```json
{"openapi":"3.0.0","info":{"title":"Sprinto Custom Integration Entities Sync API","version":"1.0.0"},"components":{"schemas":{"CreateSessionRequest":{"type":"object","properties":{"client_reference_id":{"type":"string","description":"Caller-side correlation id"}},"additionalProperties":false}}}}
```

## The Session object

```json
{"openapi":"3.0.0","info":{"title":"Sprinto Custom Integration Entities Sync API","version":"1.0.0"},"components":{"schemas":{"Session":{"type":"object","properties":{"id":{"type":"string"},"integration_id":{"type":"string"},"state":{"type":"string","enum":["active","processing","processed","failed","discard","expired"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"expires_at":{"type":"string","format":"date-time"},"inactivity_timeout_seconds":{"type":"integer"},"accepted_records_total":{"type":"integer","default":0},"accepted_records_by_entity":{"type":"object","additionalProperties":{"type":"integer"}},"last_error":{"type":"string","nullable":true}},"required":["id","integration_id","state","created_at","expires_at"]}}}}
```

## The SessionStatus object

```json
{"openapi":"3.0.0","info":{"title":"Sprinto Custom Integration Entities Sync API","version":"1.0.0"},"components":{"schemas":{"SessionStatus":{"allOf":[{"$ref":"#/components/schemas/Session"},{"type":"object","properties":{"accepted_batches":{"type":"integer","default":0},"retry_count":{"type":"integer","default":0}}}]},"Session":{"type":"object","properties":{"id":{"type":"string"},"integration_id":{"type":"string"},"state":{"type":"string","enum":["active","processing","processed","failed","discard","expired"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"expires_at":{"type":"string","format":"date-time"},"inactivity_timeout_seconds":{"type":"integer"},"accepted_records_total":{"type":"integer","default":0},"accepted_records_by_entity":{"type":"object","additionalProperties":{"type":"integer"}},"last_error":{"type":"string","nullable":true}},"required":["id","integration_id","state","created_at","expires_at"]}}}}
```

## The EntitiesEnvelope object

```json
{"openapi":"3.0.0","info":{"title":"Sprinto Custom Integration Entities Sync API","version":"1.0.0"},"components":{"schemas":{"EntitiesEnvelope":{"type":"object","required":["entities"],"properties":{"entities":{"type":"object","description":"A map of entity type to an array of entity objects.","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}
```

## The User object

```json
{"openapi":"3.0.0","info":{"title":"Sprinto Custom Integration Entities Sync API","version":"1.0.0"},"components":{"schemas":{"User":{"type":"object","properties":{"employeeId":{"type":"string","description":"Unique identifier for the employee"},"firstName":{"type":"string","description":"First name of the user"},"lastName":{"type":"string","description":"Last name of the user"},"fullName":{"type":"string","description":"Full name of the user"},"employmentStartDate":{"type":"string","format":"date-time","description":"ISO 8601 timestamp of employment start (e.g. \"2023-05-01T08:30:00Z\")"},"employmentEndDate":{"type":"string","format":"date-time","description":"ISO 8601 timestamp of employment end, if applicable (e.g. \"2023-12-31T17:00:00Z\")"},"workEmail":{"type":"string","format":"email","description":"Work email address"},"managerId":{"type":"string","description":"Employee ID of the manager"},"role":{"type":"string","description":"Role identifier or code"},"roleDescription":{"type":"string","description":"Human-readable role description"},"employmentType":{"type":"string","description":"Employment type","enum":["EMPLOYEE","CONTRACTOR"]}},"required":["employeeId","firstName","lastName","email","employmentStartDate","role","roleDescription"]}}}}
```

## The Device object

```json
{"openapi":"3.0.0","info":{"title":"Sprinto Custom Integration Entities Sync API","version":"1.0.0"},"components":{"schemas":{"Device":{"type":"object","properties":{"deviceId":{"type":"string","description":"Unique identifier for the device"},"deviceStatus":{"type":"string","description":"Current status of the device","enum":["active","inActive","outOfScope"]},"lastReportedDate":{"type":"string","description":"Last reported date/time of the device. Supports multiple formats: date-only (YYYY-MM-DD), UTC timestamp (YYYY-MM-DDTHH:mm:ss.sssZ), or timestamp with offset (YYYY-MM-DDTHH:mm:ss±HH:mm)"},"ownerEmail":{"type":"string","format":"email","description":"Email address of the device owner (optional but recommended)"},"deviceName":{"type":"string","description":"Human-readable name of the device"},"osVersion":{"type":"string","description":"Operating system version (optional, will fail check if not sent)"},"osName":{"type":"string","description":"Operating system name (optional, will fail check if not sent)","enum":["macOS","windows","ubuntu","linux","darwin"]},"isAntivirusRunning":{"type":"boolean","description":"Whether antivirus software is running on the device"},"isScreenLockEnabled":{"type":"boolean","description":"Whether screen lock is enabled on the device"},"screenLockDelay":{"type":"integer","description":"Screen lock delay in seconds"},"isHardDiskEncrypted":{"type":"boolean","description":"Whether hard disk encryption is enabled"},"isFirewallEnabled":{"type":"boolean","description":"Whether firewall is enabled on the device"},"metadata":{"type":"object","description":"Additional data sent by the client for use in custom checks","additionalProperties":true}},"required":["deviceId","deviceStatus","lastReportedDate","deviceName","isAntivirusRunning","isScreenLockEnabled","screenLockDelay","isHardDiskEncrypted","isFirewallEnabled"]}}}}
```

## The UserAccess object

```json
{"openapi":"3.0.0","info":{"title":"Sprinto Custom Integration Entities Sync API","version":"1.0.0"},"components":{"schemas":{"UserAccess":{"type":"object","properties":{"sourceIdentifier":{"type":"string","description":"Unique identifier for the user access record"},"username":{"type":"string","description":"Username for the access (optional, defaults to email if not provided)"},"displayName":{"type":"string","description":"Display name for the user (optional, defaults to username if not provided)"},"email":{"type":"string","format":"email","description":"Email address of the user"},"roles":{"type":"array","items":{"type":"string"},"description":"Array of role identifiers assigned to the user"},"isInScope":{"type":"boolean","description":"Whether this user access is in scope for compliance"},"is2faEnabled":{"type":"boolean","description":"Whether two-factor authentication is enabled (optional, defaults to false)","default":false},"isSsoLogin":{"type":"boolean","description":"Whether single sign-on is enabled (optional, defaults to false)","default":false},"metadata":{"type":"object","description":"Additional metadata for the user access","additionalProperties":true}},"required":["sourceIdentifier","email","roles","isInScope"]}}}}
```

## The BatchIngestResponse object

```json
{"openapi":"3.0.0","info":{"title":"Sprinto Custom Integration Entities Sync API","version":"1.0.0"},"components":{"schemas":{"BatchIngestResponse":{"type":"object","properties":{"session_id":{"type":"string"},"accepted_count_total":{"type":"integer"},"accepted_count_by_entity":{"type":"object","additionalProperties":{"type":"integer"}},"rejected_count_total":{"type":"integer"},"validation_errors":{"type":"array","items":{"type":"object","properties":{"entity_type":{"type":"string"},"index":{"type":"integer"},"field":{"type":"string"},"issue":{"type":"string"}}}},"echoes":{"type":"object","properties":{"page_hint":{"type":"integer","nullable":true}}}},"required":["session_id","accepted_count_total"]}}}}
```

## The CloseSessionRequest object

```json
{"openapi":"3.0.0","info":{"title":"Sprinto Custom Integration Entities Sync API","version":"1.0.0"},"components":{"schemas":{"CloseSessionRequest":{"type":"object","properties":{"status":{"type":"string","enum":["apply","discard"],"default":"apply"}},"required":["status"]}}}}
```

## The ErrorResponse object

```json
{"openapi":"3.0.0","info":{"title":"Sprinto Custom Integration Entities Sync API","version":"1.0.0"},"components":{"schemas":{"ErrorResponse":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.sprinto.com/api-reference/models.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.