Get all imports
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 \
-X GET https://api.plannrcrm.com/api/v1/import \
-H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
Response examples (200)
{
"data": [
{
"mode": "store",
"type": "clients",
"uuid": "ab8429e4-eb49-46c5-99aa-42ee56d4e065",
"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": "3da9ac3c-d11e-4cf2-a044-044014dcc775",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-01-21T09:11:07+00:00",
"first_name": "Gareth",
"updated_at": "2025-01-21T09:11:07+00:00",
"with_login": true,
"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-01-21T09:11:07+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-01-21T09:11:07+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2025-01-21T09:11:07+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-01-21T09:11:07+00:00"
},
"headers": [
"fname",
"lname",
"email"
],
"mapping": {
"email": "email",
"fname": "first_name",
"lname": "last_name"
},
"progress": 100,
"created_at": "2025-01-21T09:11:07+00:00",
"total_jobs": 4,
"updated_at": "2025-01-21T09:11:07+00:00",
"failed_jobs": 1,
"error_report": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Welcome to Plannr",
"size": "21691783",
"tags": "App\\Http\\Resources\\TagResource",
"type": "type",
"uuid": "06d21838-c86a-497d-a30a-386ac658914e",
"parent": "Object",
"status": "uploaded",
"account": "App\\Http\\Resources\\AccountResource",
"filename": "Welcome to Plannr.pdf",
"progress": "100",
"extension": "pdf",
"created_at": "2025-01-21T09:11:07+00:00",
"updated_at": "2025-01-21T09:11:07+00:00",
"folder_name": "folder 2",
"uploaded_at": "2025-01-21T09:11:07+00:00",
"download_url": "https://plannr.valet/file/a9577e18-ab6c-44d5-9527-4bcedfbb3d1c/download",
"last_modified": "2025-01-21T09:11:07+00:00",
"original_created_at": "2025-01-21T09:11:07+00:00"
},
"jobs_remaining": 1
}
]
}