Partner Management

APIs related to managing partner organisations and users

List Partner Organisations

get

Retrieve a list of all partner organisations with optional pagination

Authorizations

bearerAuth

AuthorizationstringRequired

To create a Bearer token, see How to get an OAuth Bearer Token?.

Usage format: Bearer <token>

Query parameters

limitintegerOptional

Maximum number of items to return

Responses

200

OK

application/json

queryMorestringOptional

Token for next page of results

401

Unauthorized

application/json

get

/partner-organisations

HTTPcURLJavaScriptPython

GET /api/partner-organisations HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "text",
      "name": "text",
      "data": {
        "zuoraAccountId": "text",
        "isZuoraInvoiceOwner": true,
        "salesforceAccountId": "text",
        "logo": "https://example.com"
      },
      "record_type": "partner_org",
      "service": "limio",
      "created": "2026-02-19T19:15:28.784Z",
      "modified": "2026-02-19T19:15:28.784Z"
    }
  ],
  "queryMore": "text"
}

Create Partner Organisation

post

Create a new partner organisation

Authorizations

bearerAuth

AuthorizationstringRequired

To create a Bearer token, see How to get an OAuth Bearer Token?.

Usage format: Bearer <token>

Body

application/json

namestringRequired

Organisation name

zuoraAccountIdstringRequired

Associated Zuora account ID

isZuoraInvoiceOwnerbooleanRequired

Whether this organisation owns Zuora invoices

salesforceAccountIdstringOptional

Associated Salesforce account ID

logostring · uriOptional

Organisation logo URL

Responses

200

Created

application/json

idstringOptional

Unique identifier for the partner organisation

namestringOptional

Organisation name

record_typestring · enumOptionalPossible values:

servicestringOptionalExample: limio

createdstring · date-timeOptional

modifiedstring · date-timeOptional

401

Unauthorized

application/json

post

/partner-organisation

HTTPcURLJavaScriptPython

POST /api/partner-organisation HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "name": "text",
  "zuoraAccountId": "text",
  "isZuoraInvoiceOwner": true,
  "salesforceAccountId": "text",
  "logo": "https://example.com"
}

{
  "id": "text",
  "name": "text",
  "data": {
    "zuoraAccountId": "text",
    "isZuoraInvoiceOwner": true,
    "salesforceAccountId": "text",
    "logo": "https://example.com"
  },
  "record_type": "partner_org",
  "service": "limio",
  "created": "2026-02-19T19:15:28.784Z",
  "modified": "2026-02-19T19:15:28.784Z"
}

Create Partner User

post

Create a new user for a specific partner organisation

Authorizations

bearerAuth

AuthorizationstringRequired

To create a Bearer token, see How to get an OAuth Bearer Token?.

Usage format: Bearer <token>

Path parameters

partnerOrganisationIdstringRequired

Partner organisation ID

Body

application/json

emailstring · emailRequired

User email address

Responses

200

Created

application/json

idstringOptional

Unique identifier for the partner user

namestringOptional

User identifier (typically email)

partner_orgstringOptional

Associated partner organisation ID

record_typestring · enumOptionalPossible values:

servicestringOptionalExample: limio

createdstring · date-timeOptional

modifiedstring · date-timeOptional

401

Unauthorized

application/json

post

/partner-organisation/{partnerOrganisationId}

HTTPcURLJavaScriptPython

POST /api/partner-organisation/{partnerOrganisationId} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "email": "[email protected]"
}

{
  "id": "text",
  "name": "text",
  "data": {
    "email": "[email protected]"
  },
  "partner_org": "text",
  "record_type": "partner_user",
  "service": "limio",
  "created": "2026-02-19T19:15:28.784Z",
  "modified": "2026-02-19T19:15:28.784Z"
}

Update Partner Organisation

put

Update an existing partner organisation's details

Authorizations

bearerAuth

AuthorizationstringRequired

To create a Bearer token, see How to get an OAuth Bearer Token?.

Usage format: Bearer <token>

Path parameters

partnerOrganisationIdstringRequired

Partner organisation ID

Body

application/json

zuoraAccountIdstringOptional

Associated Zuora account ID

isZuoraInvoiceOwnerbooleanOptional

Whether this organisation owns Zuora invoices

salesforceAccountIdstringOptional

Associated Salesforce account ID

logostring · uriOptional

Organisation logo URL

Responses

200

Updated

application/json

idstringOptional

Unique identifier for the partner organisation

namestringOptional

Organisation name

record_typestring · enumOptionalPossible values:

servicestringOptionalExample: limio

createdstring · date-timeOptional

modifiedstring · date-timeOptional

401

Unauthorized

application/json

put

/partner-organisation/{partnerOrganisationId}

HTTPcURLJavaScriptPython

PUT /api/partner-organisation/{partnerOrganisationId} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 110

{
  "zuoraAccountId": "text",
  "isZuoraInvoiceOwner": true,
  "salesforceAccountId": "text",
  "logo": "https://example.com"
}

{
  "id": "text",
  "name": "text",
  "data": {
    "zuoraAccountId": "text",
    "isZuoraInvoiceOwner": true,
    "salesforceAccountId": "text",
    "logo": "https://example.com"
  },
  "record_type": "partner_org",
  "service": "limio",
  "created": "2026-02-19T19:15:28.784Z",
  "modified": "2026-02-19T19:15:28.784Z"
}

Delete Partner Organisation

delete

Delete a partner organisation and all associated users

Authorizations

bearerAuth

AuthorizationstringRequired

To create a Bearer token, see How to get an OAuth Bearer Token?.

Usage format: Bearer <token>

Path parameters

partnerOrganisationIdstringRequired

Partner organisation ID

Responses

200

Deleted

application/json

successbooleanOptionalExample: true

401

Unauthorized

application/json

delete

/partner-organisation/{partnerOrganisationId}

HTTPcURLJavaScriptPython

DELETE /api/partner-organisation/{partnerOrganisationId} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true
}

List Partner Users for Organisation

get

Retrieve all users associated with a specific partner organisation

Authorizations

bearerAuth

AuthorizationstringRequired

To create a Bearer token, see How to get an OAuth Bearer Token?.

Usage format: Bearer <token>

Path parameters

partnerOrganisationIdstringRequired

Partner organisation ID

Responses

200

OK

application/json

queryMorestringOptional

Token for next page of results

401

Unauthorized

application/json

get

/partner-organisation/{partnerOrganisationId}/users

HTTPcURLJavaScriptPython

GET /api/partner-organisation/{partnerOrganisationId}/users HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "text",
      "name": "text",
      "data": {
        "email": "[email protected]"
      },
      "partner_org": "text",
      "record_type": "partner_user",
      "service": "limio",
      "created": "2026-02-19T19:15:28.784Z",
      "modified": "2026-02-19T19:15:28.784Z"
    }
  ],
  "queryMore": "text"
}

Delete Partner User

delete

Delete a specific user from a partner organisation

Authorizations

bearerAuth

AuthorizationstringRequired

To create a Bearer token, see How to get an OAuth Bearer Token?.

Usage format: Bearer <token>

Path parameters

partnerOrganisationIdstringRequired

Partner organisation ID

partnerUserIdstringRequired

Partner user ID

Responses

200

Deleted

application/json

successbooleanOptionalExample: true

401

Unauthorized

application/json

delete

/partner-organisation/{partnerOrganisationId}/{partnerUserId}

HTTPcURLJavaScriptPython

DELETE /api/partner-organisation/{partnerOrganisationId}/{partnerUserId} HTTP/1.1
Host: your-environment.prod.limio.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true
}