curl 'https://qa-super.mygigsters.com.au/v1/employees/6953947795fa599416406fc6' \
-u "apiUsername:apiPassword"
const response = await fetch("https://qa-super.mygigsters.com.au/v1/employees/6953947795fa599416406fc6", {
method: "GET",
headers: {
Authorization: "Basic " + Buffer.from("apiUsername:apiPassword").toString("base64"),
},
});
const data = await response.json();
console.log(data);
import requests
response = requests.get(
"https://qa-super.mygigsters.com.au/v1/employees/6953947795fa599416406fc6",
auth=("apiUsername", "apiPassword"),
)
print(response.json())
require "net/http"
require "json"
require "uri"
uri = URI("https://qa-super.mygigsters.com.au/v1/employees/6953947795fa599416406fc6")
request = Net::HTTP::Get.new(uri)
request.basic_auth("apiUsername", "apiPassword")
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
http.request(request)
end
puts JSON.parse(response.body)
<?php
$ch = curl_init("https://qa-super.mygigsters.com.au/v1/employees/6953947795fa599416406fc6");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_USERPWD => "apiUsername:apiPassword",
]);
$response = curl_exec($ch);
curl_close($ch);
print_r(json_decode($response, true));
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.Base64;
public class Example {
public static void main(String[] args) throws Exception {
String credentials = Base64.getEncoder()
.encodeToString("apiUsername:apiPassword".getBytes());
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://qa-super.mygigsters.com.au/v1/employees/6953947795fa599416406fc6"))
.header("Authorization", "Basic " + credentials)
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://qa-super.mygigsters.com.au/v1/employees/6953947795fa599416406fc6", nil)
if err != nil {
panic(err)
}
req.SetBasicAuth("apiUsername", "apiPassword")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
data, _ := io.ReadAll(res.Body)
fmt.Println(string(data))
}
using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://qa-super.mygigsters.com.au/v1/employees/6953947795fa599416406fc6");
request.Headers.Authorization = new AuthenticationHeaderValue(
"Basic", Convert.ToBase64String(Encoding.UTF8.GetBytes("apiUsername:apiPassword")));
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());
{
"id": "6953947795fa599416406fc6",
"clientId": "6944f5bc514fc0a1479bffdb",
"email": "lisa.purple@email.com",
"name": {
"firstName": "Lisa",
"lastName": "Brown"
},
"gender": "FEMALE",
"dob": {
"year": 1988,
"month": "DECEMBER",
"day": 13
},
"address": {
"australianAddress": {
"line1": "640 Gordon Street",
"line2": " ",
"line3": " ",
"line4": " ",
"suburb": "MANLY VALE",
"postCode": "2093",
"stateOrTerritory": "NSW",
"countryCode": "AU"
}
},
"taxFileNumber": "182134556",
"abn": "34623710896",
"usi": "BTA0287AU",
"memberNumber": "MEM1001",
"employmentPayrollNumber": "EMP-000123",
"mvrStatus": "VERIFIED",
"mvrStatusReason": "Member was successfully verified.",
"createdAt": "2025-12-30T08:59:35.138Z",
"updatedAt": "2025-12-30T08:59:35.138Z"
}
Employees
Get Employee by ID
Retrieves employee information by UUID. Returns all static employee data stored in the database.
GET
/
v1
/
employees
/
{employeeId}
curl 'https://qa-super.mygigsters.com.au/v1/employees/6953947795fa599416406fc6' \
-u "apiUsername:apiPassword"
const response = await fetch("https://qa-super.mygigsters.com.au/v1/employees/6953947795fa599416406fc6", {
method: "GET",
headers: {
Authorization: "Basic " + Buffer.from("apiUsername:apiPassword").toString("base64"),
},
});
const data = await response.json();
console.log(data);
import requests
response = requests.get(
"https://qa-super.mygigsters.com.au/v1/employees/6953947795fa599416406fc6",
auth=("apiUsername", "apiPassword"),
)
print(response.json())
require "net/http"
require "json"
require "uri"
uri = URI("https://qa-super.mygigsters.com.au/v1/employees/6953947795fa599416406fc6")
request = Net::HTTP::Get.new(uri)
request.basic_auth("apiUsername", "apiPassword")
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
http.request(request)
end
puts JSON.parse(response.body)
<?php
$ch = curl_init("https://qa-super.mygigsters.com.au/v1/employees/6953947795fa599416406fc6");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_USERPWD => "apiUsername:apiPassword",
]);
$response = curl_exec($ch);
curl_close($ch);
print_r(json_decode($response, true));
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.Base64;
public class Example {
public static void main(String[] args) throws Exception {
String credentials = Base64.getEncoder()
.encodeToString("apiUsername:apiPassword".getBytes());
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://qa-super.mygigsters.com.au/v1/employees/6953947795fa599416406fc6"))
.header("Authorization", "Basic " + credentials)
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://qa-super.mygigsters.com.au/v1/employees/6953947795fa599416406fc6", nil)
if err != nil {
panic(err)
}
req.SetBasicAuth("apiUsername", "apiPassword")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
data, _ := io.ReadAll(res.Body)
fmt.Println(string(data))
}
using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://qa-super.mygigsters.com.au/v1/employees/6953947795fa599416406fc6");
request.Headers.Authorization = new AuthenticationHeaderValue(
"Basic", Convert.ToBase64String(Encoding.UTF8.GetBytes("apiUsername:apiPassword")));
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());
{
"id": "6953947795fa599416406fc6",
"clientId": "6944f5bc514fc0a1479bffdb",
"email": "lisa.purple@email.com",
"name": {
"firstName": "Lisa",
"lastName": "Brown"
},
"gender": "FEMALE",
"dob": {
"year": 1988,
"month": "DECEMBER",
"day": 13
},
"address": {
"australianAddress": {
"line1": "640 Gordon Street",
"line2": " ",
"line3": " ",
"line4": " ",
"suburb": "MANLY VALE",
"postCode": "2093",
"stateOrTerritory": "NSW",
"countryCode": "AU"
}
},
"taxFileNumber": "182134556",
"abn": "34623710896",
"usi": "BTA0287AU",
"memberNumber": "MEM1001",
"employmentPayrollNumber": "EMP-000123",
"mvrStatus": "VERIFIED",
"mvrStatusReason": "Member was successfully verified.",
"createdAt": "2025-12-30T08:59:35.138Z",
"updatedAt": "2025-12-30T08:59:35.138Z"
}
Use Case
- Verify employee information before submitting contributions
- Retrieve employee details for display in UI
- Validate employee exists before contribution submission
Request Parameters
string
required
Employee ID
Responses
| Code | Description |
|---|---|
200 | Employee retrieved successfully |
401 | Unauthorized - Invalid authentication credentials |
404 | Employee not found |
Response fields
string
Employee ID
string
Client ID that this employee belongs to
string
Employee email address (optional)
object
Employee name
Show properties
Show properties
string
First or given name of the fund member as registered with their superannuation fund. Must match the name on the member’s fund account for successful contribution allocation.
string
Last name or surname of the fund member as registered with their superannuation fund. Must match exactly for the contribution to be successfully allocated.
string
Employee gender. Valid values: NOT_STATED, MALE, FEMALE, INDETERMINATE
object
Date of birth. The member must be at least 18 years old. Day must be between 1 and 31.
Show properties
Show properties
number
Birth year (4 digits). Used along with month and day to verify member identity with the fund. Members must be at least 18 years old.
string
Birth month as a full month name (uppercase). Must match the member’s date of birth registered with their fund.
number
Birth day of the month. Must be between 1 and 31. Ensure this matches the fund’s records for successful member identification.
object
Employee address
Show properties
Show properties
object
Australian residential address of the fund member. Used for member identification and correspondence if needed.
string
Tax File Number (TFN)
string
Unique Superannuation Identifier (USI) for the employee’s chosen super fund/product. Used when building validation and submission payloads to Superannuation clearing house.
string
Member number issued by the superannuation fund for this employee. Sent in the Superannuation clearing house member payload to help the fund match contributions. Must not contain blanks (e.g., ’ ’) or special characters. Only alphanumeric characters are allowed.
string
Employment / payroll number used by the employer to identify this employee in payroll systems. Passed through as employmentPayrollNumber to Superannuation clearing house.
string
Australian Business Number (ABN) for the employee (typically contractors). Stored for reference only and not sent to Superannuation clearing house APIs. Must be exactly 11 digits, numeric characters only, first digit cannot be zero. Can be presented with or without spaces (e.g., ‘34623710896’ or ‘34 623 710 896’).
string
Latest Member Verification Request (MVR) outcome for this employee’s current fund identity, if a verification has been run. One of PENDING, VERIFIED, WARNING, REJECTED, TIMED_OUT, NOT_APPLICABLE, NOT_SUPPORTED, NOT_CHECKED. Only ever set on employees created or updated through the Employees v2 endpoints — see the MVR Verification page (/mvr) for what each value means for payment eligibility.
string
Human-readable reason or description accompanying the current mvrStatus, if any.
string
Created timestamp
string
Updated timestamp
Error response fields
Error response fields
boolean
Always false for error responses, indicating the operation did not succeed.
integer
HTTP status code indicating the type of error. Common values: 400 (Bad Request), 401 (Unauthorized), 404 (Not Found), 500 (Server Error)
string
Human-readable error message explaining what went wrong. May include specific details about which field or value caused the error.
integer
Superannuation clearing house-specific error code for programmatic error handling. Refer to the error code reference documentation for a complete list of codes. Common codes: 4030 (Employer not found), 4031 (Invalid ABN), 4040 (Fund not found).
curl 'https://qa-super.mygigsters.com.au/v1/employees/6953947795fa599416406fc6' \
-u "apiUsername:apiPassword"
const response = await fetch("https://qa-super.mygigsters.com.au/v1/employees/6953947795fa599416406fc6", {
method: "GET",
headers: {
Authorization: "Basic " + Buffer.from("apiUsername:apiPassword").toString("base64"),
},
});
const data = await response.json();
console.log(data);
import requests
response = requests.get(
"https://qa-super.mygigsters.com.au/v1/employees/6953947795fa599416406fc6",
auth=("apiUsername", "apiPassword"),
)
print(response.json())
require "net/http"
require "json"
require "uri"
uri = URI("https://qa-super.mygigsters.com.au/v1/employees/6953947795fa599416406fc6")
request = Net::HTTP::Get.new(uri)
request.basic_auth("apiUsername", "apiPassword")
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
http.request(request)
end
puts JSON.parse(response.body)
<?php
$ch = curl_init("https://qa-super.mygigsters.com.au/v1/employees/6953947795fa599416406fc6");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_USERPWD => "apiUsername:apiPassword",
]);
$response = curl_exec($ch);
curl_close($ch);
print_r(json_decode($response, true));
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.Base64;
public class Example {
public static void main(String[] args) throws Exception {
String credentials = Base64.getEncoder()
.encodeToString("apiUsername:apiPassword".getBytes());
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://qa-super.mygigsters.com.au/v1/employees/6953947795fa599416406fc6"))
.header("Authorization", "Basic " + credentials)
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://qa-super.mygigsters.com.au/v1/employees/6953947795fa599416406fc6", nil)
if err != nil {
panic(err)
}
req.SetBasicAuth("apiUsername", "apiPassword")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
data, _ := io.ReadAll(res.Body)
fmt.Println(string(data))
}
using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://qa-super.mygigsters.com.au/v1/employees/6953947795fa599416406fc6");
request.Headers.Authorization = new AuthenticationHeaderValue(
"Basic", Convert.ToBase64String(Encoding.UTF8.GetBytes("apiUsername:apiPassword")));
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());
{
"id": "6953947795fa599416406fc6",
"clientId": "6944f5bc514fc0a1479bffdb",
"email": "lisa.purple@email.com",
"name": {
"firstName": "Lisa",
"lastName": "Brown"
},
"gender": "FEMALE",
"dob": {
"year": 1988,
"month": "DECEMBER",
"day": 13
},
"address": {
"australianAddress": {
"line1": "640 Gordon Street",
"line2": " ",
"line3": " ",
"line4": " ",
"suburb": "MANLY VALE",
"postCode": "2093",
"stateOrTerritory": "NSW",
"countryCode": "AU"
}
},
"taxFileNumber": "182134556",
"abn": "34623710896",
"usi": "BTA0287AU",
"memberNumber": "MEM1001",
"employmentPayrollNumber": "EMP-000123",
"mvrStatus": "VERIFIED",
"mvrStatusReason": "Member was successfully verified.",
"createdAt": "2025-12-30T08:59:35.138Z",
"updatedAt": "2025-12-30T08:59:35.138Z"
}
Last modified on November 10, 2026
Was this page helpful?