Skip to main content
GET
/
companies
Retrieve Companies
curl --request GET \
  --url https://api.nuwebgroup.com/v1/partner/companies \
  --header 'Authorization: Bearer <token>' \
  --header 'X-NU-RESELLER-ID: <x-nu-reseller-id>'
{
  "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>"
            ],
            "performanceMode": 0,
            "dynamicMapsEnabled": 0,
            "customUrlsEnabled": 0,
            "timezone": "<string>",
            "trialExpiresAt": "<string>",
            "dashboardUrl": "<string>",
            "poweredBy": 0,
            "poweredByName": "<string>",
            "poweredByUrl": "<string>",
            "companyFromName": "<string>",
            "companyFromEmail": "<string>",
            "adminGoogleTagManagerCode": "<string>",
            "liveMode": 0,
            "business": {
              "name": "<string>",
              "email": "<string>",
              "website": "<string>",
              "phoneCode": "<string>",
              "phone": "<string>",
              "billingName": "<string>",
              "billingAddress": "<string>",
              "salesTaxNumber": "<string>",
              "defaultTaxBandId": 123
            },
            "api": {
              "accessType": 1,
              "rateLimit": 123
            },
            "sso": {
              "enabled": 0,
              "type": "<string>",
              "baseUrl": "<string>",
              "clientId": "<string>",
              "clientSecret": "<string>",
              "name": "<string>",
              "changeEmailUrl": "<string>",
              "changePasswordUrl": "<string>",
              "logoutUrl": "<string>"
            },
            "waitingRoom": {
              "enabled": 0,
              "userLimit": 123,
              "inactivityMins": 123,
              "maxHoldMins": 123
            }
          }
        ],
        "relationships": {}
      }
    ]
  },
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>",
    "self": "<string>"
  },
  "meta": {
    "total": 123
  }
}

Authorizations

​
Authorization
string
header
required

The 'Bearer' token can be obtained from the token management interface or via the login endpoint using your hub user credentials.

Headers

​
X-NU-RESELLER-ID
integer
required

The ID of the reseller this operation should be performed against.

Query Parameters

​
offset
integer

The starting position in the result set. e.g. 100 for the 100th record onwards. Offset will always take precedence over page.

​
page
integer

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.

​
limit
integer

The number of records you wish to retrieve per page.

​
only
string

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.

​
except
string

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.

​
withTrashed
enum<string>
default:false

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.

  • true to include deleted records
  • false to exclude deleted records (or leave blank)

Available options:
true,
false
​
liveMode
enum<string>

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.

Available options:
true,
false
​
parentId
integer

Filter companies by the given parent company ID.

​
groupByParent
enum<string>
default:false

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.

Available options:
true
​
include
enum<string>[]

A list of related resources you wish to include in the response. Values can be a url encoded array, or comma separated string.

Available options:
children,
countries,
currencies,
featureFlags,
fees,
gateways,
languages,
settings

Response

Successfully retrieved the companies.

​
data
object[]
​
included
object
​
links
object

These URLs can be used to navigate paginated requests.

​
meta
object