PLplugsign

GET All Customers

Changed on

Com este endpoint, você pode listar todos os clientes cadastrados no sistema.

É possível filtrar os resultados utilizando os query params disponíveis listados abaixo.

A lista é paginada (15 por página, do mais recente para o mais antigo) e traz links e meta. Os filtros id, name, last_name, email e phone são comparações exatas; address faz busca parcial (contém).

get/api/customers

Request

  • Base URL
    https://app.plugsign.com.br
  • URL
    https://app.plugsign.com.br/api/customers
  • Auth
    API key in header Authorization

Query parameters

idinteger

Id do seu cliente adicionado na plataforma.

namestring

Primeiro nome do cliente adicionado na plataforma.

last_namestring

Sobrenome do cliente adicionado na plataforma.

emailstring

Endereço de e-mail do cliente adicionado na plataforma.

phonestring

Telefone do cliente (comparação exata).

addressstring

Endereço do cliente (busca parcial, contém).

Response

200

Example response

{
  "data": [
    {
      "id": 1,
      "name": "João",
      "last_name": "Silva",
      "phone": "11-99999-9999",
      "email": "developer@exemplo.com",
      "recive_email": 1,
      "recive_whatsapp": 1,
      "birth": "1990-05-12",
      "role": "user"
    }
  ],
  "meta": {
    "per_page": 15
  }
}

Changes

  • 3db1513040eaRevision changes
    • info

      for the query request parameter phone, the type was generalized from integer to string, and format from int32 to no format

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status