Pushing Entities Data

Entity data ingestion and processing

Push paginated entities into an active session

post

Sends a page of entities (e.g., 100 items). Valid batches are staged until the session is closed as apply.

Authorizations

ApiKeyAuth

Path parameters

regionurlundefined · enumRequired

Server slug based on regions: api - for US region based orgs in - for IN region based orgs eu - for EU region based orgs

Default: apiPossible values:

versionstring · enumRequired

API version (e.g., v1)

Default: v1Possible values:

integration_idstringRequired

Sprinto-issued integration identifier.

session_idstringRequired

Session identifier returned by the session creation endpoint.

Body

application/json

Responses

202

Batch accepted and staged

application/json

400

Validation error; batch rejected

application/json

401

Unauthorized

404

Session not found

409

Session not active

429

Too Many Requests

post

HTTPcURLJavaScriptPython

POST /{version}/integrations/{integration_id}/sessions/{session_id}/entities HTTP/1.1
Host: {regionurl}
api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 619

{
  "entities": {
    "User": [
      {
        "employeeId": "E12345",
        "firstName": "Alice",
        "lastName": "Johnson",
        "fullName": "Alice Johnson",
        "employmentStartDate": "2022-01-15T09:00:00Z",
        "employmentEndDate": null,
        "workEmail": "[email protected]",
        "managerId": "E54321",
        "role": "ENG01",
        "roleDescription": "Software Engineer",
        "employmentType": "EMPLOYEE"
      },
      {
        "employeeId": "C98765",
        "firstName": "Bob",
        "lastName": "Smith",
        "employmentStartDate": "2023-06-01T08:30:00Z",
        "employmentEndDate": "2023-12-31T17:00:00Z",
        "workEmail": "[email protected]",
        "managerId": null,
        "role": "CONS01",
        "roleDescription": "Contractor - IT Support",
        "employmentType": "CONTRACTOR"
      }
    ]
  }
}

{
  "session_id": "text",
  "accepted_count_total": 1,
  "accepted_count_by_entity": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "rejected_count_total": 1,
  "validation_errors": [
    {
      "entity_type": "text",
      "index": 1,
      "field": "text",
      "issue": "text"
    }
  ],
  "echoes": {
    "page_hint": 1
  }
}