Skip to main content
GET
/
api
/
v1
/
{team_slug}
/
{app_slug}
/
organisations
/
{org_id}
Error
A valid request URL is required to generate request examples
{
  "data": {
    "app_id": "<string>",
    "attributes": [
      {
        "created_at": "<string>",
        "description": "<string>",
        "filterable": true,
        "id": "<string>",
        "key": "<string>",
        "name": "<string>",
        "template_key": "<string>",
        "template_name": "<string>",
        "translatable": true,
        "translations": {
          "description": [
            {
              "id": "<string>",
              "locale": "<string>",
              "omni_channel_translations": [
                {
                  "id": "<string>",
                  "market_id": "<string>",
                  "store_group_id": "<string>",
                  "value": "<string>"
                }
              ],
              "value": "<string>"
            }
          ],
          "name": [
            {
              "id": "<string>",
              "locale": "<string>",
              "omni_channel_translations": [
                {
                  "id": "<string>",
                  "market_id": "<string>",
                  "store_group_id": "<string>",
                  "value": "<string>"
                }
              ],
              "value": "<string>"
            }
          ]
        },
        "updated_at": "<string>",
        "values": {}
      }
    ],
    "billing_address": [
      {
        "city": "<string>",
        "co_address": "<string>",
        "company_id": "<string>",
        "company_name": "<string>",
        "country": "<string>",
        "created_at": "<string>",
        "house_number": "<string>",
        "id": "<string>",
        "is_default": true,
        "name": "<string>",
        "phone": "<string>",
        "postal_code": "<string>",
        "state_province": "<string>",
        "street_address": "<string>",
        "updated_at": "<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>",
    "phone": "<string>",
    "shipping_address": [
      {
        "city": "<string>",
        "co_address": "<string>",
        "company_id": "<string>",
        "company_name": "<string>",
        "country": "<string>",
        "created_at": "<string>",
        "house_number": "<string>",
        "id": "<string>",
        "is_default": true,
        "name": "<string>",
        "phone": "<string>",
        "postal_code": "<string>",
        "state_province": "<string>",
        "street_address": "<string>",
        "updated_at": "<string>"
      }
    ],
    "status": "<string>",
    "tags": [
      {
        "attributes": [
          {
            "created_at": "<string>",
            "description": "<string>",
            "filterable": true,
            "id": "<string>",
            "key": "<string>",
            "name": "<string>",
            "template_key": "<string>",
            "template_name": "<string>",
            "translatable": true,
            "translations": {
              "description": [
                {
                  "id": "<string>",
                  "locale": "<string>",
                  "omni_channel_translations": [
                    {
                      "id": "<string>",
                      "market_id": "<string>",
                      "store_group_id": "<string>",
                      "value": "<string>"
                    }
                  ],
                  "value": "<string>"
                }
              ],
              "name": [
                {
                  "id": "<string>",
                  "locale": "<string>",
                  "omni_channel_translations": [
                    {
                      "id": "<string>",
                      "market_id": "<string>",
                      "store_group_id": "<string>",
                      "value": "<string>"
                    }
                  ],
                  "value": "<string>"
                }
              ]
            },
            "updated_at": "<string>",
            "values": {}
          }
        ],
        "created_at": "<string>",
        "filterable": true,
        "id": "<string>",
        "key": "<string>",
        "markets": [
          {
            "active": true,
            "country_codes": [
              "<string>"
            ],
            "created_at": "<string>",
            "currency_code": "<string>",
            "id": "<string>",
            "locale": "<string>",
            "name": "<string>",
            "slug": "<string>",
            "updated_at": "<string>"
          }
        ],
        "name": "<string>",
        "schedules": [
          {
            "execute_at": "<string>",
            "finished_at": "<string>",
            "id": "<string>",
            "item_id": "<string>",
            "item_type": "<string>",
            "to_amount_cents_with_tax": 123,
            "to_on_sale": true,
            "to_sale_amount_cents_with_tax": 123,
            "to_status": "<string>"
          }
        ],
        "status": "<string>",
        "translations": {
          "name": [
            {
              "id": "<string>",
              "locale": "<string>",
              "omni_channel_translations": [
                {
                  "id": "<string>",
                  "market_id": "<string>",
                  "store_group_id": "<string>",
                  "value": "<string>"
                }
              ],
              "value": "<string>"
            }
          ]
        },
        "updated_at": "<string>"
      }
    ],
    "tax_id_vat_number": "<string>",
    "updated_at": "<string>",
    "users": [
      {
        "attributes": [
          {
            "created_at": "<string>",
            "description": "<string>",
            "filterable": true,
            "id": "<string>",
            "key": "<string>",
            "name": "<string>",
            "template_key": "<string>",
            "template_name": "<string>",
            "translatable": true,
            "translations": {
              "description": [
                {
                  "id": "<string>",
                  "locale": "<string>",
                  "omni_channel_translations": [
                    {
                      "id": "<string>",
                      "market_id": "<string>",
                      "store_group_id": "<string>",
                      "value": "<string>"
                    }
                  ],
                  "value": "<string>"
                }
              ],
              "name": [
                {
                  "id": "<string>",
                  "locale": "<string>",
                  "omni_channel_translations": [
                    {
                      "id": "<string>",
                      "market_id": "<string>",
                      "store_group_id": "<string>",
                      "value": "<string>"
                    }
                  ],
                  "value": "<string>"
                }
              ]
            },
            "updated_at": "<string>",
            "values": {}
          }
        ],
        "created_at": "<string>",
        "email": "<string>",
        "email_verified": true,
        "id": "<string>",
        "language": "<string>",
        "level": "<string>",
        "market": "<string>",
        "name": "<string>",
        "phone_number": "<string>",
        "role": "<string>",
        "store_group": "<string>",
        "surname": "<string>",
        "updated_at": "<string>"
      }
    ]
  },
  "details": [
    "<string>"
  ],
  "success": true
}

Path Parameters

app_slug
string
required

App slug

team_slug
string
required

Team slug

org_id
string
required

Organization ID

Response

Organization details

data
object
details
string[]

Other information which can be relative to the response. This field is used to give additional information then the main data we want to return. For instance if a product do not match the publishing rules will the product status be set to Incomplete and this field will include why

success
boolean