API Documentation
API Endpoints/Identities

List identities with pagination

GET
/identities
AuthorizationBasic <token>

Basic authentication is a simple authentication scheme built into the HTTP protocol. To use it, send your HTTP requests with an Authorization header that contains the word Basic followed by a space and a base64-encoded string username:password.Example: Authorization: Basic ZGVtbzpwQDU1dzByZA==

In: header

Query Parameters

page?integer
Default1
pageSize?integer
Default1
sort?string
query?object

Filters for LIST calls. Supports multiple filtering operators.

Empty Object

Response Body

curl -X GET "https://staging1.abillify.dev/api/identities?page=3&pageSize=20&sort=created&query=%5Bobject+Object%5D"
fetch("https://staging1.abillify.dev/api/identities?page=3&pageSize=20&sort=created&query=%5Bobject+Object%5D")
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "https://staging1.abillify.dev/api/identities?page=3&pageSize=20&sort=created&query=%5Bobject+Object%5D"

  req, _ := http.NewRequest("GET", url, nil)
  
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}
import requests

url = "https://staging1.abillify.dev/api/identities?page=3&pageSize=20&sort=created&query=%5Bobject+Object%5D"

response = requests.request("GET", url)

print(response.text)
{
  "page": 3,
  "pageSize": 20,
  "query": {
    "created": "2023-01-01 00:00:00",
    "created[$gt]": "2023-01-01",
    "created[$gte]": "2023-01-01",
    "created[$in]": [
      "2023-01-01 00:00:00",
      "2023-01-01 00:00:01"
    ],
    "created[$lt]": "2023-01-01",
    "created[$lte]": "2023-01-01",
    "created[$ne]": "2023-01-03 00:00:00"
  },
  "rows": [
    {
      "addresses": [
        {
          "city": "Berlin",
          "country": "DE",
          "extra": "C/O Mr. Smith",
          "housenumber": "1",
          "info": "string",
          "kind": "shipping",
          "state": "Berlin",
          "street": "Main Street",
          "zipcode": "10115"
        }
      ],
      "created": "2020-01-01T00:00:00.000Z",
      "currency": "EUR",
      "debtor": "1234567890",
      "detail": {
        "dunning": {
          "customPeriods": {
            "COLLECTION": 28,
            "DUNNING1": 7,
            "DUNNING2": 7,
            "DUNNING3": 7,
            "REMINDER": 7
          },
          "delayedUntil": "2020-01-01",
          "deliveryKind": "letter",
          "disabled": true
        },
        "locale": "de-DE",
        "vatId": "DE123456789"
      },
      "emails": [
        {
          "email": "foo@bar.com",
          "kind": "default"
        }
      ],
      "id": "5e4a7b2b-1b0b-4c7a-8f0a-5b9b6b7c8d9e",
      "kind": "individual",
      "meta": {
        "custom_key": "custom_value"
      },
      "modified": "2020-01-01T00:00:00.000Z",
      "name": {
        "birthday": "1970-01-01",
        "company": "ACME Inc.",
        "firstname": "John",
        "lastname": "Doe",
        "salutation": "mr"
      },
      "number": "K12345",
      "phones": [
        {
          "active": true,
          "phone": "+49 30 12345678"
        }
      ],
      "reference": "1234567890"
    }
  ],
  "sort": "created"
}
{
  "code": 400,
  "details": [
    {
      "error": "Value for field 'debtor' is of wrong type, expected bigint.",
      "fields": [
        "debtor"
      ],
      "hint": "Value must be a number or a string containing only a number."
    }
  ],
  "message": "InvalidValue, see error details",
  "name": "ClientError",
  "type": "ERR_INVALID_VALUE"
}
{
  "code": 400,
  "details": [
    {
      "error": "Value for field 'debtor' is of wrong type, expected bigint.",
      "fields": [
        "debtor"
      ],
      "hint": "Value must be a number or a string containing only a number."
    }
  ],
  "message": "InvalidValue, see error details",
  "name": "ClientError",
  "type": "ERR_INVALID_VALUE"
}