Skip to content
Connect API Catalog/
/
/
Returns all Data Cleaning...

Returns all Data Cleaning Jobs

Request

This endpoint can be used to retrieve all created data cleaning job requests as defined by the query parameters.

Security
bearerToken
Query
countriesstring

Comma separated list of ISO/Alpha-2 country codes to filter the results by.

statusstring

Returns the individual jobs by status. Possible values are: pending, processing, completed, failed.

jobNamestring

Returns the individual jobs by name.

fromDateinteger, (date-time)

Returns the individual jobs created after the specified date.

customerIdinteger

Returns the individual jobs by customer id.

toDateinteger, (date-time)

Returns the individual jobs created before the specified date.

userIdinteger

Returns the individual jobs by user id.

pageSizeinteger

Returns the number of individual jobs per page.

companyNamestring

Returns the individual jobs by company name.

pageinteger

Returns the page number of the individual jobs.

archivedboolean

Returns the individual jobs by archived status.

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/dataCleaning/jobs?countries=string&status=string&jobName=string&fromDate=0&customerId=0&toDate=0&userId=0&pageSize=0&companyName=string&page=0&archived=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

200 response

Bodyapplication/json
Array [
idstring

Unique identifier of the Data Cleaning job.

namestring

Name of the Data Cleaning job.

createdAtstring, (date-time)

Date and time when the job was created.

modifiedAtstring, (date-time)

Date and time when the job was last modified.

managingUserIdinteger, (int32)

User ID currently managing the job.

managingCustomerIdinteger, (int32)

Customer ID currently managing the job.

owningCustomerIdinteger, (int32)

Customer ID that owns the job.

owningUserIdinteger, (int32)

User ID that owns the job.

owningCompanyNamestring

Company name that owns the job.

statusstring

Current status of the job.

Enum:"created""uploading""uploadError""uploaded""ready""matching""matchingError""matched""addingToPortfolio""addedToPortfolio"
Example:"created"
countryCodestring

Country code associated with the job.

portfolioIdstring

Portfolio identifier associated with the job.

sourcestring

Source system that created the job.

Enum:"dataCleaning""prospects"
Example:"dataCleaning"
jobSummaryobject

Row-level matching summary for the uploaded job data.

jobEnrichmentSettingsobject

Enrichment settings used for the job.

archivedboolean

Indicates whether the job is archived.

owningUserAccountStatusstring

Account status of the owning user.

]
Response
[
  {
    "id": "string",
    "name": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "modifiedAt": "2019-08-24T14:15:22Z",
    "managingUserId": 0,
    "managingCustomerId": 0,
    "owningCustomerId": 0,
    "owningUserId": 0,
    "owningCompanyName": "string",
    "status": "created",
    "countryCode": "string",
    "portfolioId": "string",
    "source": "dataCleaning",
    "jobSummary": { … },
    "jobEnrichmentSettings": { … },
    "archived": true,
    "owningUserAccountStatus": "string"
  }
]