Pobierz listę krajów

Zakres: api:invoices:read. Sortowane po nazwie polskiej, chyba że podano order. limit nie jest ograniczany. polish_name nie działa w filtrach ani w order (jest ignorowane), a w fields powoduje 500.

GET

https://api.sandbox-infakt.pl/v3/countries.json

Autoryzacja

ApiKey
opcjonalne
API key in header

Token
opcjonalne
API key in header

Query parameters

page
opcjonalne
integer
Numer strony liczony od 1; ignorowany, gdy wysłany jest offset.

format: int32 · default: 1
per_page
opcjonalne
integer
Liczba wyników na stronę przy page. Serwer jej nie ogranicza.

format: int32 · default: 10
offset
opcjonalne
integer
Indeks pierwszego wyniku (liczba pomijanych encji).

format: int32
limit
opcjonalne
integer
Liczba wyników na stronę przy offset; domyślnie 10, ignorowana bez offset. Większość list bez błędu obniża wartości powyżej 100 do 100.

format: int32
pagination_without_total
opcjonalne
boolean
Pomiń liczenie; metainfo.total_count przyjmuje wartość null.
fields
opcjonalne
string
Zawężenie pól: nazwy pól API rozdzielone przecinkami, np. id,company_name; id jest zwykle dodawane. Odpowiedź zawiera wtedy tylko te pola, więc nie odpowiada pełnemu schematowi. Pola wyliczane, a nie zapisywane, mogą kończyć się błędem 500; operacja je wymienia.
order
opcjonalne
string
Sortowanie: <pole>, <pole> asc albo <pole> desc z nazwą pola API, np. name desc. Pole, po którym nie da się sortować, jest ignorowane bez błędu.
q[alpha_2_eq]
opcjonalne
string
Kod dwuliterowy równy, np. DE.
q[english_name_eq]
opcjonalne
string
Nazwa angielska równa, np. Poland.
q[english_name_cont]
opcjonalne
string
Nazwa angielska zawiera.
q[european_union_eq]
wycofywane
boolean
Historyczny filtr po european_union, które zawsze ma wartość false.

Odpowiedzi

200

Sukces

JSON

metainfo
object
wymagane
- count
  integer
  wymagane
  Liczba encji na tej stronie.
  
  format: int32
- total_count
  wymagane
  Liczba pasujących encji; null, gdy pagination_without_total=true.
  
  One of the following:
  integer
  null
- next
  string
  wymagane
  Bezwzględny URL następnej strony w postaci offset/limit.
- previous
  string
  wymagane
  Bezwzględny URL poprzedniej strony w postaci offset/limit.
}
entities
array of
object
wymagane
- id
  integer
  wymagane
  format: int64
- alpha_2
  string
  wymagane
  ISO 3166-1 alpha-2, z wyjątkiem EL dla Grecji i XI dla Irlandii Północnej. Używaj jako country klienta.
  
  pattern: ^[A-Z]{2}$
- alpha_3
  string
  wymagane
  pattern: ^[A-Z]{3}$
- english_name
  string
  wymagane
- polish_name
  string
  wymagane
- continent
  string
  wymagane
  Nazwa kontynentu po polsku.
- european_union
  wycofywane
  boolean
  wymagane
  Pole historyczne, zawsze false. Nie odzwierciedla członkostwa w UE.
- currency
  wymagane
  Kod ISO 4217 waluty krajowej.
  
  One of the following:
  string
  null
}

400

Nieprawidłowe parametry wyszukiwania (q[...]); na niektórych endpointach także nieprawidłowe parametry stronicowania.

JSON

error
opcjonalne
Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.
One of the following:
string
array<string>
object
}
errors
opcjonalne
Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.
One of the following:
object
string
}
limit
opcjonalne
string
Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.
type
opcjonalne
redirect
or
email_not_confirmed
url
opcjonalne
string
action_url
opcjonalne
string

401

Brak klucza API, nieprawidłowy klucz albo klucz bez wymaganego zakresu uprawnień.

JSON

error
opcjonalne
Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.
One of the following:
string
array<string>
object
}
errors
opcjonalne
Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.
One of the following:
object
string
}
limit
opcjonalne
string
Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.
type
opcjonalne
redirect
or
email_not_confirmed
url
opcjonalne
string
action_url
opcjonalne
string

402

API niedostępne w obecnym planie (limit: plan_upgrade_needed) albo osiągnięty limit dokumentów.

JSON

error
opcjonalne
Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.
One of the following:
string
array<string>
object
}
errors
opcjonalne
Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.
One of the following:
object
string
}
limit
opcjonalne
string
Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.
type
opcjonalne
redirect
or
email_not_confirmed
url
opcjonalne
string
action_url
opcjonalne
string

406

Ścieżka nie kończy się na .json.

JSON

error
opcjonalne
Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.
One of the following:
string
array<string>
object
}
errors
opcjonalne
Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.
One of the following:
object
string
}
limit
opcjonalne
string
Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.
type
opcjonalne
redirect
or
email_not_confirmed
url
opcjonalne
string
action_url
opcjonalne
string

423

Niepotwierdzony adres e-mail albo wymagana weryfikacja tożsamości.

JSON

error
opcjonalne
Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.
One of the following:
string
array<string>
object
}
errors
opcjonalne
Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.
One of the following:
object
string
}
limit
opcjonalne
string
Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.
type
opcjonalne
redirect
or
email_not_confirmed
url
opcjonalne
string
action_url
opcjonalne
string

429

Przekroczony limit zapytań. Komunikat jest po angielsku, np. API rate limit exceeded. Try again in 60 seconds.

JSON

error
opcjonalne
Komunikat po polsku (po angielsku dla 429). Niektóre akcje zamiast jednego tekstu zwracają listę komunikatów albo błędy walidacji według pól.
One of the following:
string
array<string>
object
}
errors
opcjonalne
Błędy walidacji według nazw pól API; na niektórych endpointach zwykły komunikat.
One of the following:
object
string
}
limit
opcjonalne
string
Kod limitu planu, np. limit_exceeded, plan_upgrade_needed, cant_add_client.
type
opcjonalne
redirect
or
email_not_confirmed
url
opcjonalne
string
action_url
opcjonalne
string

{ "metainfo": { "count": 1, "total_count": 212, "next": "https://api.infakt.pl/v3/countries.json?limit=1&offset=1", "previous": "https://api.infakt.pl/v3/countries.json?limit=1&offset=0" }, "entities": [ { "id": 1, "alpha_2": "AF", "alpha_3": "AFG", "english_name": "Afghanistan", "polish_name": "Afganistan", "continent": "Azja", "european_union": false, "currency": "AFN" } ] }