GetSubmissionsResponsePaginatedResponse

The response object for paginated API requests.

metadata
Type: object · PaginationMetadata
- limit
  Type: integer Format: int32
  
  Gets or sets the limit used in the original request.
- links
  Type: object · Links
  
  Navigation links in the paginated response.
- offset
  Type: integer Format: int32
  
  Gets or sets the offset used in the original request.
- total
  Type: integer Format: int32
  
  Gets or sets the total number of records in the results set.
results
Type: array object[] | null · GetSubmissionsResponse[]

Gets or sets the results set.
Response object for retrieving a submission
- accountType
  Type: string enum
  
  The type of account to be created
  
  values
  Individual
  Joint
  Company
  IndividualSuperannuation
  CompanySuperannuation
  IndividualTrust
  CompanyTrust
- adviserCode
  Type: string
  
  The Adviser Code provided by Openmarkets to identify the adviser this account gets assigned to
- branchId
  Type: string
  
  The Branch Id provided by Openmarkets
- brokerageCode
  Type: string
  
  The Brokerage Code provided by Openmarkets to set the default brokerage schedule for this account
- createdAtUtc
  Type: string Format: date-time
  
  Date and time the submission is created
- id
  Type: string Format: uuid
- organisationCode
  Type: string
  
  The Organisation Code provided by Openmarkets to identify the client this account belongs to
- referenceId
  Type: string | null
  
  An optional external ReferenceId to link this submission to your system
- status
  Type: string enum
  
  Status of the submission
  
  values
  Pending
  SolvingIssues
  Completed
  Cancelled
- updatedAtUtc
  Type: string Format: date-time
  
  Date and time of the most recent update of the submission

Examples

{
  "metadata": {
    "links": {
      "self": "https://api.openmarkets.com.au/v1/accounts/submissions?limit=10&offset=0",
      "next": "https://api.openmarkets.com.au/v1/accounts/submissions?limit=10&offset=10",
      "previous": null
    },
    "limit": 10,
    "offset": 0,
    "total": 17
  },
  "results": [
    {
      "id": "8f2b6c14-9d0a-4e35-b7c8-2a1f5d3e7b46",
      "organisationCode": "TPUAT",
      "adviserCode": "UAT",
      "brokerageCode": "NIL",
      "branchId": "UA",
      "status": "Pending",
      "referenceId": "CRM-4821",
      "accountType": "Individual",
      "createdAtUtc": "2025-06-11T23:45:12Z",
      "updatedAtUtc": "2025-06-12T01:03:58Z"
    },
    {
      "id": "3c7d9e02-41ab-4f68-8d55-6b90c2e4a173",
      "organisationCode": "TPUAT",
      "adviserCode": "UAT",
      "brokerageCode": "NIL",
      "branchId": "UA",
      "status": "Completed",
      "referenceId": "CRM-4822",
      "accountType": "Joint",
      "createdAtUtc": "2025-05-02T01:19:44Z",
      "updatedAtUtc": "2025-05-06T22:31:09Z"
    }
  ]
}