Skip to main content
POST
/
v1
/
collaborators
/
import-excel
Upload import template
curl --request POST \
  --url https://api.capitalcheckin.app/v1/collaborators/import-excel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file'
{
  "message": "<string>",
  "total_rows": 123,
  "valid_rows": 123,
  "invalid_rows": 123,
  "preview": [
    {
      "name": "<string>",
      "email": "[email protected]",
      "position": "<string>",
      "department": "<string>",
      "phone": "<string>",
      "hire_date": "2023-12-25",
      "salary": 123,
      "manager_id": "<string>",
      "work_schedule": "<string>",
      "location": "<string>",
      "emergency_contact": {
        "name": "<string>",
        "phone": "<string>",
        "relationship": "<string>"
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

OAuth2 access token for authentication

Body

multipart/form-data
file
file

Excel file with collaborator data

Response

200 - application/json

Import results

message
string

Import result message

total_rows
integer

Total number of rows in the file

valid_rows
integer

Number of valid rows

invalid_rows
integer

Number of invalid rows

preview
object[]

Preview of the data to be imported