Get a user by code.

Request

Authorization

Add parameter in header

Company-Token

Example:

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

Path Params

code

string

required

field_1

string | null

required

Opcional

field_2

string | null

required

Opcional

field_3

string | null

required

Opcional

Query Params

}

string

optional

Header Params

string

optional

Example:

application/json

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

data

object (User)

optional

code

string

required

correlation_id

string

required

type

enum<string>

required

Allowed values:

Default:

string

required

email_verified_at

string <date-time>

required

first_name

string

required

last_name

string

required

field_1

string | null

read-onlyrequired

Cuit, Grupo u Órden

field_2

string | null

read-onlyrequired

Cuit, Grupo u Órden

field_3

string | null

read-onlyrequired

Cuit, Grupo u Órden

profile_photo_url

string

required

birthdate

string <date-time>

required

birth_country

string

required

nationality

string

required

gender

string

required

Match pattern:

(Male)|(Female)|(Other)

marital_status

enum<string>

required

Allowed values:

SingleMarriedDivorcedWidowedOther

status

object (System Status)

required

created_at

string <date-time>

required

updated_at

string <date-time>

required

Example

{
    "data": [
        {
            "amount": "<string>",
            "batch": "<string>",
            "code": "<string>",
            "config_code": "<string>",
            "created_at": "<dateTime>",
            "description": "<string>",
            "field_1": "<string>",
            "field_2": "<string>",
            "field_3": "<string>",
            "id": "<integer>",
            "integrity_code": "<string>",
            "name": "<string>",
            "refund_date": "<dateTime>",
            "request_date": "<dateTime>",
            "scheduled_date": "<dateTime>",
            "status": {
                "action": "none",
                "code": "<integer>",
                "description": "<string>",
                "label": "<string>"
            },
            "status_log": "<string>",
            "title": "<string>",
            "token": "<string>",
            "transaction_type": "<string>",
            "updated_at": "<dateTime>",
            "user": {
                "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": "none",
                    "code": "<integer>",
                    "description": "<string>",
                    "label": "<string>"
                },
                "type": "f",
                "updated_at": "<dateTime>"
            }
        },
        {
            "amount": "<string>",
            "batch": "<string>",
            "code": "<string>",
            "config_code": "<string>",
            "created_at": "<dateTime>",
            "description": "<string>",
            "field_1": "<string>",
            "field_2": "<string>",
            "field_3": "<string>",
            "id": "<integer>",
            "integrity_code": "<string>",
            "name": "<string>",
            "refund_date": "<dateTime>",
            "request_date": "<dateTime>",
            "scheduled_date": "<dateTime>",
            "status": {
                "action": "none",
                "code": "<integer>",
                "description": "<string>",
                "label": "<string>"
            },
            "status_log": "<string>",
            "title": "<string>",
            "token": "<string>",
            "transaction_type": "<string>",
            "updated_at": "<dateTime>",
            "user": {
                "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": "Widowed",
                "nationality": "<string>",
                "profile_photo_url": "<string>",
                "status": {
                    "action": "none",
                    "code": "<integer>",
                    "description": "<string>",
                    "label": "<string>"
                },
                "type": "f",
                "updated_at": "<dateTime>"
            }
        }
    ],
    "links": {
        "first": "<string>",
        "last": "<string>",
        "next": "<string>",
        "prev": "<string>"
    },
    "message": "<string>",
    "meta": {
        "current_page": "<integer>",
        "from": "<integer>",
        "last_page": "<integer>",
        "links": [
            {
                "active": "<boolean>",
                "label": "<string>",
                "url": "<string>"
            },
            {
                "active": "<boolean>",
                "label": "<string>",
                "url": "<string>"
            }
        ],
        "path": "<string>",
        "per_page": "<integer>",
        "to": "<integer>",
        "total": "<integer>"
    }
}