Get group invoice details

GET https://api.zenoti.com/v1/group_invoices/{group_invoice_id}

This API provides details of group invoices.

Before you begin

Permission: Manage API Keys (on the Administrator security object) — Required to access Zenoti APIs.

Endpoint

GET /v1/group_invoices/{group_invoice_id}

Base URL: https://api.zenoti.com

Request

Headers

Header Required Description
Authorization Yes bearer {{access_token}}

Path parameters

Parameter Type Required Description
group_invoice_id string Yes Represents the group invoice identifier

Response

Success (200 OK)

{
  "group_invoice": {
    "id": "d7890b60-a99a-411d-9111-6c4e6d9a2d83",
    "is_surprise": false,
    "invoices": [
      {
        "...": "..."
      }
    ]
  },
  "error": {}
}

Response fields

Field Type Description
group_invoice object
group_invoice.id string
group_invoice.is_surprise boolean
group_invoice.invoices object[]
error object

Example

curl --request GET \
  --url 'https://api.zenoti.com/v1/group_invoices/{group_invoice_id}' \
  --header 'Authorization: bearer {{access_token}}'
const response = await fetch('https://api.zenoti.com/v1/group_invoices/{group_invoice_id}', {
  method: 'GET',
  headers: {
    'Authorization': 'bearer {{access_token}}'
  },
});
const data = await response.json();
import requests

response = requests.get(
    'https://api.zenoti.com/v1/group_invoices/{group_invoice_id}',
    headers={
        'Authorization': 'bearer {{access_token}}',
    },
)
data = response.json()
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "bearer {{access_token}}");
var response = await client.GetAsync(
    "https://api.zenoti.com/v1/group_invoices/{group_invoice_id}");
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'

uri = URI('https://api.zenoti.com/v1/group_invoices/{group_invoice_id}')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'bearer {{access_token}}'
response = http.request(request)
data = JSON.parse(response.body)

Error codes

Status Description
400 400
401 401
429 Too many requests -- rate limit exceeded