GET
Check for data refresh
Any signed-in account For: Integrator Conditions
  • Requires a selected profile in the session for a member, or an agent account session.
What else happens
  • Creates the refresh record of the actor on first call (one record per actor), with an empty meta_data. Later calls return the same record.
Part of Your account and notifications.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, actor_type, actor_id, meta_data, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Response

200 - application/json

Resource.

id

Identifier of the refresh record (27-character KSUID).

actor_type

Kind of actor owning the record: the alias of a user profile assignment or of an agent account.

actor_id

Identifier of the assignment or agent account (27-character KSUID).

meta_data
any[]

List of refresh keys the actor has already read. Keys are removed when the server invalidates them, and the list is emptied when an agent account signs in or a person switches profile. Empty list when nothing is read.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).