The Revisions endpoint is an extension of the Posts endpoint. However Revisions are read only so the only allowed method is GET.

GET posts/:post_id/revisions

Listing all posts

METHOD: GET
ENDPOINT: /api/v2/posts/:post_id/revisions/
AUTHENTICATED: No

Query Parameters

Name

Type

Description

q

Optional

Only Posts containing this search string will be returned, matched against post title and content

type

Optional

Only posts of this type will be returned: report, revision, comment or alert

localeOptionalOnly posts with matching locale will be returned

slug

Optional

Only posts with a matching slug will be returned

form_id

Optional

Only posts with this form_id will be returned

user_id

Optional

Only posts created by this user_id will be returned

created_before

Optional

Returned posts will have a created date smaller than this date

created_after

Optional

Returned posts will have a created date greater than this date

updated_before

Optional

Returned posts will have an updated date smaller than this date

updated_after

Optional

Returned posts will have an updated date greater than this date

order

Optional

Returned posts will be sorted in this order: ASC or DESC. Default: DESC

order_by

Optional

Returned posts will be sorted by this field. Default: created

limit

Optional

Limit number of results returned. Default: 50. Max: 500

offset

Optional

Posts returned will be offset by this number of results

Posts can also be filtered by form attributes by using the attribute as a parameter. ie

GET /api/v2/posts/1/revisions?full_name=David
Example Request

GET https://ushv3.dev/api/v2/posts/1/revisions

{
    "count": 2,
    "results": [
        {
          "id":5,
          "url":"http://ushv3.dev/api/v2/posts/1/revisions/6",
          "form":{
            "id":1,
            "url":"http://ushv3.dev/api/v2/forms/1",
          },
          "parent":{
              "id":1,
              "url":"http://ushv3.dev/api/v2/posts/1"
          },
          "locale":"en_US",
          "type":"translation",
          "title":"David is Missing",
          "status":"publish",
          "content":"Disheveled, skinny, homeless Kenyan last seen in the vicinity of the greyhound station",
          "values":{
            "full_name":"David Kobia",
            "description":"Skinny, homeless Kenyan last seen in the vicinity of the greyhound station",
            "dob":"unknown",
            "missing_date":"2012/09/25",
            "last_location":"atlanta",
            "status":"missing"
          },
          "tags":["missing"]
        },
        {
          "id":6,
          "url":"http://ushv3.dev/api/v2/posts/1/revisions/5",
          "form":{
            "id":1,
            "url":"http://ushv3.dev/api/v2/forms/1",
          },
          "parent":{
              "id":1,
              "url":"http://ushv3.dev/api/v2/posts/1"
          },
          "locale":"fr_FR",
          "type":"translation",
          "title":"David est manquant",
          "status":"publish",
          "content":"Disheveled, maigre, sans-abri Kenyan vu la dernière fois dans le voisinage de la station lévrier",
          "values":{
            "full_name":"David Kobia",
            "description":"maigre, sans-abri Kenyan vu la dernière fois dans le voisinage de la station lévrier",
            "dob":"unknown",
            "missing_date":"2012/09/25",
            "last_location":"atlanta",
            "status":"missing"
          },
          "tags":["missing","manquant"]
        }
    ],
	"limit": 50,
    "offset": 0,
    "order": "ASC",
    "orderby": "created",
    "curr": "https://ushv3.dev/api/v2/posts/1/revisions?limit=50&offset=0",
    "next": "https://ushv3.dev/api/v2/posts/1/revisions?limit=50&offset=50",
    "prev": "https://ushv3.dev/api/v2/posts/1/revisions?limit=50&offset=0"
}

GET posts/:post_id/revisions/:id

Get a single post

METHOD: GET
ENDPOINT: /api/v2/posts/:post_id/revisions/:id
AUTHENTICATED: Yes

Query Parameters

Name

Type

Description

id

Required

The numerical id of the post being updated.

Example Request

GET http://ushv3.dev/api/v2/posts/1/revisions/5

{
	"id":5,
	"url":"http://ushv3.dev/api/v2/posts/1/revisions/5",
	"form":{
		"id":1,
		"url":"http://ushv3.dev/api/v2/forms/1",
	},
	"parent":{
		"id":1,
		"url":"http://ushv3.dev/api/v2/posts/1"
	},
	"locale":"en_US",
	"type":"translation",
	"title":"David is Missing [RESOLVED: NOW FOUND]",
	"status":"publish",
	"content":"Disheveled, skinny, homeless Kenyan last seen in the vicinity of the greyhound station. Found in Nairobi",
	"values":{
		"full_name":"David Kobia",
		"description":"Skinny, homeless Kenyan last seen in the vicinity of the greyhound station",
		"dob":"unknown",
		"missing_date":"2012/09/25",
		"last_location":"Nairobi",
		"status":"found"
	},
	"tags":["found"]
}