List executors

GET

/orgs/connections/executors/list/for_coordinator/v1

GET

/orgs/connections/executors/list/for_coordinator/v1

import { ChrtClient } from "@chrt-inc/typescript-sdk";
async function main() {
    const client = new ChrtClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.orgs.connections.listExecutorsForCoordinatorV1({});
}
main();

{
  "items": [
    {
      "coordinator_executor_connection": {
        "_id": "string",
        "coordinator_org_id": "string",
        "schema_version": 1,
        "auto_assign_enabled": true,
        "connected": false,
        "coordinator_customer_id_for_executor_stripe_connect_account": "string",
        "executor_org_id": "string",
        "off_chrt_executor_org_data_id": "string"
      },
      "executor_org_public_data": {
        "_id": "string",
        "name": "string",
        "org_id": "string",
        "org_type": "provider",
        "schema_version": 1,
        "description": "string",
        "email_address": "string",
        "handle": "string",
        "industry": "string",
        "org_public_data_s3_object_metadata_ids": [
          "string"
        ],
        "phone_number": "string",
        "street_address": {
          "geometry": {
            "bbox": [
              "string"
            ],
            "coordinates": [
              "string"
            ],
            "type": "string"
          },
          "type": "string",
          "bbox": [
            "string"
          ],
          "id": 1,
          "properties": {
            "address": "string",
            "name": "string"
          }
        }
      },
      "off_chrt_executor_org_data": {
        "_id": "string",
        "created_by_user_id": "string",
        "name": "string",
        "org_type": "provider",
        "owned_by_org_id": "string",
        "schema_version": 1,
        "air_waybill_prefix": "string",
        "email_address": "string",
        "industry": "string",
        "phone_number": "string",
        "street_address": {
          "geometry": {
            "bbox": [
              "string"
            ],
            "coordinates": [
              "string"
            ],
            "type": "string"
          },
          "type": "string",
          "bbox": [
            "string"
          ],
          "id": 1,
          "properties": {
            "address": "string",
            "name": "string"
          }
        }
      }
    }
  ],
  "total_count": 1
}

Lists the caller’s executor connections with filtering, pagination, and identity search. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (CoordinatorExecutorConnectionsForCoordinatorListRes)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

searchstring or nullOptional

Search by organization identity details

pageintegerOptional>=1Defaults to 1

page_sizeintegerOptional1-100Defaults to 20

filter_connection_idslist of strings or nullOptional

Filter by selected connection ids

filter_auto_assign_enabledboolean or nullOptional

Filter by executor auto-assign consent

filter_connectedboolean or nullOptional

Filter by connection status

Response

Successful Response

itemslist of objects

total_countinteger

Errors

422

Unprocessable Entity Error