Page tree
Skip to end of metadata
Go to start of metadata

Warning!

Resource available only in the following countries: PL, IT

On this page

 

Organization list

Organization search can be performed by specifying one or more of the following criteria.

GET /v1/organizations

Search criteria

Parameter

Type

Description

Example

Availability

tax_id 

String

Searches for organizations with the stated tax identification number.

?tax_id=12

PL, IT

name 

String

Searches for organizations whose name is the same as the specified string.

?name=organization name

PL, IT

address_street 

String

Searches for organizations in which the address street  or line1  starts from the specified string.

?address_street=street

PL, IT

owner_full_name

String

Searches for organizations in which the first name and surname contains the specified string.

?owner_full_name=first name and last name

PL, IT

application_name 

String

Searches for organizations in which the application name contains the specified string.

?application_name=application name

PL, IT

Sort criteria

Search results can be sorted using the sort_by  parameter using the following values:

sort_by value

Description

Example

Availability

id

Sorts organizations by the ID.

?sort_by=id

PL, IT

name

Sorts organizations by name.

?sort_by=name

PL, IT

tax_id

Sorts organizations by tax identification number.

?sort_by=tax_id

PL, IT

address_street 

Sorts organizations by street.

?sort_by=address_street

PL, IT

created_at

Sorts organizations by creation time.

?sort_by=created_at

PL, IT

Sorting can be descending or ascending and is controlled by the sort_order parameter. By default the sorting order is descending  on the created_at attribute.

sort_order value

Description

Example

Availability

asc

Sorts organizations ascending

?sort_order=asc&sort_by=id

PL, IT

desc

Sorts organizations descending

?sort_order=desc&sort_by=id

PL, IT



  • No labels