Identity: changes

What has happened since a cursor, waiting up to 25 seconds for it to

GET /v1/identities/{slug}/changes · operation watchChanges

Requires the batondeck:messages:read permission (action message:read).

Parameters

Name	In	Type	Required	Notes
slug	path	string	yes
since	query	integer	yes	cursor from a previous answer; 0 starts from now with no backlog
wait	query	integer	yes	seconds to wait for something to happen, from 1 to 25

Responses

Status	Meaning
200	What has happened since a cursor, waiting up to 25 seconds for it to
400	The arguments did not validate.
401	No portal session, and no live API key.
403	The policy refused, or the request was cross-site.
404	No such resource, or none this session may see.

200 response schema

{
  "type": "object",
  "properties": {
    "cursor": {
      "type": "number"
    },
    "threads": {
      "type": "array",
      "items": {
        "type": "object",
        "propertyNames": {
          "type": "string"
        },
        "additionalProperties": {}
      }
    },
    "contact_requests": {
      "type": "number"
    },
    "contact_requests_new": {
      "type": "number"
    },
    "pending_requests": {
      "type": "number"
    },
    "pending_requests_new": {
      "type": "number"
    },
    "calls": {
      "type": "array",
      "items": {
        "type": "object",
        "propertyNames": {
          "type": "string"
        },
        "additionalProperties": {}
      }
    },
    "needs_attention": {
      "type": "array",
      "items": {
        "type": "object",
        "propertyNames": {
          "type": "string"
        },
        "additionalProperties": {}
      }
    },
    "calls_truncated": {
      "type": "boolean"
    },
    "timed_out": {
      "type": "boolean"
    }
  },
  "required": [
    "cursor",
    "threads",
    "contact_requests",
    "contact_requests_new",
    "pending_requests",
    "pending_requests_new",
    "calls",
    "needs_attention",
    "calls_truncated",
    "timed_out"
  ],
  "additionalProperties": false
}

curl -X GET 'https://api.batondeck.com/v1/identities/:slug/changes' \
  -H "Authorization: Bearer $BATONDECK_API_KEY"