Officers stream

This stream will return information about company officers.

Request

GET https://stream.companieshouse.gov.uk/officers

Query parameters

Parameter name Value Description Additional
timepoint integer

By default a stream will deliver data events as they happen after a connection is established. Clients can request that the stream delivers data events starting some time in the past, by specifying a timepoint on connection. Valid timepoint values are provided or given by the last stream event received before a client disconnects. In the future data snapshots will be available.

Authorisation

This request requires the use of one of following authorisation methods: API key .

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

Connection established to stream. Responses will be returned one-per-line.

 officersStream
401 Unauthorized

Client is not authorised to connect to this stream.
416 Requested Range Not Satisfiable

The specified timepoint is invalid or too old.
429 Too Many Requests

Client has been rate-limited.