Customers (customer)

Auth

All Customers endpoints require authorization:
- Authorization: Bearer {{oauth_access_token}} (OAuth client_credentials token), or
- mobstep-customer-token: {{customer_token}} (customer token)

Base URL

{{base_path}}{{api_v3_path}}/customer

Notes

Friendly entity names are supported in URLs (example: /customer).
Legacy internal names (example: /apps_customer) are still accepted for backward compatibility.

GET Query Parameters (supported by API v3)

fields (required)
- Comma-separated list of fields to include in the response.
- If missing/empty: 400 invalid_request Parameter fields is required.
sort (optional)
- Format: sort=<field>,<ASC|DESC>
range (optional; pagination)
- Format: range=<offset>,<limit>
search (optional; contains search)
- Format: search=<field>,<value>
- Multiple OR groups: separate by |
group (optional)
- Format: group=<field>
Filter by field value (optional)
- You can pass any field name as a query parameter to filter results.
- Values are comma-separated and applied as an IN condition.

Fields (customer)

Common customer fields defined in the entity:

id, uuid, iid
name, mail, password, mobile
platform, method, identifier
registration_key, registered, status
access, login
application_id
language_preference, langcode
created, changed

GET

GET Customers (Auth required)

https://mobstep.com/api/v3.0/customer?fields=id,uuid,application_id,name,mail,mobile,platform,method,registered,status,language_preference,created,changed

Fields

Name	Description
`id`	-
`uuid`	-
`application_id`	-
`name`	-
`mail`	-
`mobile`	-
`platform`	-
`method`	-
`registered`	-
`status`	-
`language_preference`	-
`created`	-
`changed`	-

Headers

Name	Value	Description
`Authorization`	`Bearer {{oauth_access_token}}`	-
`mobstep-customer-token`	`{{customer_token}}`	-

POST

POST Customers: Create (Auth required)

https://mobstep.com/api/v3.0/customer

Headers

Name	Value	Description
`Content-Type`	`application/json`	-
`Authorization`	`Bearer {{oauth_access_token}}`	-
`mobstep-customer-token`	`{{customer_token}}`	-

{
  "application_id": [{"target_id": {{application_id}}}],
  "platform": "web",
  "method": "mail",
  "name": "Sample Customer",
  "mail": "[email protected]",
  "mobile": "01000000000",
  "registered": true,
  "status": true,
  "language_preference": "primary"
}

Description

Create customer. Required fields (entity definition): application_id, platform.

POST

POST Customers: Update (with id in body)

https://mobstep.com/api/v3.0/customer

Headers

Name	Value	Description
`Content-Type`	`application/json`	-
`Authorization`	`Bearer {{oauth_access_token}}`	-
`mobstep-customer-token`	`{{customer_token}}`	-

{
  "id": "{{api_entity_id}}",
  "name": "Updated Customer Name"
}

Description

Update customer by providing id in body.

DELETE

DELETE Customers (Auth required)

https://mobstep.com/api/v3.0/customer/{{api_entity_id}}

Headers

Name	Value	Description
`Authorization`	`Bearer {{oauth_access_token}}`	-
`mobstep-customer-token`	`{{customer_token}}`	-

Description

Delete customer by id. Requires authorization.