Sign in

v1

latestOpenAPI 3.0.02026-07-2494288373.8 KB
Companies

List all companies

Returns a list of all companies created in your Dotfile workspace.

See also

Learn more about Filtering, Sorting and Pagination

get/v1/companies

Query parameters

namestring

Filter items by the name.{operator} field.
You can use the eq, not_eq, like and ilike operators, the eq operator being the default.

registration_numberstring

Filter items by the registration_number.{operator} field.
You can use the eq, not_eq, like and ilike operators, the eq operator being the default.

countrystring

Filter items by the country.{operator} field.
You can use the eq operators, the eq operator being the default.

created_atstring

Date (yyyy-MM-dd eg 2023-01-31) or date time (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z) in format ISO 8601

Filter items by the created_at.{operator} field.
You can use the eq, not_eq, gt, gte, lt and lte operators, the eq operator being the default.

updated_atstring

Date (yyyy-MM-dd eg 2023-01-31) or date time (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z) in format ISO 8601

Filter items by the updated_at.{operator} field.
You can use the eq, not_eq, gt, gte, lt and lte operators, the eq operator being the default.

last_activity_atstring

Date (yyyy-MM-dd eg 2023-01-31) or date time (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z) in format ISO 8601

Filter items by the last_activity_at.{operator} field.
You can use the eq, not_eq, gt, gte, lt and lte operators, the eq operator being the default.

sortstring

Use this parameter to sort query results.
If not specified, sorted in ascending order with values of field created_at.
Available fields are created_at, last_activity_at and name.

pagenumber

Query response is paginated.
Use this parameter to choose which page you want to display.
Page index starts at 1 (the default).

limitnumber

Query response is paginated.
Use this parameter to choose the number of items per page.
Limit defaults to 20, maximum value is 100.

Response

List of companies created in the workspace

ℹ️ Click to see full payload

Example response

{
  "data": [
    {
      "banking_information": {
        "iban": "FR7630006000011234567890189",
        "bic": "AGRIFRPPXXX"
      }
    }
  ],
  "pagination": {
    "count": 42
  }
}