Skip to main content
POST
/
api
/
v1
/
:app_id
/
auth
/
login
Error
A valid request URL is required to generate request examples
{
  "access_token": "<string>",
  "expires_in": 123,
  "refresh_token": "<string>",
  "token_type": "<string>",
  "user": {
    "additions": {},
    "address": {
      "city": "<string>",
      "country": "<string>",
      "country_code": "<string>",
      "street": "<string>",
      "zip_code": "<string>"
    },
    "app_id": "<string>",
    "attributes": [
      {
        "description": "<string>",
        "id": "<string>",
        "key": "<string>",
        "name": "<string>",
        "template_key": "<string>",
        "translations": {
          "description": {},
          "name": {}
        },
        "values": {}
      }
    ],
    "communication_preferences": {
      "allow_email": true,
      "allow_postal": true,
      "allow_sms": true
    },
    "created_at": "<string>",
    "email": "<string>",
    "email_verified": true,
    "files": [
      {
        "app_id": "<string>",
        "content_type": "<string>",
        "created_at": "<string>",
        "custom_fields": {},
        "filename": "<string>",
        "id": "<string>",
        "updated_at": "<string>",
        "url": "<string>"
      }
    ],
    "first_name": "<string>",
    "id": "<string>",
    "is_super_admin": true,
    "language": "<string>",
    "last_login_at": "<string>",
    "last_name": "<string>",
    "market": "<string>",
    "market_currency": "<string>",
    "market_id": "<string>",
    "organisations": [
      {
        "app_id": "<string>",
        "attributes": [
          {
            "description": "<string>",
            "id": "<string>",
            "key": "<string>",
            "name": "<string>",
            "template_key": "<string>",
            "translations": {
              "description": {},
              "name": {}
            },
            "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>",
            "shipping_type": "<string>",
            "state_province": "<string>",
            "street_address": "<string>",
            "updated_at": "<string>"
          }
        ],
        "contact_name": "<string>",
        "created_at": "<string>",
        "credit_check": true,
        "custom_fields": {},
        "email": "<string>",
        "external_ref": "<string>",
        "files": [
          {
            "app_id": "<string>",
            "content_type": "<string>",
            "created_at": "<string>",
            "custom_fields": {},
            "filename": "<string>",
            "id": "<string>",
            "updated_at": "<string>",
            "url": "<string>"
          }
        ],
        "id": "<string>",
        "invoice_email": "<string>",
        "level": "<string>",
        "name": "<string>",
        "organisation_number": "<string>",
        "phone": "<string>",
        "role": "<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>",
            "shipping_type": "<string>",
            "state_province": "<string>",
            "street_address": "<string>",
            "updated_at": "<string>"
          }
        ],
        "status": "<string>",
        "store_groups": [
          {
            "country_of_sale": "<string>",
            "created_at": "<string>",
            "description": "<string>",
            "id": "<string>",
            "name": "<string>",
            "slug": "<string>",
            "store_type": "<string>",
            "updated_at": "<string>"
          }
        ],
        "tags": [
          {
            "id": "<string>",
            "key": "<string>",
            "name": "<string>"
          }
        ],
        "tax_id_vat_number": "<string>",
        "updated_at": "<string>"
      }
    ],
    "phone_number": "<string>",
    "status": "<string>",
    "store_group": "<string>",
    "store_group_id": "<string>",
    "tags": [
      {
        "id": "<string>",
        "key": "<string>",
        "name": "<string>"
      }
    ],
    "updated_at": "<string>"
  }
}

Path Parameters

app_id
string
required

UUID of the app

Body

application/json

Login credentials

email
string
required
password
string
required
Minimum string length: 10

Response

OK

access_token
string
expires_in
integer
refresh_token
string
token_type
string
user
object