filing_types_list

GET

/filing-types/

filing-types

Retrieve a list of all available filing types.

Request

Query Params

page

integer

optional

A page number within the paginated result set.

page_size

integer

optional

Number of results to return per page.

string

optional

A search term.

Header Params

x-api-key

string

required

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

count

integer

required

Example:

123

string <uri> | null

optional

Example:

http://api.example.org/accounts/?page=4

string <uri> | null

optional

Example:

http://api.example.org/accounts/?page=2

results

array[object (FilingType) {3}]

required

code

string

read-onlyrequired

Unique code identifying the filing type.

name

string

read-onlyrequired

Human-readable name of the filing type.

description

string

read-onlyrequired

Detailed description of the filing type.

Example

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "code": "string",
      "name": "string",
      "description": "string"
    }
  ]
}

companies_retrieve

filing_types_retrieve