NAnationbuilder
Relationships

List all relationships in a nation

Changed on

Lists all relationships

get/api/v2/relationships

Request

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

Response

A page of matching relationships.

metaobject

Non-standard information about the document, such as requested statistics. Empty unless the endpoint has metadata to convey.

Example response

{
  "data": [
    {
      "id": "1",
      "type": "relationships",
      "attributes": {
        "first_signup_id": "1",
        "relationship_type": "member-organization",
        "second_signup_id": "2",
        "title": "Executive Assistant",
        "created_at": "2019-10-26T10:00:00-04:00",
        "updated_at": "2019-10-26T10:00:00-04:00"
      }
    }
  ],
  "links": {
    "self": "/articles?page[number]=2",
    "first": "/articles?page[number]=1",
    "last": "/articles?page[number]=5",
    "prev": "/articles?page[number]=1",
    "next": "/articles?page[number]=3"
  },
  "included": [
    {
      "id": "1"
    }
  ]
}

Changes

  • d5c88ca497acRevision 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

    • warning

      removed the optional 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