Skip to main content
GET
Returns all Gov Connect (HMRC) income submissions for a user

Authorizations

X-API-KEY
string
header
required

Path Parameters

user_id
string<uuid>
required

ID of the user to get Gov Connect income for

Query Parameters

offset
integer<int32>
default:0

The offset to start at

Required range: x >= 0
limit
integer<int32>
default:100

The number of items to return

Required range: x >= 1
account_id
string<uuid>

Filter submissions to a single account

entry_id
string<uuid>

Filter submissions to a single ingestion entry

created_after
string<date-time>

Filter out submissions dated before the given date

Example:

"2019-05-17T00:00:00.000Z"

created_before
string<date-time>

Filter out submissions dated after the given date

Example:

"2019-05-17T00:00:00.000Z"

Response

Gov Connect income response

pagination
object
required
gov_connect_submissions
object[]
required