Headers
-
Content-Type
string -
Accept
string
Query parameters
-
include
string Comma separated list of relationships to include in the response. Valid relationships are [initiatedBy].
-
filter[uuid]
string Filter by a comma separated list of UUIDs.
-
filter[types]
string Filter by a comma separated list of import types.
-
filter[statuses]
string Filter by a comma separated list of import statuses.
-
sort
string Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC. Defaults to 'created_at'.
-
per_page
integer Number of results to return with pagination (Default 15. Max 500).
GET
/api/v1/import
curl \
--request GET 'https://api.plannrcrm.com/api/v1/import' \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
Response examples (200)
{
"data": [
{
"mode": "store",
"type": "clients",
"uuid": "2df5bf15-3d52-4d56-a211-6753493774fc",
"errors": {
"client": {
"example": [],
"description": "Client that failed importing"
},
"errors": {
"example": {
"send_welcome_email": [
"The send welcome email field is required."
]
},
"description": "The reasons why the client failed importing"
}
},
"status": "processing",
"account": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "1317dec5-cb96-4163-95e8-1589247a3b0e",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-05-14T18:27:11+01:00",
"first_name": "Gareth",
"updated_at": "2025-05-14T18:27:11+01:00",
"with_login": true,
"inactive_at": "2025-05-14",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-05-14T18:27:11+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-05-14T18:27:11+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-05-14T18:27:11+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-05-14T18:27:11+01:00"
},
"headers": [
"fname",
"lname",
"email"
],
"mapping": {
"email": "email",
"fname": "first_name",
"lname": "last_name"
},
"progress": 100,
"created_at": "2025-05-14T18:27:11+01:00",
"total_jobs": 4,
"updated_at": "2025-05-14T18:27:11+01:00",
"failed_jobs": 1,
"error_report": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Welcome to Plannr",
"path": "Gareth Thompson/Subfolder/Welcome to Plannr.pdf",
"size": "21691783",
"tags": "App\\Http\\Resources\\TagResource",
"type": "type",
"uuid": "86301540-2b08-4c25-b3d4-cfe3d3f11f8c",
"folder": "App\\Http\\Resources\\FolderResource",
"status": "uploaded",
"account": "App\\Http\\Resources\\MinimalAccountResource",
"filename": "Welcome to Plannr.pdf",
"progress": "100",
"extension": "pdf",
"navigator": {
"model_type": "account",
"model_uuid": "0237bcfd-e58a-4dd4-89a4-2581eacfb9f7"
},
"created_at": "2025-05-14T18:27:11+01:00",
"updated_at": "2025-05-14T18:27:11+01:00",
"folder_name": "folder 2",
"uploaded_at": "2025-05-14T18:27:11+01:00",
"documentable": "Object",
"download_url": "https://plannr.valet/file/068eb2ec-0741-4e33-b764-2b13ebfb2260/download",
"last_modified": "2025-05-14T18:27:11+01:00",
"documentable_type": "account",
"original_created_at": "2025-05-14T18:27:11+01:00"
},
"jobs_remaining": 1
}
]
}