List all import jobs for a specific group · Email

infoOverview

About this API

Retrieves a paginated list of all import jobs for a specific group created by the authenticated user. Supports search, sorting, and pagination. Search is performed on the original_name field (case-insensitive).

MethodGET

Versionv1.0

Get Test URL Get Test API Key

Content TypeNo request body

keySecurity

Authentication

Include your API credential in the request header. Keep credentials on the server and never expose them in client-side applications.

Locationheader

Field nameAuthorization: Bearer <TOKEN>

Example valueYOUR_ACCESS_TOKEN

routeParameters

Path Parameters

Substitute these placeholders in the endpoint URL before sending the request.

groupIdstringRequiredUnique identifier of the group to list import jobs for.

tuneParameters

Query Parameters

Append these values to the URL query string. Omit optional parameters when they are not needed.

pageintegerNot specifiedPage number for pagination (default: 1).

limitintegerNot specifiedNumber of items per page (default: 10).

searchstringNot specifiedSearch term to filter import jobs by original file name (case-insensitive).

sortBystringNot specifiedField to sort by (default: created_at).

sortOrderstringNot specifiedSort order: 'asc' or 'desc' (default: desc).

uploadInput

Request Details

check_circle

No Request Body

Provide identifiers in the path and any supported values in the query string.

codeIntegration

Code Examples

Select your language and customize the request URL. Credential placeholders are intentionally preserved so secrets never appear in generated samples.

Request URL

shield_lockCredentials protectedAdd secrets only in your secure server environment.

downloadSDK

curl --request GET 'https://email.1spoc.com/api/user/imports/{groupId}/all' \
  --header 'Authorization: Bearer <TOKEN>'

const response = await fetch('https://email.1spoc.com/api/user/imports/{groupId}/all', {
  method: 'GET',
  headers: {
    "Authorization": "Bearer <TOKEN>"
  },
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);

const response = await fetch('https://email.1spoc.com/api/user/imports/{groupId}/all', {
  method: 'GET',
  headers: {
    "Authorization": "Bearer <TOKEN>"
  },
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data);

import json
import requests

url = 'https://email.1spoc.com/api/user/imports/{groupId}/all'
headers = {
  "Authorization": "Bearer <TOKEN>"
}
response = requests.get(url, headers=headers)

response.raise_for_status()
print(response.json())

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var client = HttpClient.newHttpClient();
var request = HttpRequest.newBuilder(URI.create("https://email.1spoc.com/api/user/imports/{groupId}/all"))
    .header("Authorization", "Bearer <TOKEN>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());

<?php
$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://email.1spoc.com/api/user/imports/{groupId}/all',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => ["Authorization: Bearer <TOKEN>"],
]);
$response = curl_exec($curl);
if ($response === false) throw new Exception(curl_error($curl));
curl_close($curl);
echo $response;

using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = AuthenticationHeaderValue.Parse("Bearer <TOKEN>");
var response = await client.GetAsync("https://email.1spoc.com/api/user/imports/{groupId}/all");
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    request, err := http.NewRequest("GET", "https://email.1spoc.com/api/user/imports/{groupId}/all", nil)
    if err != nil { panic(err) }
    request.Header.Set("Accept", "application/json")
    request.Header.Set("Authorization", "Bearer <TOKEN>")
    response, err := http.DefaultClient.Do(request)
    if err != nil { panic(err) }
    defer response.Body.Close()
    data, err := io.ReadAll(response.Body)
    if err != nil { panic(err) }
    if response.StatusCode >= 400 { panic(fmt.Sprintf("HTTP %d: %s", response.StatusCode, data)) }
    fmt.Println(string(data))
}

downloadOutput

Response

A successful request returns the documented response payload. Delivery and asynchronous events may arrive separately through configured webhooks.

{}

{
  "type": "object",
  "example": {
    "data": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "status": "COMPLETED",
        "user_id": "123e4567-e89b-12d3-a456-426614174001",
        "admin_id": "123e4567-e89b-12d3-a456-426614174002",
        "file_key": "imports/123e4567-e89b-12d3-a456-426614174001/abc123.csv",
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-15T10:35:00Z",
        "original_name": "contacts.csv",
        "failure_reason": null,
        "total_contacts": 100,
        "failed_contacts": 2,
        "processed_contacts": 98
      },
      {
        "id": "123e4567-e89b-12d3-a456-426614174003",
        "status": "PROCESSING",
        "user_id": "123e4567-e89b-12d3-a456-426614174001",
        "admin_id": "123e4567-e89b-12d3-a456-426614174002",
        "file_key": "imports/123e4567-e89b-12d3-a456-426614174001/def456.csv",
        "created_at": "2024-01-16T14:20:00Z",
        "updated_at": "2024-01-16T14:22:00Z",
        "original_name": "new_contacts.csv",
        "failure_reason": null,
        "total_contacts": 50,
        "failed_contacts": 0,
        "processed_contacts": 25
      }
    ],
    "page": 1,
    "limit": 10,
    "total": 2
  },
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "Unique identifier for the import job."
          },
          "status": {
            "enum": [
              "PENDING",
              "QUEUED",
              "PROCESSING",
              "COMPLETED",
              "FAILED"
            ],
            "type": "string",
            "description": "Current status of the import job."
          },
          "user_id": {
            "type": "string",
            "format": "uuid",
            "description": "ID of the user who created the import job."
          },
          "admin_id": {
            "type": "string",
            "format": "uuid",
            "description": "ID of the admin associated with the user."
          },
          "file_key": {
            "type": "string",
            "description": "S3 key where the file is stored."
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp when the import job was created."
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Timestamp when the import job was last updated."
          },
          "original_name": {
            "type": "string",
            "description": "Original name of the imported file."
          },
          "failure_reason": {
            "type": "string",
            "nullable": true,
            "description": "Reason for failure if the import job failed."
          },
          "total_contacts": {
            "type": "integer",
            "default": 0,
            "description": "Total number of contacts in the import file."
          },
          "failed_contacts": {
            "type": "integer",
            "default": 0,
            "description": "Number of contacts that failed to import."
          },
          "processed_contacts": {
            "type": "integer",
            "default": 0,
            "description": "Number of contacts successfully processed."
          }
        }
      }
    },
    "page": {
      "type": "integer",
      "description": "Current page number."
    },
    "limit": {
      "type": "integer",
      "description": "Number of items per page."
    },
    "total": {
      "type": "integer",
      "description": "Total number of import jobs returned in this response."
    }
  }
}

ruleHTTP Responses

Status Codes

200Successfully retrieved list of import jobs.

401Unauthorized (missing or invalid user access token)

404User not found

500Internal server error