List of ImportFiles

GET

/api/v1/import

Request

Query Params

Header Params

Responses

🟢200

application/json

Import File status information

Body

🟠401

🟠403

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/v1/import?page&limit&id_eq=&status_eq=&company_id_eq=&file_processed_at_gt=&file_processed_at_gteq=&file_processed_at_lt=&file_processed_at_lteq=' \
--header 'Authorization;'

Response Example

200 - Example 1

{
    "import_files": [
        {
            "id": 0,
            "import_code": "string",
            "status": 0,
            "total_records": 0,
            "processed_records": 0,
            "failed_records": 0,
            "status_name": "string",
            "started_at": "string",
            "finished_at": "string",
            "error_file": "string",
            "original_file": "string",
            "imported_by": {
                "id": 0,
                "full_name": "string",
                "email": "string"
            },
            "success_rate": 0,
            "company": {}
        }
    ],
    "meta": {
        "current_page": 0,
        "next_page": 0,
        "prev_page": 0,
        "total_pages": 0,
        "total_records": 0
    }
}

Modified at 2026-02-17 21:54:09

Get pending invitations by email

Check status of an import