Sign in
contact

Retrieve contacts

Changed on

Get a paginated list of contacts for the current company

get/contacts

Request

  • Base URL: https://api.abby.fr
  • URL: https://api.abby.fr/contacts
  • Auth: HTTP bearer

Query parameters

pagenumber
limitnumber
searchstring
orderBy'name' | 'createdAt'
orderDirection'ASC' | 'DESC'
archivedboolean
forCertificateboolean

Response

Successfully retrieved contacts

countWithoutFiltersnumber required
totalDocsnumber required
limitnumber required
totalPagesnumber required
hasNextPageboolean required
hasPrevPageboolean required
nextPagenumber required
pagenumber required
prevPagenumber required

Example response

{
  "docs": [
    {
      "archivedAt": 1617187200,
      "createdAt": 1617187200,
      "defaultContact": true,
      "emails": [
        "john@example.com",
        "johndoe@company.com"
      ],
      "hasBillings": true,
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "fullname": "John Doe",
      "organization": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Acme Corp",
        "archivedAt": 1617187200
      }
    }
  ]
}

Changes

  • bb3dad0e053fRevision changes
    • info

      api operation id ContactsController-retrieveContacts removed and replaced with ContactsController_retrieveContacts

    • info

      added to the // response property allOf list for the response status

    • info

      removed from the // response property allOf list for the response status

    This list may be incomplete.