Get all imports

GET /api/v1/import

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).

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
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": "e16b587b-003a-4ba2-94a7-ed4cfded2802",
      "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": "3f1ebaf7-7358-41ae-9972-2d8fd56e8bf9",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2024-10-16T11:10:13+01:00",
        "first_name": "Gareth",
        "updated_at": "2024-10-16T11:10:13+01: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": "2024-10-16T11:10:13+01:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2024-10-16T11:10:13+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "previous_review_date": "2024-10-16T11:10:13+01:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2024-10-16T11:10:13+01:00"
      },
      "headers": [
        "fname",
        "lname",
        "email"
      ],
      "mapping": {
        "email": "email",
        "fname": "first_name",
        "lname": "last_name"
      },
      "progress": 100,
      "created_at": "2024-10-16T11:10:13+01:00",
      "total_jobs": 4,
      "updated_at": "2024-10-16T11:10:13+01: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": "f3f886d1-0ee2-42e0-a943-e4d23666e235",
        "parent": "Object",
        "status": "uploaded",
        "account": "App\\Http\\Resources\\AccountResource",
        "filename": "Welcome to Plannr.pdf",
        "progress": "100",
        "extension": "pdf",
        "created_at": "2024-10-16T11:10:13+01:00",
        "updated_at": "2024-10-16T11:10:13+01:00",
        "folder_name": "folder 2",
        "uploaded_at": "2024-10-16T11:10:13+01:00",
        "download_url": "https://plannr.valet/file/0de7d993-7810-46d2-a1a3-1ae1276a23be/download",
        "last_modified": "2024-10-16T11:10:13+01:00",
        "original_created_at": "2024-10-16T11:10:13+01:00"
      },
      "jobs_remaining": 1
    }
  ]
}