Accounts Report

The Accounts API allows organizations to retrieve the list of their active business accounts (individual accounts representing specific organizational units) or fetch details of a specific business account.

How it works

List All Accounts

Send an HTTP GET request to 1GLOBAL to get a list of all business accounts associated with the organization.

GET  https://api.1global.com/enterprise/accounts

The header should contain the URL, Request Access Token, and content-type as shown below:

curl -X GET \
  https://api.1global.com/enterprise/accounts \
   -H 'Authorization: Bearer $ACCESS_TOKEN' \
   -H 'Content-Type: application/json' 

Example Response Body

A successful request returns an HTTP status 200 and a response body that includes a list of all active accounts, along with details such as Id, name, country, and status.

{
    "_links": {
        "next": {
            "href": "https://api.1global.com/enterprise/accounts?cursor=1&limit=10"
        }
    },
    "_embedded": {
        "accounts": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.1global.com/enterprise/accounts/acc_045EAABBCCDD746VVV"
                    }
                },
                "id": "acc_045EAABBCCDD746VVV",
                "name": "ABC Europe Limited",
                "country": "GB",
                "status": "active"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.1global.com/enterprise/accounts/acc_045EXXYYZZZ746XXX"
                    }
                },
                "id": "acc_045EXXYYZZZ746XXX",
                "name": "ABC Luxembourg Branch",
                "country": "NL",
                "status": "active"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.1global.com/enterprise/accounts/acc_045EEENNNDDD746YYY"
                    }
                },
                "id": "acc_045EEENNNDDD746YYY",
                "name": "ABC – Paris Branch",
                "country": "FR",
                "status": "active"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.1global.com/enterprise/accounts/acc_045JJJUUUFFF746RRR"
                    }
                },
                "id": "acc_045JJJUUUFFF746RRR",
                "name": "ABC - Amsterdam Branch",
                "country": "NL",
                "status": "active"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.1global.com/enterprise/accounts/acc_045AAAHHHXXXFF746NNN"
                    }
                },
                "id": "acc_045AAAHHHXXXFF746NNN",
                "name": "ABC - Hong Kong Branch",
                "country": "HK",
                "status": "active"
            }
        ]
    }
}

Continue navigating through the next links in the response until you have reviewed all your accounts. Refer Standards - Pagination for more information on pagination.

NOTE: The query parameter limit determines the number of accounts to be reflected in the response. The default limit is 10 to prevent the response from becoming too large, override this value if required.

Query Single Account

Retrieves a single business account and their details by the account's Id.

GET  https://api.1global.com/enterprise/accounts/{acc_id}

The header should contain the endpoint URL along with the account Id, Request Access Token, and content-type as shown below:

curl -X GET \
  https://api.1global.com/enterprise/accounts/acc_016X8YW9MRS87V6X6N7X0B32JM \
   -H 'Authorization: Bearer $ACCESS_TOKEN' \
   -H 'Content-Type: application/json' 

Example Response Body

A successful request returns an HTTP status 200 and a response body containing information about the specified account.

{
    "_links": {
        "self": {
            "href": "https://api.1global.com/enterprise/accounts/acc_045EAABBCCDD746VVV"
        }
    },
    "id": "acc_045EAABBCCDD746VVV",
    "name": "ABC, N.A. - LONDON BRANCH",
    "country": "GB",
    "status": "active"
}