Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Info | |
---|---|
title | Warning! Resource available only in the following countries: PL, IT |
On this page
Table of Contents |
---|
minLevel | 2 |
---|
Organization list
Organization search can be performed by specifying one or more of the following criteria.
Code Block | ||
---|---|---|
| ||
GET /v1/organizations |
Search criteria
Parameter | Type | Description | Example | Availability |
---|---|---|---|---|
| String | Searches for organizations with the stated tax identification number. |
| PL, IT |
| String | Searches for organizations whose name is the same as the specified string. |
| PL, IT |
| String | Searches for organizations in which the address |
| PL, IT |
| String | Searches for organizations in which the first name and surname contains the specified string. |
| PL, IT |
| String | Searches for organizations in which the application name contains the specified string. |
| PL, IT |
Sort criteria
Search results can be sorted using
the sort_by
parameter using the following values:
sort_by value | Description | Example | Availability |
---|---|---|---|
| Sorts organizations by the ID. |
| PL, IT |
| Sorts organizations by name. |
| PL, IT |
| Sorts organizations by tax identification number. |
| PL, IT |
| Sorts organizations by street. |
| PL, IT |
| Sorts organizations by creation time. |
| PL, IT |
Sorting can be descending or ascending and is controlled by
the sort_order
parameter. By default, the sorting order
descending
on the is descending
on the created_at
attribute.
sort_order value | Description | Example | Availability |
---|---|---|---|
| Sorts organizations ascending |
| PL, IT |
| Sorts organizations descending |
| PL, IT |