Organisations
Get organisation tree
Get the tree of organisations that the requested organisation is part of
GET
/
api
/
v1
/
{app_id}
/
organisations
/
{id}
/
tree
Error
A valid request URL is required to generate request examples{
"ancestors": [
{
"app_id": "<string>",
"comment": "<string>",
"contact_name": "<string>",
"created_at": "<string>",
"credit_check": true,
"custom_fields": {},
"email": "<string>",
"external_ref": "<string>",
"id": "<string>",
"invoice_email": "<string>",
"name": "<string>",
"organisation_number": "<string>",
"parent_id": "<string>",
"phone": "<string>",
"status": "<string>",
"tax_id_vat_number": "<string>",
"updated_at": "<string>"
}
],
"company_tree": {
"app_id": "<string>",
"children": "<array>",
"comment": "<string>",
"contact_name": "<string>",
"created_at": "<string>",
"credit_check": true,
"custom_fields": {},
"email": "<string>",
"external_ref": "<string>",
"id": "<string>",
"invoice_email": "<string>",
"name": "<string>",
"organisation_number": "<string>",
"parent_id": "<string>",
"phone": "<string>",
"status": "<string>",
"tax_id_vat_number": "<string>",
"updated_at": "<string>"
}
}{
"details": [
"<string>"
],
"message": "<string>",
"success": true
}{
"details": [
"<string>"
],
"message": "<string>",
"success": true
}{
"details": [
"<string>"
],
"message": "<string>",
"success": true
}Previous
List users for an organisationGet a paginated list of users belonging to a specific organisation with optional search on first_name, last_name, and email.
Next
⌘I
Error
A valid request URL is required to generate request examples{
"ancestors": [
{
"app_id": "<string>",
"comment": "<string>",
"contact_name": "<string>",
"created_at": "<string>",
"credit_check": true,
"custom_fields": {},
"email": "<string>",
"external_ref": "<string>",
"id": "<string>",
"invoice_email": "<string>",
"name": "<string>",
"organisation_number": "<string>",
"parent_id": "<string>",
"phone": "<string>",
"status": "<string>",
"tax_id_vat_number": "<string>",
"updated_at": "<string>"
}
],
"company_tree": {
"app_id": "<string>",
"children": "<array>",
"comment": "<string>",
"contact_name": "<string>",
"created_at": "<string>",
"credit_check": true,
"custom_fields": {},
"email": "<string>",
"external_ref": "<string>",
"id": "<string>",
"invoice_email": "<string>",
"name": "<string>",
"organisation_number": "<string>",
"parent_id": "<string>",
"phone": "<string>",
"status": "<string>",
"tax_id_vat_number": "<string>",
"updated_at": "<string>"
}
}{
"details": [
"<string>"
],
"message": "<string>",
"success": true
}{
"details": [
"<string>"
],
"message": "<string>",
"success": true
}{
"details": [
"<string>"
],
"message": "<string>",
"success": true
}