Get contract by code or Id.

Request

Authorization

Add parameter in header

company-token

Example:

company-token: ********************

Path Params

value

string

required

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/contracts/' \
--header 'Accept: application/json' \
--header 'company-token;'

Responses

🟢200Success

application/json

Body

data

object (Contract)

required

code

string

required

config_code

string

required

title

string

required

description

string | null

required

integrity_code

string

required

status

object

System Status

required

user_source

object

User

required

user_destiny_exists

boolean

required

user_destiny

optional

user_destiny_email

string | null

read-onlyoptional

user_destiny_phone

string | null

read-onlyoptional

expired_at

string <date-time>

read-onlyrequired

created_at

string <date-time>

read-onlyrequired

updated_at

string <date-time>

read-onlyrequired

deleted_at

string <date-time>

read-onlyoptional

Example

{
    "data": {
        "code": "string",
        "config_code": "string",
        "title": "string",
        "description": "string",
        "integrity_code": "string",
        "status": {
            "code": 0,
            "label": "string",
            "description": "string",
            "action": "showHelp"
        },
        "user_source": {
            "code": "string",
            "correlation_id": "string",
            "type": "f",
            "email": "string",
            "email_verified_at": "2019-08-24T14:15:22Z",
            "first_name": "string",
            "last_name": "string",
            "field_1": "string",
            "field_2": "string",
            "field_3": "string",
            "profile_photo_url": "string",
            "birthdate": "2019-08-24T14:15:22Z",
            "birth_country": "string",
            "nationality": "string",
            "gender": "string",
            "marital_status": "Single",
            "status": {
                "code": 0,
                "label": "string",
                "description": "string",
                "action": "showHelp"
            },
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z"
        },
        "user_destiny_exists": true,
        "user_destiny": {
            "code": "string",
            "correlation_id": "string",
            "type": "f",
            "email": "string",
            "email_verified_at": "2019-08-24T14:15:22Z",
            "first_name": "string",
            "last_name": "string",
            "field_1": "string",
            "field_2": "string",
            "field_3": "string",
            "profile_photo_url": "string",
            "birthdate": "2019-08-24T14:15:22Z",
            "birth_country": "string",
            "nationality": "string",
            "gender": "string",
            "marital_status": "Single",
            "status": {
                "code": 0,
                "label": "string",
                "description": "string",
                "action": "showHelp"
            },
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z"
        },
        "user_destiny_email": "string",
        "user_destiny_phone": "string",
        "expired_at": "2019-08-24T14:15:22Z",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z"
    }
}

🟠404Content Not Found