curl --request GET \
--url https://api.nuwebgroup.com/v1/partner/companies \
--header 'Authorization: Bearer <token>' \
--header 'X-NU-RESELLER-ID: <x-nu-reseller-id>'import requests
url = "https://api.nuwebgroup.com/v1/partner/companies"
headers = {
"X-NU-RESELLER-ID": "<x-nu-reseller-id>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-NU-RESELLER-ID': '<x-nu-reseller-id>', Authorization: 'Bearer <token>'}
};
fetch('https://api.nuwebgroup.com/v1/partner/companies', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.nuwebgroup.com/v1/partner/companies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"X-NU-RESELLER-ID: <x-nu-reseller-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.nuwebgroup.com/v1/partner/companies"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-NU-RESELLER-ID", "<x-nu-reseller-id>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.nuwebgroup.com/v1/partner/companies")
.header("X-NU-RESELLER-ID", "<x-nu-reseller-id>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nuwebgroup.com/v1/partner/companies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-NU-RESELLER-ID"] = '<x-nu-reseller-id>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": 123,
"type": "companies",
"attributes": {
"name": "Global ticket company",
"alias": "globalticketcompany",
"createdAt": "2023-01-01T13:57:01.000000Z",
"updatedAt": "2023-01-01T13:57:01.000000Z",
"deletedAt": null
},
"relationships": {
"countries": [
{
"id": 123,
"type": "countries"
}
],
"currencies": [
{
"id": 123,
"type": "currencies"
}
],
"featureFlags": [
{
"id": 123,
"type": "featureFlags"
}
],
"fees": [
{
"id": 123,
"type": "fees"
}
],
"gateways": [
{
"id": 123,
"type": "gateways"
}
],
"languages": [
{
"id": 123,
"type": "languages"
}
],
"companySettings": [
{
"id": 123,
"type": "companySettings"
}
]
}
}
],
"included": {
"children": [
{
"id": 123,
"type": "companies",
"attributes": [
{
"name": "Global ticket company",
"alias": "globalticketcompany",
"createdAt": "2023-01-01T13:57:01.000000Z",
"updatedAt": "2023-01-01T13:57:01.000000Z",
"deletedAt": null
}
],
"relationships": {}
}
],
"countries": [
{
"id": 123,
"type": "<string>",
"attributes": [
{
"name": "United Kingdom",
"iso": "GB",
"iso3": "GBR",
"phoneCode": 44
}
],
"relationships": {}
}
],
"currencies": [
{
"id": 123,
"type": "<string>",
"attributes": [
{
"name": "Dollars",
"code": "USD",
"symobol": "$",
"subunit": 2,
"isPrimary": true,
"isCashless": false,
"isCustom": false
}
],
"relationships": {}
}
],
"featureFlags": [
{
"id": 123,
"type": "<string>",
"attributes": [
{
"feature": 6,
"name": "Seating Plans",
"slug": "seating_plans",
"description": "Enabling seating plans will allow users to create small or large seating plans for the events in their company.",
"isLimitation": false,
"context": 2
}
],
"relationships": {}
}
],
"fees": [
{
"id": 123,
"type": "<string>",
"attributes": [
{
"currencyId": 1,
"type": 1,
"rangeMin": 1,
"rangeMax": null,
"salesPointTypeId": 1,
"percent": "2.4000",
"fixed": 25,
"min": null,
"max": null,
"blendedReseller": false,
"createdAt": "2023-01-01T10:22:57.000000Z",
"updatedAt": "2023-01-01T10:22:57.000000Z"
}
],
"relationships": {}
}
],
"gateways": [
{
"id": 123,
"type": "<string>",
"attributes": [
{
"name": "Stripe",
"slug": "stripe",
"enabledInBoxOffice": true,
"enabledInShop": true,
"isPrimary": true,
"isPrimaryBoxOffice": true,
"isPrimaryShop": true
}
],
"relationships": {}
}
],
"languages": [
{
"id": 123,
"type": "<string>",
"attributes": [
{
"name": "English",
"locale": "en",
"isFallback": true
}
],
"relationships": {}
}
],
"companySettings": [
{
"id": 123,
"type": "<string>",
"attributes": [
{
"copyEventsLimit": 123,
"basketSizeLimit": 123,
"eventTimeslotsLimit": 123,
"sendEventCreationNotification": true,
"eventCreationEmails": [
"<string>"
],
"timezone": "<string>",
"trialExpiresAt": "<string>",
"dashboardUrl": "<string>",
"poweredByName": "<string>",
"poweredByUrl": "<string>",
"companyFromName": "<string>",
"companyFromEmail": "<string>",
"companyReplyToEmail": "<string>",
"adminGoogleTagManagerCode": "<string>",
"business": {
"name": "<string>",
"email": "<string>",
"website": "<string>",
"phoneCode": "<string>",
"phone": "<string>",
"billingName": "<string>",
"billingAddress": "<string>",
"salesTaxNumber": "<string>",
"defaultTaxBandId": 123
},
"api": {
"rateLimit": 123
},
"sso": {
"type": "<string>",
"baseUrl": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"name": "<string>",
"changeEmailUrl": "<string>",
"changePasswordUrl": "<string>",
"logoutUrl": "<string>"
},
"waitingRoom": {
"userLimit": 123,
"inactivityMins": 123,
"maxHoldMins": 123
}
}
],
"relationships": {}
}
]
},
"links": {
"first": "<string>",
"last": "<string>",
"prev": "<string>",
"next": "<string>",
"self": "<string>"
},
"meta": {
"total": 123
}
}{
"message": "Unauthenticated."
}{
"message": "This action is unauthorized."
}{
"message": "No query results for model [ModelName]."
}{
"message": "The given data was invalid.",
"errors": {
"field_name": [
"The field_name field is required"
]
}
}{
"message": "No query results for model [ModelName]."
}Retrieve Companies
This endpoint can be used to return a list of companies for the given reseller.
curl --request GET \
--url https://api.nuwebgroup.com/v1/partner/companies \
--header 'Authorization: Bearer <token>' \
--header 'X-NU-RESELLER-ID: <x-nu-reseller-id>'import requests
url = "https://api.nuwebgroup.com/v1/partner/companies"
headers = {
"X-NU-RESELLER-ID": "<x-nu-reseller-id>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-NU-RESELLER-ID': '<x-nu-reseller-id>', Authorization: 'Bearer <token>'}
};
fetch('https://api.nuwebgroup.com/v1/partner/companies', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.nuwebgroup.com/v1/partner/companies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"X-NU-RESELLER-ID: <x-nu-reseller-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.nuwebgroup.com/v1/partner/companies"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-NU-RESELLER-ID", "<x-nu-reseller-id>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.nuwebgroup.com/v1/partner/companies")
.header("X-NU-RESELLER-ID", "<x-nu-reseller-id>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nuwebgroup.com/v1/partner/companies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-NU-RESELLER-ID"] = '<x-nu-reseller-id>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": 123,
"type": "companies",
"attributes": {
"name": "Global ticket company",
"alias": "globalticketcompany",
"createdAt": "2023-01-01T13:57:01.000000Z",
"updatedAt": "2023-01-01T13:57:01.000000Z",
"deletedAt": null
},
"relationships": {
"countries": [
{
"id": 123,
"type": "countries"
}
],
"currencies": [
{
"id": 123,
"type": "currencies"
}
],
"featureFlags": [
{
"id": 123,
"type": "featureFlags"
}
],
"fees": [
{
"id": 123,
"type": "fees"
}
],
"gateways": [
{
"id": 123,
"type": "gateways"
}
],
"languages": [
{
"id": 123,
"type": "languages"
}
],
"companySettings": [
{
"id": 123,
"type": "companySettings"
}
]
}
}
],
"included": {
"children": [
{
"id": 123,
"type": "companies",
"attributes": [
{
"name": "Global ticket company",
"alias": "globalticketcompany",
"createdAt": "2023-01-01T13:57:01.000000Z",
"updatedAt": "2023-01-01T13:57:01.000000Z",
"deletedAt": null
}
],
"relationships": {}
}
],
"countries": [
{
"id": 123,
"type": "<string>",
"attributes": [
{
"name": "United Kingdom",
"iso": "GB",
"iso3": "GBR",
"phoneCode": 44
}
],
"relationships": {}
}
],
"currencies": [
{
"id": 123,
"type": "<string>",
"attributes": [
{
"name": "Dollars",
"code": "USD",
"symobol": "$",
"subunit": 2,
"isPrimary": true,
"isCashless": false,
"isCustom": false
}
],
"relationships": {}
}
],
"featureFlags": [
{
"id": 123,
"type": "<string>",
"attributes": [
{
"feature": 6,
"name": "Seating Plans",
"slug": "seating_plans",
"description": "Enabling seating plans will allow users to create small or large seating plans for the events in their company.",
"isLimitation": false,
"context": 2
}
],
"relationships": {}
}
],
"fees": [
{
"id": 123,
"type": "<string>",
"attributes": [
{
"currencyId": 1,
"type": 1,
"rangeMin": 1,
"rangeMax": null,
"salesPointTypeId": 1,
"percent": "2.4000",
"fixed": 25,
"min": null,
"max": null,
"blendedReseller": false,
"createdAt": "2023-01-01T10:22:57.000000Z",
"updatedAt": "2023-01-01T10:22:57.000000Z"
}
],
"relationships": {}
}
],
"gateways": [
{
"id": 123,
"type": "<string>",
"attributes": [
{
"name": "Stripe",
"slug": "stripe",
"enabledInBoxOffice": true,
"enabledInShop": true,
"isPrimary": true,
"isPrimaryBoxOffice": true,
"isPrimaryShop": true
}
],
"relationships": {}
}
],
"languages": [
{
"id": 123,
"type": "<string>",
"attributes": [
{
"name": "English",
"locale": "en",
"isFallback": true
}
],
"relationships": {}
}
],
"companySettings": [
{
"id": 123,
"type": "<string>",
"attributes": [
{
"copyEventsLimit": 123,
"basketSizeLimit": 123,
"eventTimeslotsLimit": 123,
"sendEventCreationNotification": true,
"eventCreationEmails": [
"<string>"
],
"timezone": "<string>",
"trialExpiresAt": "<string>",
"dashboardUrl": "<string>",
"poweredByName": "<string>",
"poweredByUrl": "<string>",
"companyFromName": "<string>",
"companyFromEmail": "<string>",
"companyReplyToEmail": "<string>",
"adminGoogleTagManagerCode": "<string>",
"business": {
"name": "<string>",
"email": "<string>",
"website": "<string>",
"phoneCode": "<string>",
"phone": "<string>",
"billingName": "<string>",
"billingAddress": "<string>",
"salesTaxNumber": "<string>",
"defaultTaxBandId": 123
},
"api": {
"rateLimit": 123
},
"sso": {
"type": "<string>",
"baseUrl": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"name": "<string>",
"changeEmailUrl": "<string>",
"changePasswordUrl": "<string>",
"logoutUrl": "<string>"
},
"waitingRoom": {
"userLimit": 123,
"inactivityMins": 123,
"maxHoldMins": 123
}
}
],
"relationships": {}
}
]
},
"links": {
"first": "<string>",
"last": "<string>",
"prev": "<string>",
"next": "<string>",
"self": "<string>"
},
"meta": {
"total": 123
}
}{
"message": "Unauthenticated."
}{
"message": "This action is unauthorized."
}{
"message": "No query results for model [ModelName]."
}{
"message": "The given data was invalid.",
"errors": {
"field_name": [
"The field_name field is required"
]
}
}{
"message": "No query results for model [ModelName]."
}Authorizations
The 'Bearer' token can be obtained from the token management interface or via the login endpoint using your hub user credentials.
Headers
The ID of the reseller this operation should be performed against.
Query Parameters
The starting position in the result set. e.g. 100 for the 100th record onwards. Offset will always take precedence over page.
The page you wish to retrieve records for, using the default pagination page length. You can only paginate by page if no offset is given.
The number of records you wish to retrieve per page.
A list of attributes that you wish to be returned in the payload. When empty or omitted, all fields will be included by default. Use dot-notation for both top-level resources and child resources, i.e. resource.attribute,includedResource.attribute. Can be used in conjunction with except providing both parameters don't reference the same resource.
A list of attributes that you wish to exclude from the payload. When empty or omitted, all fields will be included by default. Use dot-notation for both top-level resources and child resources, i.e. resource.attribute,includedResource.attribute. Can be used in conjunction with only providing both parameters don't reference the same resource.
Controls records returned depending on their deletedAt status. This is a global flag, so will apply to all resources, including relationships such as resources returned under the included attribute.
trueto include deleted recordsfalseto exclude deleted records (or leave blank)
true, false Filter companies by only those in live mode, or those in demo mode. If no filter is secified, both live and demo companies will be returned.
true, false Filter companies by the given parent company ID.
Returns only parent companies in the top level data. The children include may be used in conjunction with this parameter to get a nested relation of child companies per parent.
true A list of related resources you wish to include in the response. Values can be a url encoded array, or comma separated string.
children, countries, currencies, featureFlags, fees, gateways, languages, settings 