Get Bulk Suppress Profiles Jobs

get https://a.klaviyo.com/api/profile-suppression-bulk-create-jobs/

🚧
This endpoint is in beta and subject to change.
A beta revision header (2024-07-15.pre) is required to use our beta APIs. Klaviyo APIs in beta are not intended for use in production. See our versioning and deprecation policy for more information.

Get the status of all bulk profile suppression jobs.

Rate limits:
Burst: 75/s
Steady: 700/m

Scopes:
subscriptions:read

Query Params

fields[profile-suppression-bulk-create-job]

array of strings

For more information please visit https://developers.klaviyo.com/en/v2024-07-15.pre/reference/api-overview#sparse-fieldsets

fields[profile-suppression-bulk-create-job]

filter

string

For more information please visit https://developers.klaviyo.com/en/v2024-07-15.pre/reference/api-overview#filtering
Allowed field(s)/operator(s):
status: equals
list_id: equals
segment_id: equals

page[cursor]

string

For more information please visit https://developers.klaviyo.com/en/v2024-07-15.pre/reference/api-overview#pagination

sort

string

For more information please visit https://developers.klaviyo.com/en/v2024-07-15.pre/reference/api-overview#sorting

Headers

revision

string

required

Defaults to 2024-07-15.pre

API endpoint revision (format: YYYY-MM-DD[.suffix])

Responses

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://a.klaviyo.com/api/profile-suppression-bulk-create-jobs/ \
3
     --header 'Authorization: Klaviyo-API-Key your-private-api-key' \
4
     --header 'accept: application/json' \
5
     --header 'revision: 2024-07-15.pre'


xxxxxxxxxx
40
}
1
{
2
  "data": [
3
    {
4
      "type": "profile-suppression-bulk-create-job",
5
      "id": "string",
6
      "attributes": {
7
        "status": "processing",
8
        "created_at": "2022-11-08T00:00:00+00:00",
9
        "total_count": 10,
10
        "completed_count": 9,
11
        "completed_at": "2022-11-08T00:00:00+00:00",
12
        "skipped_count": 1
13
      },
14
      "links": {
15
        "self": "string"
16
      },
17
      "relationships": {
18
        "lists": {
19
          "links": {
20
            "self": "string",
21
            "related": "string"
22
          }
23
        },
24
        "segments": {
25
          "links": {

200Success

4XXClient Error

5XXServer Error