ReDoc documentation

customers/companies

customers/companies

Returns the list of company customer attributes.

Request
query Parameters
criteria[filterGroups][0][filters][0][field]
string

Field

criteria[filterGroups][0][filters][0][value]
string

Value

criteria[filterGroups][0][filters][0][conditionType]
string

Condition type

criteria[sortOrders][0][field]
string

Sorting field.

criteria[sortOrders][0][direction]
string

Sorting direction.

criteria[pageSize]
integer

Page size.

criteria[currentPage]
integer

Current page.

Responses
200

200 Success.

401

401 Unauthorized

default

Unexpected error

get/V1/customers/companies
Response samples
{
  • "items": [
    ],
  • "search_criteria": {
    },
  • "total_count": 0
}

customers/companies

Save customer attributes for company.

Request
Request Body schema:
required
object (company-data-company-customer-interface)

Extended customer custom attributes interface.

Responses
401

401 Unauthorized

500

Internal Server error

default

Unexpected error

post/V1/customers/companies
Request samples
{
  • "companyAttributes": {
    }
}
Response samples
{
  • "code": 0,
  • "errors": [
    ],
  • "message": "string",
  • "parameters": [
    ],
  • "trace": "string"
}
➔ Next to customers/confirm