DOdotfile
Client portal

Return a list of all client portals

Changed on

See also

Learn more about Client portals

get/v1/client-portals

Request

  • Base URL
    https://api.dotfile.com
  • Auth
    API key in header X-DOTFILE-API-KEY

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.

status'offline' | 'online'

Filter items by the status.{operator} field.
You can use the eq, not_eq, in and not_in operators, the eq operator being the default.
Comma separated for multiple values (in and not_in).

default_languagestring

Filter items by the default_language.{operator} field.
You can use the eq, not_eq, like and ilike 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.

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.

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 client portals in the workspace

ℹ️ Click to see full payload

Example response

{
  "pagination": {
    "count": 42
  }
}

Changes

  • 50cab516e856Revision changes
    • warning

      added the new bg enum value to the // response property for the response status

    • warning

      added the new bs enum value to the // response property for the response status

    • warning

      added the new cs enum value to the // response property for the response status

    • warning

      added the new da enum value to the // response property for the response status

    • warning

      added the new el enum value to the // response property for the response status

    • warning

      added the new et enum value to the // response property for the response status

    • warning

      added the new fi enum value to the // response property for the response status

    • warning

      added the new hr enum value to the // response property for the response status

    • warning

      added the new id enum value to the // response property for the response status

    • warning

      added the new ka enum value to the // response property for the response status

    • warning

      added the new kk enum value to the // response property for the response status

    • warning

      added the new lt enum value to the // response property for the response status

    • warning

      added the new lv enum value to the // response property for the response status

    • warning

      added the new mk enum value to the // response property for the response status

    • warning

      added the new mt enum value to the // response property for the response status

    • warning

      added the new no enum value to the // response property for the response status

    • warning

      added the new ro enum value to the // response property for the response status

    • warning

      added the new ru enum value to the // response property for the response status

    • warning

      added the new sk enum value to the // response property for the response status

    • warning

      added the new sl enum value to the // response property for the response status

    • warning

      added the new sq enum value to the // response property for the response status

    • warning

      added the new sr enum value to the // response property for the response status

    • warning

      added the new sv enum value to the // response property for the response status

    • warning

      added the new th enum value to the // response property for the response status

    • warning

      added the new tr enum value to the // response property for the response status

    • warning

      added the new uk enum value to the // response property for the response status