Skip to main content
POST
/
v1
/
collaborators
/
import
Add multiple collaborators
curl --request POST \
  --url https://api.capitalcheckin.app/v1/collaborators/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "collaborators": [
    {
      "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>"
      }
    }
  ]
}
'
{
  "message": "<string>",
  "created": 123,
  "failed": 123,
  "errors": [
    {
      "index": 123,
      "error": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

OAuth2 access token for authentication

Body

application/json
collaborators
object[]
required

List of collaborators to import

Response

201 - application/json

Collaborators created

message
string

Import result message

created
integer

Number of collaborators created

failed
integer

Number of collaborators that failed to import

errors
object[]

List of import errors