organization

Changed on
get/organizations

Request

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

Query parameters

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

Response

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

Example response

{
  "docs": [
    {
      "paymentMethods": [
        "cheque",
        "stripe"
      ],
      "billingAddress": {
        "address": "123 Main Street",
        "complement": "Apt 4B",
        "city": "New York",
        "zipCode": "10001",
        "state": "NY"
      },
      "deliveryAddress": {
        "address": "123 Main Street",
        "complement": "Apt 4B",
        "city": "New York",
        "zipCode": "10001",
        "state": "NY"
      },
      "bankInformations": {
        "iban": "DE89370400440532013000",
        "bic": "DEUTDEFF",
        "holder": "John Doe"
      },
      "createdAt": 1617187200,
      "archivedAt": 1617187200
    }
  ]
}

Changes

  • bb3dad0e053fRevision changes
    • warning

      added the new XAF enum value to the ////// response property for the response status

    • warning

      added the new XOF enum value to the ////// response property for the response status

    • warning

      added the new XPF enum value to the ////// response property for the response status

    • warning

      added the new cash enum value to the /// response property for the response status

    • warning

      added the new cheque enum value to the /// response property for the response status

    • warning

      added the new credit_card enum value to the /// response property for the response status

    • warning

      added the new direct_debit enum value to the /// response property for the response status

    • warning

      added the new other enum value to the /// response property for the response status

    • warning

      added the new paypal enum value to the /// response property for the response status

    • warning

      added the new stripe enum value to the /// response property for the response status

    • warning

      added the new transfer enum value to the /// response property for the response status

    • warning

      added the new universal_employment_service_cheque enum value to the /// response property for the response status

    • info

      api operation id OrganizationsController-retrieveOrganizations removed and replaced with OrganizationsController_retrieveOrganizations

    This list may be incomplete.