Skip to content

Profiles API

Get a profile import job

GEThttps://email.growthdept.ai/api/profile-bulk-import-jobs/{job_id}

Rate limits

Burst: 10/s

Steady: 150/m

Tier M. See rate limits for how requests are counted.

Scopes

lists:readprofiles:read

Operation id

get_bulk_import_profiles_job The same operation as in Klaviyo's API. OpenAPI document

Path parameters

stringrequired

Query parameters

array of strings

Attributes of list resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

array of strings

Attributes of profile-bulk-import-job resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

array of strings

Related resources to side-load.

Includes guide

Pick values to add them to the request:

Headers

stringrequireddefault 2026-10-15

API revision, YYYY-MM-DD. This server implements 2026-10-15.

Revisions guide

Responses

200Success

Response body

object

  • dataobjectrequired

    data: 5 fields
    • typestringrequired

      profile-bulk-import-job
    • idstringrequired

    • attributesobjectrequired

      attributes: 8 fields
      • statusstringrequired

        cancelledcompleteprocessingqueued
      • created_atstring (date-time)required

      • total_countintegerrequired

      • completed_countintegercan be null

      • failed_countintegercan be null

      • completed_atstring (date-time)can be null

      • expires_atstring (date-time)can be null

      • started_atstring (date-time)can be null

    • relationshipsobject

      relationships: 3 fields
      • listsobject

        lists: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            list
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • profilesobject

        profiles: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            profile
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • import-errorsobject

        import-errors: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            import-error
          • idstringrequired

        • linksobject

          links: 1 field
          • relatedstring (uri)required

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

  • includedarray of objects

    included: 5 fields
    • typestringrequired

      list
    • idstringrequired

    • attributesobjectrequired

      attributes: 4 fields
      • namestringcan be null

      • createdstring (date-time)can be null

      • updatedstring (date-time)can be null

      • opt_in_processstringcan be null

        double_opt_insingle_opt_in
    • relationshipsobject

      relationships: 3 fields
      • profilesobject

        profiles: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            profile
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • tagsobject

        tags: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            tag
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • flow-triggersobject

        flow-triggers: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            flow
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

  • linksobject

    links: 1 field
    • selfstring (uri)required

  • metaobject

4XXClient error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject

See status codes for each code.

5XXServer error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject