Display a listing of the users.

Request

Authorization

Add parameter in header

Company-Token

Example:

Company-Token: ********************

Header Params

Accept

string

optional

Example:

application/json

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.test.apipagos.com/api/v2/apipagos/users' \
--header 'Accept: application/json' \
--header 'Company-Token;'

Responses

🟢200OK

application/json

Body

data

array [allOf]

required

object (User)

optional

object (User Address)

optional

object (User Identity)

optional

object (User Contact Info)

optional

object (User Fiscal Data)

optional

links

object

required

first

string

required

last

string

required

meta

object

required

current_page

integer

required

last_page

integer

required

links

array [object {3}]

required

path

string

required

per_page

integer

required

from

integer

required

to

integer

required

total

integer

required

message

string

optional

Example

{
  "data": [
    {
      "birth_country": "<string>",
      "birthdate": "<dateTime>",
      "code": "<string>",
      "company_id": "<integer>",
      "correlation_id": "<string>",
      "created_at": "<dateTime>",
      "email": "<string>",
      "email_verified_at": "<dateTime>",
      "field_1": "<string>",
      "field_2": "<string>",
      "field_3": "<string>",
      "first_name": "<string>",
      "gender": "Male",
      "id": "<integer>",
      "last_name": "<string>",
      "marital_status": "Single",
      "nationality": "<string>",
      "profile_photo_url": "<string>",
      "status": {
        "action": "showPopup",
        "code": "<integer>",
        "description": "<string>",
        "label": "<string>"
      },
      "type": "f",
      "updated_at": "<dateTime>"
    },
    {
      "birth_country": "<string>",
      "birthdate": "<dateTime>",
      "code": "<string>",
      "company_id": "<integer>",
      "correlation_id": "<string>",
      "created_at": "<dateTime>",
      "email": "<string>",
      "email_verified_at": "<dateTime>",
      "field_1": "<string>",
      "field_2": "<string>",
      "field_3": "<string>",
      "first_name": "<string>",
      "gender": "Male",
      "id": "<integer>",
      "last_name": "<string>",
      "marital_status": "Other",
      "nationality": "<string>",
      "profile_photo_url": "<string>",
      "status": {
        "action": "stopExecution",
        "code": "<integer>",
        "description": "<string>",
        "label": "<string>"
      },
      "type": "f",
      "updated_at": "<dateTime>"
    }
  ]
}