Skip to main content
Skip table of contents

Organisation

Organisation

Organisation APIs expose information about the account hierarchy, organisation details, and identifiers used across the SFT platform.

These identifiers are referenced by several other APIs (Enterprise, Endpoint, Plan assignment, etc.).

Account access

  • Reseller: Yes

  • Enterprise: Yes (own organisation only)


GET Organisation Details

Endpoint

CODE
GET /api/GetOrganisation

Headers

CODE
Content-Type: application/json
X-Requested-With: XMLHttpRequest
X-Authorization: Bearer <AccessToken>

Query parameters

Parameter

Mandatory

Description

organisationId

No

Fetch a specific organisation (reseller-only / hierarchy view)

Response (selected)

Returned under responseParam.rows[]:

Field

Description

organisationId

Organisation / account id

organisationName

Organisation name

organisationType

Reseller / Enterprise

parentOrganisationId

Parent organisation id (if applicable)

status

Organisation status

Result codes (selected)

Code

Description

1801

Get organisation success

1802

Get organisation failure

1359

No data available


Notes

  • Resellers can view child organisations using this API

  • Enterprise users can retrieve their own organisation details

  • Organisation identifiers appear across the platform in:

    • Enterprise APIs

    • Endpoint APIs

    • Reporting and usage queries


Cross-API parameter sourcing

  • organisationId: via GET Organisation

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.