biterp

Listar mapeamentos de entidade da integracao

GET
/integration-entity-mappings

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).

tenant_integration_id?string

Exact match for "tenant_integration_id" (UUID)

Formatuuid
tenant_integration_id[neq]?string

Not equal filter for "tenant_integration_id" (UUID)

Formatuuid
entity_type?string

Exact match for "entity_type" (string)

entity_type[neq]?string

Not equal filter for "entity_type" (string)

entity_type[contains]?string

Contains filter for "entity_type"

entity_type[not_contains]?string

Does not contain filter for "entity_type"

sync_status?string

Exact match for "sync_status" (string)

sync_status[neq]?string

Not equal filter for "sync_status" (string)

sync_status[contains]?string

Contains filter for "sync_status"

sync_status[not_contains]?string

Does not contain filter for "sync_status"

mapping_origin?string

Exact match for "mapping_origin" (string)

mapping_origin[neq]?string

Not equal filter for "mapping_origin" (string)

mapping_origin[contains]?string

Contains filter for "mapping_origin"

mapping_origin[not_contains]?string

Does not contain filter for "mapping_origin"

internal_entity_id?string

Exact match for "internal_entity_id" (UUID)

Formatuuid
internal_entity_id[neq]?string

Not equal filter for "internal_entity_id" (UUID)

Formatuuid
external_entity_id?string

Exact match for "external_entity_id" (string)

external_entity_id[neq]?string

Not equal filter for "external_entity_id" (string)

external_entity_id[contains]?string

Contains filter for "external_entity_id"

external_entity_id[not_contains]?string

Does not contain filter for "external_entity_id"

created_at?string

Exact match for "created_at" (ISO 8601 date (YYYY-MM-DD))

created_at[neq]?string

Not equal filter for "created_at" (ISO 8601 date (YYYY-MM-DD))

created_at[gt]?string

Greater than filter for "created_at" (ISO 8601 date (YYYY-MM-DD))

created_at[gte]?string

Greater than or equal filter for "created_at" (ISO 8601 date (YYYY-MM-DD))

created_at[lt]?string

Less than filter for "created_at" (ISO 8601 date (YYYY-MM-DD))

created_at[lte]?string

Less than or equal filter for "created_at" (ISO 8601 date (YYYY-MM-DD))

last_synced_at?string

Exact match for "last_synced_at" (ISO 8601 date (YYYY-MM-DD))

last_synced_at[neq]?string

Not equal filter for "last_synced_at" (ISO 8601 date (YYYY-MM-DD))

last_synced_at[gt]?string

Greater than filter for "last_synced_at" (ISO 8601 date (YYYY-MM-DD))

last_synced_at[gte]?string

Greater than or equal filter for "last_synced_at" (ISO 8601 date (YYYY-MM-DD))

last_synced_at[lt]?string

Less than filter for "last_synced_at" (ISO 8601 date (YYYY-MM-DD))

last_synced_at[lte]?string

Less than or equal filter for "last_synced_at" (ISO 8601 date (YYYY-MM-DD))

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://api.biterp.ai/integration-entity-mappings"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "tenant_integration_id": "d6b73a49-9dc3-4a54-a0c4-d522200dbe7e",
      "entity_type": "string",
      "internal_entity_id": "a313f23c-5a95-4434-996d-2e8c765a949e",
      "external_entity_id": "string",
      "mapping_origin": "manual",
      "sync_status": "synced",
      "metadata": {},
      "last_synced_at": "2019-08-24T14:15:22Z",
      "created_by_user_id": "string",
      "updated_by_user_id": "string",
      "deleted_by_user_id": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "deleted_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"
}