Retrieve a collection of contacts information

This API endpoint is crafted to offer you an extensive list of user contacts, empowering you with the ability to filter, paginate, and access in-depth contact information seamlessly within your system.

Query Parameters

• page integer

  Default value: 1

  The collection page number

• itemsPerPage integer

  Possible values: <= 50

  Default value: 30

  The number of items per page

• pagination boolean

  Enable or disable pagination

Responses

• 200
• 401
• 403

---

OK - The request was processed successfully.

application/json

• Schema
• Example (from schema)

---

Schema

• Array [
• id integer
• name string
• type string

  Possible values: [legal_entity, person]

• country string
• address stringnull
• city stringnull
• zip stringnull
• state stringnull
• language string

  Possible values: [en, de, fr, it, cs, pl]

• selfContact boolean
• ]

[
  {
    "id": 1,
    "name": "AMNIS Treasury Services AG",
    "type": "legal_entity",
    "country": "CH",
    "address": "Baslerstrasse 60",
    "city": "Zürich",
    "zip": "8048",
    "state": "Canton of Zürich",
    "language": "en",
    "selfContact": true
  }
]

Unauthorised -- Your access token is wrong.

application/json

• Schema
• Example (from schema)

---

Schema

• type string
• title string
• detail string

{
  "type": "string",
  "title": "string",
  "detail": "string"
}

Forbidden -- Access to the requested resource or action is forbidden.

application/json

• Schema
• Example (from schema)

---

Schema

• type string
• title string
• detail string

{
  "type": "string",
  "title": "string",
  "detail": "string"
}

Loading...