Display a listing of contracts.

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

Responses

🟢200OK

application/json

Body

data

array [object {14}]

required

code

string

optional

config_code

string

optional

title

string

optional

description

string

optional

integrity_code

string

optional

status

object

optional

user_source

object

optional

user_destiny_exists

boolean

optional

user_destiny_email

string

optional

user_destiny_phone

string

optional

user_destiny

object

optional

expired_at

string

optional

created_at

string

optional

updated_at

string

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

required

Example

{
  "data": [
    {
      "code": "ullamco dolore aliqua",
      "config_code": "incididunt",
      "title": "corrupti nam ducimus",
      "description": "Autem mollitia magni corrupti maiores aut delectus. Dignissimos qui sunt corporis ipsum eius culpa repellendus facilis eligendi. Dicta sapiente cumque pariatur. Sapiente occaecati consequatur tempora animi dolore fugiat reiciendis est laboriosam.",
      "integrity_code": "Ut in",
      "status": {
        "code": 3,
        "label": "East",
        "description": "card",
        "action": "showHelp"
      },
      "user_source": {
        "code": "est mollit anim dolore",
        "correlation_id": "deserunt Lorem commodo enim nostrud",
        "company_id": 93488044,
        "type": "j",
        "email": "[email protected]",
        "email_verified_at": "2024-03-13T16:37:01.919Z",
        "first_name": "Zechariah",
        "last_name": "MacGyver",
        "field_1": "099",
        "field_2": "4444",
        "field_3": "25996681114",
        "profile_photo_url": "https://loremflickr.com/640/480/city",
        "birthdate": "2001-08-06T03:48:12.677Z",
        "birth_country": "labore ex aute",
        "nationality": "voluptate consequat",
        "gender": "Other",
        "marital_status": "Widowed",
        "status": {
          "code": 4,
          "label": "utilize",
          "description": "Product District",
          "action": "none"
        },
        "created_at": "2024-03-13T21:17:45.283Z",
        "updated_at": "2024-03-13T17:11:38.416Z"
      },
      "user_destiny_exists": false,
      "user_destiny_email": "[email protected]",
      "user_destiny_phone": "399.247.1405 x8461",
      "user_destiny": {
        "code": "proident veniam ut",
        "correlation_id": "dolore eiusmod amet",
        "company_id": -13194878,
        "type": "j",
        "email": "[email protected]",
        "email_verified_at": "2024-03-14T12:53:20.123Z",
        "first_name": "Elva",
        "last_name": "McClure",
        "field_1": "099",
        "field_2": "4444",
        "field_3": "2599818887",
        "profile_photo_url": "https://loremflickr.com/640/480/nature",
        "birthdate": "1992-01-26T17:58:28.246Z",
        "birth_country": "non veniam elit sed est",
        "nationality": "et nostrud fugiat occaecat velit",
        "gender": "Female",
        "marital_status": "Married",
        "status": {
          "code": 5,
          "label": "gray",
          "description": "Card",
          "action": "showPopup"
        },
        "created_at": "2024-03-14T11:26:25.366Z",
        "updated_at": "2024-03-14T01:35:53.085Z"
      },
      "expired_at": "2024-03-14T08:52:45.239Z",
      "created_at": "2024-03-13T17:09:10.928Z",
      "updated_at": "2024-03-14T13:27:42.712Z"
    }
  ],
  "links": {
    "first": "https://round-anything.org",
    "last": "http://blind-diesel.com",
    "prev": null,
    "next": "esse adipisicing"
  },
  "meta": {
    "current_page": 2,
    "last_page": 6,
    "links": [
      {
        "url": "https://authorized-mustache.info",
        "label": "nulla",
        "active": true
      }
    ],
    "path": "eu",
    "per_page": 15,
    "from": 15,
    "to": 30,
    "total": 90
  },
  "message": "Dolorem rem placeat suscipit nostrum asperiores in earum animi. Libero officiis modi. Reprehenderit harum in similique at est. Rem autem doloribus itaque vitae. At dolor quae culpa a aut."
}