Listar clientes

Authorization

bearer

AuthorizationBearer <token>

In: header

Query Parameters

cursor?string

Opaque cursor from CursorPaginationDto.cursor. Use next_cursor or previous_cursor from the previous response.

limit?integer

Page size from CursorPaginationDto.limit.

Default20

Range1 <= value <= 100

search?string

Full-text search term from CursorPaginationDto.search.

with_deleted?boolean

Include soft-deleted records from CursorPaginationDto.with_deleted.

Defaultfalse

include_payload_search?boolean

Include payload JSON search from CursorPaginationDto.include_payload_search when supported by the endpoint.

Defaultfalse

sort?string

Sort expression from CursorPaginationDto.sort in the format field:order (for example created_at:desc).

id?string

Exact match for "id" (string)

id[neq]?string

Not equal filter for "id" (string)

id[contains]?string

Contains filter for "id"

id[not_contains]?string

Does not contain filter for "id"

legal_name?string

Exact match for "legal_name" (string)

legal_name[neq]?string

Not equal filter for "legal_name" (string)

legal_name[contains]?string

Contains filter for "legal_name"

legal_name[not_contains]?string

Does not contain filter for "legal_name"

trade_name?string

Exact match for "trade_name" (string)

trade_name[neq]?string

Not equal filter for "trade_name" (string)

trade_name[contains]?string

Contains filter for "trade_name"

trade_name[not_contains]?string

Does not contain filter for "trade_name"

tax_id?string

Exact match for "tax_id" (string)

tax_id[neq]?string

Not equal filter for "tax_id" (string)

tax_id[contains]?string

Contains filter for "tax_id"

tax_id[not_contains]?string

Does not contain filter for "tax_id"

type?string

Exact match for "type" (string)

type[neq]?string

Not equal filter for "type" (string)

type[contains]?string

Contains filter for "type"

type[not_contains]?string

Does not contain filter for "type"

city?string

Exact match for "city" (string)

city[neq]?string

Not equal filter for "city" (string)

city[contains]?string

Contains filter for "city"

city[not_contains]?string

Does not contain filter for "city"

state?string

Exact match for "state" (string)

state[neq]?string

Not equal filter for "state" (string)

state[contains]?string

Contains filter for "state"

state[not_contains]?string

Does not contain filter for "state"

country_code?string

Exact match for "country_code" (string)

country_code[neq]?string

Not equal filter for "country_code" (string)

country_code[contains]?string

Contains filter for "country_code"

country_code[not_contains]?string

Does not contain filter for "country_code"

is_blocked?boolean

Exact match for "is_blocked" (boolean)

is_blocked[neq]?boolean

Not equal filter for "is_blocked" (boolean)

reference_code?string

Exact match for "reference_code" (string)

reference_code[neq]?string

Not equal filter for "reference_code" (string)

reference_code[contains]?string

Contains filter for "reference_code"

reference_code[not_contains]?string

Does not contain filter for "reference_code"

tags?string

Exact match for "tags" (string)

tags[neq]?string

Not equal filter for "tags" (string)

tags[contains]?string

Contains filter for "tags"

tags[not_contains]?string

Does not contain filter for "tags"

created_at?string

Exact match for "created_at" (ISO 8601 datetime)

created_at[neq]?string

Not equal filter for "created_at" (ISO 8601 datetime)

created_at[gt]?string

Greater than filter for "created_at" (ISO 8601 datetime)

created_at[gte]?string

Greater than or equal filter for "created_at" (ISO 8601 datetime)

created_at[lt]?string

Less than filter for "created_at" (ISO 8601 datetime)

created_at[lte]?string

Less than or equal filter for "created_at" (ISO 8601 datetime)

updated_at?string

Exact match for "updated_at" (ISO 8601 datetime)

updated_at[neq]?string

Not equal filter for "updated_at" (ISO 8601 datetime)

updated_at[gt]?string

Greater than filter for "updated_at" (ISO 8601 datetime)

updated_at[gte]?string

Greater than or equal filter for "updated_at" (ISO 8601 datetime)

updated_at[lt]?string

Less than filter for "updated_at" (ISO 8601 datetime)

updated_at[lte]?string

Less than or equal filter for "updated_at" (ISO 8601 datetime)

Response Body

`application/json`

curl -X GET "https://api.biterp.ai/customers"

{
  "data": [
    {
      "id": "string",
      "type": "string",
      "tax_id": "string",
      "tax_id_type": "CPF",
      "legal_name": "string",
      "trade_name": "string",
      "website": "string",
      "address_line1": "string",
      "address_line2": "string",
      "city": {
        "id": 0,
        "name": "string"
      },
      "state": {
        "id": 0,
        "state_code": "string",
        "name": "string"
      },
      "country": {
        "id": 0,
        "iso2": "string",
        "iso3": "string",
        "name": "string"
      },
      "postal_code": "string",
      "reference_code": "string",
      "bank_code": "string",
      "branch_number": "string",
      "account_number": "string",
      "account_type": "string",
      "emails": [
        "string"
      ],
      "phones": [
        "string"
      ],
      "tags": [
        "string"
      ],
      "is_blocked": true,
      "metadata": {},
      "br_data": {
        "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
        "ie": "string",
        "ie_exempt": true,
        "im": "string",
        "suframa": "string",
        "tax_regime": "string",
        "cnae_primary": "string",
        "cnae_secondary": [
          "string"
        ],
        "nire": "string",
        "pix_key": "string",
        "pix_key_type": "string",
        "address_number": "string",
        "address_district": "string"
      },
      "us_data": {
        "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
        "w9_on_file": true,
        "w9_received_date": "2019-08-24",
        "naics_code": "string",
        "sic_code": "string",
        "tax_classification": "string",
        "sales_tax_exempt": true,
        "sales_tax_exempt_certificate": "string",
        "sales_tax_exempt_expiry": "2019-08-24",
        "resale_certificate": "string",
        "state_tax_id": "string",
        "state_of_incorporation": "string",
        "duns_number": "string",
        "cage_code": "string",
        "bank_name": "string",
        "routing_number": "string",
        "ach_authorized": true,
        "ach_authorization_date": "2019-08-24"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "pagination": {
    "limit": 0,
    "has_next_page": true,
    "has_previous_page": true,
    "current_query_cursor": "string",
    "current_page_cursor": "string",
    "next_cursor": "string",
    "previous_cursor": "string"
  },
  "meta": {
    "filters": {},
    "search": "string",
    "sort": {
      "field": "string",
      "order": "asc"
    }
  }
}

{
  "statusCode": 404,
  "message": "Customer not found",
  "error": "Not Found",
  "code": "CUSTOMER_NOT_FOUND"
}

{
  "statusCode": 404,
  "message": "Customer not found",
  "error": "Not Found",
  "code": "CUSTOMER_NOT_FOUND"
}

{
  "statusCode": 404,
  "message": "Customer not found",
  "error": "Not Found",
  "code": "CUSTOMER_NOT_FOUND"
}

Listar clientes

Authorization

Query Parameters

Response Body

200application/json

401application/json

403application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`