Get an Organization

GET

/api/organizations/{key}

Organization endpoint provides access to information about organizations, including their names, contact information, and structures. It is a top-level entity in the system, available for systems that support a multi-organizational structure.

Request

Authorization

Path Params

Responses

🟢200

application/json

Successful operation

Body

Response Example

{
    "data": {
        "key": "04000168880208",
        "currencyKey": "03000501450871",
        "name": "string",
        "code": "38660955",
        "description": "Praesentium sit non ad unde.",
        "addresses": [
            {
                "country": "string",
                "addressLines": "string",
                "addressee": "string",
                "state": "string",
                "city": "string",
                "postCode": "string",
                "phone": "string",
                "email": "string",
                "notes": "string",
                "isActive": "false",
                "createdAt": "2010-12-18T22:12:19Z",
                "updatedAt": "1991-11-21T03:23:33Z"
            }
        ],
        "billingAddress": {
            "country": "string",
            "addressLines": "string",
            "addressee": "string",
            "state": "string",
            "city": "string",
            "postCode": "string",
            "phone": "string",
            "email": "string",
            "notes": "string",
            "isActive": "false",
            "createdAt": "2025-03-18T05:37:12Z",
            "updatedAt": "2022-02-12T00:03:54Z"
        },
        "contacts": [
            {
                "name": "string",
                "position": "string",
                "phones": "string",
                "emails": "string",
                "isActive": "false",
                "isDefault": "false"
            }
        ],
        "createdAt": "2024-10-19T08:18:39Z",
        "updatedAt": "1980-11-03T16:19:10Z",
        "deletedAt": "1998-04-09T01:01:04Z"
    }
}

Modified at 2026-03-19 15:49:21

List Organization

Create a Passthrough