NAnationbuilder
Automation Enrollments

Show automation enrollments with provided ID

Changed on

Returns the automation enrollments that matches the given ID.

get/api/v2/automation_enrollments/{id}

Request

  • Base URL
    https://yournation.nationbuilder.com
  • Auth
    HTTP bearer

Query parameters

includeAutomationEnrollmentSideloadValues[]

Comma-delimited list of sideloaded resources to include as part of the automation enrollment response. See guidance here about sideloading large numbers of resources and pagination.

fields[automation_enrollments]AutomationEnrollmentFieldValues[]

Comma-delimited list of automation enrollment attributes to only return in the response

Response

The requested automation enrollment.

metaobject

Non-standard information about the document. Empty unless the endpoint has metadata to convey.

Example response

{
  "data": {
    "id": "1",
    "type": "automation_enrollments",
    "attributes": {
      "automation_id": "1",
      "campaign_source": "Campaign Source",
      "campaign_url": "https://www.example.com",
      "signup_id": "1",
      "automation_step_number": 1,
      "created_at": "2019-10-26T10:00:00-04:00",
      "excluded_at": "2019-10-26T10:00:00-04:00",
      "next_execution": "2019-10-26T10:00:00-04:00"
    }
  },
  "included": [
    {
      "id": "1"
    }
  ]
}

Changes

  • d5c88ca497acRevision changes
    • breaking

      for the query request parameter fields[automation_enrollments], default value was added

    • breaking

      for the query request parameter include, default value was added

    • breaking

      for the query request parameter fields[automation_enrollments], the type changed from string to array

    • breaking

      for the query request parameter include, the type changed from string to array

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • info

      added subschema #2 to the response body allOf list for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status