Introduction
Use this endpoint to get all the key information about a given service. A user can only get information on the services that user owns.
Request Lifecycle
To get the service information make a GET request to /api/connect/services/{id}. Path variable id is the connect identifier of the service. The response’s http status will be 200 upon successful retrieval.
Request Specifications
| Version | Header | Changes |
|---|---|---|
4 |
X-API-VERSION=4 |
|
5 |
X-API-VERSION=5 |
No change |
6 |
X-API-VERSION=6 |
No Change |
7 |
X-API-VERSION=7 |
No Change |
API Version 4, 5, 6 and 7
GET Request
Verb |
GET |
URI |
/api/connect/services/{id} |
Path Variable |
Purpose |
|
The id of the service resource |
| Name | Description |
|---|---|
|
The OAuth bearer access token |
|
The version of the endpoint you are accessing |
GET Response
| Status Code | Meaning |
|---|---|
200 |
The body contains the requested service resource |
401 |
Bearer token is missing or invalid |
400 |
The request was bad. Check the response body to see what the issue(s) are |
404 |
You do not have permission to perform this task. |
404 |
The id (of the service resource) provided does not exist. |
500 |
There was an unexpected error retrieving the results |
| Path | Type | Description |
|---|---|---|
|
|
Connect Service Id |
|
|
The reference string that you provided when you placed the order. |
|
|
Nbn Service activation date |
|
|
The type of nbn technology that the service is delivered through. |
|
|
The nbn traffic class, e.g. TC4 |
|
|
The nbn LOC ID of the address of the site the order is for. |
|
|
The AVC ID of the virtual circuit that is created for this service. This might not be set, depending on the site. |
|
|
The VLAN that was specified at order time. |
|
|
The code of the nbn POI that the site will be serviced from. |
|
|
The nbn region identifier that nbn places the site in. |
|
|
The level of restoration SLA that the service will have. Currently, only Standard is available. |
|
|
An object that contains details on the bandwidth profile that was selected for the service. |
|
|
The download speed of the service, in mbps. |
|
|
The upload speed of the service, in mbps. |
|
|
The name of the plan that was selected for the service. |
|
|
The CVC inclusion that is applied to CVC rebates, if applicable. |
|
|
Information about the infrastructure at the site, including NTDs and Copper Pairs. |
|
|
The nbn identifier of the equipment. |
|
|
The port on the device that was chosen for the service.Only for NTD infrastructure. |
|
|
The nbn identifier of the product component that is activated for the Customer. |
|
|
The address of the site where the service is being provided. |
|
|
The level that the site is on. |
|
|
The unit number of the site. |
|
|
The name of the building. |
|
|
The street number of the site. |
|
|
The name of the street, including street type. |
|
|
The suburb. |
|
|
The state. |
|
|
The postcode. |
|
|
The whole address, formatted in a single line. |
|
|
L2TP | ETHERNET |
|
|
The subscriber S Tag. Only set when aggregationMethod is ETHERNET |
|
|
The subscriber C Tag. Only set when aggregationMethod is ETHERNET |
|
|
Customer Label |
|
|
Service description |
|
|
Service reference |
|
|
The date/time, including UTC offset, when the service was cancelled (null if not cancelled) |
|
|
The name of the provider who cancelled the service. Possible values are: Superloop, Third Party or null (if not cancelled) |
|
|
Indicates whether the service is a nbn Co’s Fibre Access Service (NFAS) |
|
|
Indicates customer’s commitment not to cancel an NFAS service or downgrade service to a below minimum speed. True if applicable. False if not applicable/ commitment period expired / fee already charged. |
|
|
Indicates customer’s commitment for a period of time until when NFAS service cancellation/ plan downgrade charges are applicable. Only set where service is a nbn Co’s Fibre Access Service (NFAS) |
|
|
Legacy nbn technology type of the the service if the service is NFAS otherwise NULL |
|
|
Standard | Stable for FTTN and FTTB technology types otherwise NULL |
API Version 4, 5, 6 and 7 - Examples
Successful Request
GET /api/connect/services/305 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Host: 360-api.superloop.comHTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1270
{
"id" : 305,
"customerRef" : "Albany Creek Library",
"nbnServiceActivatedOn" : "2021-01-14T14:09:04Z",
"technologyType" : "FTTP",
"trafficClass" : "TC4",
"locId" : "LOC000000000305",
"avcId" : "AVC000000000305",
"vlanId" : "100",
"poi" : "4MKY Mackay",
"region" : "Urban",
"eSla" : "Standard",
"bandwidthProfile" : {
"speedDown" : 50,
"speedUp" : 20,
"planName" : null,
"cvcInclusion" : null
},
"infrastructure" : {
"id" : "NT000000000305",
"portId" : "2",
"productId" : "PRI000000000305"
},
"address" : {
"buildingLevel" : "Level 1",
"unitNumber" : "U5",
"buildingName" : "Building at 16",
"streetNumber" : "16",
"street" : "Ferguson Street",
"suburb" : "Albany Creek",
"state" : "Queensland",
"postcode" : "4035",
"formattedAddress" : "16 Ferguson St, Albany Creek QLD 4035, Australia"
},
"aggregationMethod" : "L2TP",
"subscriberSTag" : "142",
"subscriberCTag" : "141",
"customerLabel" : "8DRW - Darwin",
"description" : "Product 305",
"reference" : "25",
"cancelledOn" : null,
"cancelledBy" : null,
"dslStabilityProfile" : null,
"hasNfasCommitment" : false,
"nfasCommitmentExpiresOn" : null,
"legacyTechnologyType" : null,
"isNfas" : false
}GET /api/connect/services/350 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Host: 360-api.superloop.comHTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1309
{
"id" : 350,
"customerRef" : "Albany Creek Library",
"nbnServiceActivatedOn" : "2021-01-14T14:09:04Z",
"technologyType" : "FTTP",
"trafficClass" : "TC4",
"locId" : "LOC000004987436",
"avcId" : "AVC000113458055",
"vlanId" : "100",
"poi" : "4MKY Mackay",
"region" : "Urban",
"eSla" : "Standard",
"bandwidthProfile" : {
"speedDown" : 50,
"speedUp" : 20,
"planName" : "Home Fast 25/5",
"cvcInclusion" : 1.25
},
"infrastructure" : {
"id" : "NTD000033427450",
"portId" : "2",
"productId" : "PRI000215281910"
},
"address" : {
"buildingLevel" : "Level 1",
"unitNumber" : "U5",
"buildingName" : "Building at 16",
"streetNumber" : "16",
"street" : "Ferguson Street",
"suburb" : "Albany Creek",
"state" : "Queensland",
"postcode" : "4035",
"formattedAddress" : "16 Ferguson St, Albany Creek QLD 4035, Australia"
},
"aggregationMethod" : "L2TP",
"subscriberSTag" : "142",
"subscriberCTag" : "141",
"customerLabel" : "8DRW - Darwin",
"description" : "Product 350",
"reference" : "25",
"cancelledOn" : "2020-01-31T14:00:00Z",
"cancelledBy" : "Superloop",
"dslStabilityProfile" : null,
"hasNfasCommitment" : false,
"nfasCommitmentExpiresOn" : null,
"legacyTechnologyType" : "FTTN",
"isNfas" : true
}GET /api/connect/services/401 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Host: 360-api.superloop.comHTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1268
{
"id" : 401,
"customerRef" : "Northstar Medical Centre",
"nbnServiceActivatedOn" : "2021-01-14T14:09:04Z",
"technologyType" : "FTTB",
"trafficClass" : "TC4",
"locId" : "LOC000024942086",
"avcId" : "AVC000000000401",
"vlanId" : "100",
"poi" : "4BDB Bundamba",
"region" : "Urban",
"eSla" : "Enhanced - 12",
"bandwidthProfile" : {
"speedDown" : 50,
"speedUp" : 20,
"planName" : null,
"cvcInclusion" : null
},
"infrastructure" : {
"id" : "CPI000000000401",
"productId" : "PRI000000000401"
},
"address" : {
"buildingLevel" : "Level 1",
"unitNumber" : "U5",
"buildingName" : "Building at 16",
"streetNumber" : "16",
"street" : "Ferguson Street",
"suburb" : "Albany Creek",
"state" : "Queensland",
"postcode" : "4035",
"formattedAddress" : "16 Ferguson St, Albany Creek QLD 4035, Australia"
},
"aggregationMethod" : "L2TP",
"subscriberSTag" : "142",
"subscriberCTag" : "141",
"customerLabel" : "8DRW - Darwin",
"description" : "Product 401",
"reference" : "25",
"cancelledOn" : null,
"cancelledBy" : null,
"dslStabilityProfile" : "Standard",
"hasNfasCommitment" : false,
"nfasCommitmentExpiresOn" : null,
"legacyTechnologyType" : null,
"isNfas" : false
}GET /api/connect/services/400 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Host: 360-api.superloop.comHTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1293
{
"id" : 400,
"customerRef" : "Northstar Medical Centre",
"nbnServiceActivatedOn" : "2021-01-14T14:09:04Z",
"technologyType" : "FTTN",
"trafficClass" : "TC4",
"locId" : "LOC000024942086",
"avcId" : "AVC000000000400",
"vlanId" : "100",
"poi" : "4BDB Bundamba",
"region" : "Urban",
"eSla" : "Enhanced - 12",
"bandwidthProfile" : {
"speedDown" : 50,
"speedUp" : 20,
"planName" : null,
"cvcInclusion" : null
},
"infrastructure" : {
"id" : "CPI000000000400",
"productId" : "PRI000000000400"
},
"address" : {
"buildingLevel" : "Level 1",
"unitNumber" : "U5",
"buildingName" : "Building at 16",
"streetNumber" : "16",
"street" : "Ferguson Street",
"suburb" : "Albany Creek",
"state" : "Queensland",
"postcode" : "4035",
"formattedAddress" : "16 Ferguson St, Albany Creek QLD 4035, Australia"
},
"aggregationMethod" : "L2TP",
"subscriberSTag" : "142",
"subscriberCTag" : "141",
"customerLabel" : "8DRW - Darwin",
"description" : "Product 400",
"reference" : "25",
"cancelledOn" : "2020-01-31T14:00:00Z",
"cancelledBy" : "Superloop",
"dslStabilityProfile" : "Standard",
"hasNfasCommitment" : false,
"nfasCommitmentExpiresOn" : null,
"legacyTechnologyType" : null,
"isNfas" : false
}GET /api/connect/services/600 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Host: 360-api.superloop.comHTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1175
{
"id" : 600,
"customerRef" : "Albany Creek Library",
"nbnServiceActivatedOn" : "2021-01-14T14:09:04Z",
"technologyType" : null,
"trafficClass" : null,
"locId" : null,
"avcId" : null,
"vlanId" : null,
"poi" : null,
"region" : null,
"eSla" : null,
"bandwidthProfile" : {
"speedDown" : 50,
"speedUp" : 20,
"planName" : "Home Fast 25/5",
"cvcInclusion" : 1.25
},
"infrastructure" : null,
"address" : {
"buildingLevel" : "Level 1",
"unitNumber" : "U5",
"buildingName" : "Building at 16",
"streetNumber" : "16",
"street" : "Ferguson Street",
"suburb" : "Albany Creek",
"state" : "Queensland",
"postcode" : "4035",
"formattedAddress" : "16 Ferguson St, Albany Creek QLD 4035, Australia"
},
"aggregationMethod" : null,
"subscriberSTag" : null,
"subscriberCTag" : null,
"customerLabel" : "8DRW - Darwin",
"description" : "Product 300",
"reference" : "25",
"cancelledOn" : "2020-01-31T14:00:00Z",
"cancelledBy" : "Superloop",
"dslStabilityProfile" : null,
"hasNfasCommitment" : true,
"nfasCommitmentExpiresOn" : "2022-01-16",
"legacyTechnologyType" : null,
"isNfas" : true
}Unauthorized Request
GET /api/connect/services/300 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Host: 360-api.superloop.comHTTP/1.1 404 Not Found
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 189
{
"httpStatusCode" : 404,
"type" : "client.access",
"code" : "access.denied",
"message" : "Access Denied",
"apiSubErrors" : [ ],
"timestamp" : "2025-03-11T22:27:55.688497465Z"
}Service Not Found Request
GET /api/connect/services/500 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer **token**
X-API-VERSION: 7
Host: 360-api.superloop.comHTTP/1.1 404 Not Found
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 189
{
"httpStatusCode" : 404,
"type" : "client.access",
"code" : "access.denied",
"message" : "Access Denied",
"apiSubErrors" : [ ],
"timestamp" : "2025-03-11T22:28:00.384634175Z"
}