NAnationbuilder
Sites

List all sites in a nation

Changed on

Lists all sites

get/api/v2/sites

Request

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

Query parameters

includestring

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

Supported sideloads: (none)

fields[sites]SiteFieldValues[]

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

page[number]string

Page number to list (starting at 1)

page[size]string

Number of results to display per page (default: 20, max: 100, min: 1)

Response

A page of matching sites.

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": "sites",
      "attributes": {
        "domain": "example-site.com",
        "name": "My Website",
        "slug": "example-slug"
      }
    }
  ],
  "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

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

    • breaking

      for the query request parameter include, default value was added

    • breaking

      for the query request parameter page[number], default value 1 was added

    • breaking

      for the query request parameter page[size], default value 20 was added

    • breaking

      for the query request parameter fields[sites], 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

    • 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