Signups

Show signup assigned to auth token

Changed on

Returns the signup associated with the current access token.

get/api/v2/signups/me

Request

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

Response

The current signup.

metaobject

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

Example response

{
  "data": {
    "id": "1",
    "type": "signups",
    "attributes": {
      "author_id": "1",
      "availability": "Saturday morning",
      "banned_at": "2019-10-26T10:00:00-04:00",
      "born_at": "1990-08-06",
      "capital_amount_in_cents": 500,
      "church": "Unity Church",
      "city_district": "Trinity-Spadina (19)",
      "city_sub_district": "DOWNTOWN LOS ANGELES",
      "civicrm_id": "1",
      "contact_status": "answered",
      "could_vote_status": 1,
      "county_district": "City of Portsmouth (B)",
      "county_file_id": "1",
      "custom_values": {
        "custom_text": "Text Value",
        "custom_number": "22",
        "custom_checkbox": true,
        "custom_multi": "Some multiple choice option"
      },
      "datatrust_id": "1",
      "demo": "H",
      "donations_amount_in_cents": 500,
      "donations_amount_this_cycle_in_cents": 500,
      "donations_count": 5,
      "donations_count_this_cycle": 5,
      "donations_pledged_amount_in_cents": 500,
      "donations_raised_amount_in_cents": 500,
      "donations_raised_amount_this_cycle_in_cents": 500,
      "donations_raised_count": 5,
      "donations_raised_count_this_cycle": 5,
      "donations_to_raise_amount_in_cents": 500,
      "dw_id": "1",
      "email": "test@example.com",
      "email1": "example@example.com",
      "email2": "example@example.com",
      "email3": "example@example.com",
      "email4": "example@example.com",
      "employer": "NationBuilder",
      "ethnicity": "Hawaiian",
      "external_id": "1",
      "fax_number": "1234567890",
      "federal_district": "Congressional District 40",
      "fire_district": "Jackson",
      "first_donated_at": "2019-10-26T10:00:00-04:00",
      "first_fundraised_at": "2019-10-26T10:00:00-04:00",
      "first_name": "Lucy",
      "first_prospect_at": "2019-10-26T10:00:00-04:00",
      "first_recruited_at": "2019-10-26T10:00:00-04:00",
      "first_supporter_at": "2019-10-26T10:00:00-04:00",
      "first_volunteer_at": "2019-10-26T10:00:00-04:00",
      "import_id": "1",
      "inferred_party": "P",
      "inferred_support_level": 1,
      "judicial_district": "1",
      "labour_region": "1",
      "language": "EN",
      "last_call_id": "1",
      "last_contacted_at": "2019-10-26T10:00:00-04:00",
      "last_contacted_by_id": "1",
      "last_donated_at": "2019-10-26T10:00:00-04:00",
      "last_fundraised_at": "2019-10-26T10:00:00-04:00",
      "last_name": "Butler",
      "last_rule_violation_at": "2019-10-26T10:00:00-04:00",
      "legal_name": "Lucy Octavia Butler",
      "locale": "en",
      "marital_status": "S",
      "middle_name": "Octavia",
      "mobile_number": "1234567890",
      "ngp_id": "1",
      "note": "Good talk",
      "occupation": "Software engineer",
      "parent_id": "1",
      "party": "P",
      "pf_strat_id": "1",
      "phone_number": "1234567890",
      "phone_time": "7:00pm",
      "precinct_id": "1",
      "prefix": "Dr.",
      "previous_party": "D",
      "primary_email_id": 1,
      "priority_level": 1,
      "profile_content": "Profile content",
      "profile_headline": "My Profile",
      "received_capital_amount_in_cents": 500,
      "recruiter_id": "1",
      "registered_at": "2022-06-01",
      "religion": "Internet",
      "rnc_id": "1",
      "rnc_regid": "1",
      "rule_violations_count": 5,
      "salesforce_id": "1",
      "school_district": "1",
      "school_sub_district": "1",
      "sex": "F",
      "signup_type": 1,
      "spent_capital_amount_in_cents": 500,
      "state_file_id": "1",
      "state_lower_district": "Assembly District 35",
      "state_upper_district": "State Senate District 19",
      "submitted_address": "123 Test Drive, Los Angeles, CA",
      "suffix": "Jr.",
      "support_level": 1,
      "supranational_district": "London Euro Region",
      "township": "Van Buren",
      "unsubscribed_at": "2019-10-26T10:00:00-04:00",
      "username": "username",
      "van_id": "1",
      "village_district": "1",
      "ward": "1",
      "warnings_count": 5,
      "work_phone_number": "1234567890",
      "created_at": "2019-10-26T10:00:00-04:00",
      "full_name": "Lucy Octavia Butler",
      "note_updated_at": "2019-10-26T10:00:00-04:00",
      "priority_level_changed_at": "2019-10-26T10:00:00-04:00",
      "profile_content_html": "<h1>My Profile</h1>",
      "support_level_changed_at": "2019-10-26T10:00:00-04:00",
      "updated_at": "2019-10-26T10:00:00-04:00"
    }
  },
  "included": [
    {
      "id": "1"
    }
  ]
}

Changes

    • 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