> ## Documentation Index > Fetch the complete documentation index at: https://docs.effectiveai.app/llms.txt > Use this file to discover all available pages before exploring further. # List carrier groups > Browse the shared carrier-group directory or search by name or exact external identifier. Returns managed IDs, names and registered identifiers; merged groups are omitted. Ordered by name ascending (database collation), then managed ID. Uses live keyset pagination, not relevance ranking or a snapshot; renames and merges can change traversal. Repeat filters and limit with nextCursor, which is bound to the caller and query and expires 24 hours after the first page. To inspect members, use GET /carriers?group={id}. Read-only and safe to retry; responses are private, no-store. ## OpenAPI ````yaml /openapi.json get /carrier-groups openapi: 3.0.3 info: title: Effective API version: 2.0.0 description: The public Effective REST API. Authenticate using an Effective API key. servers: - url: https://effectiveai.app/api/v2 description: Production security: - bearerAuth: [] paths: /carrier-groups: get: tags: - Carrier groups summary: List carrier groups description: >- Browse the shared carrier-group directory or search by name or exact external identifier. Returns managed IDs, names and registered identifiers; merged groups are omitted. Ordered by name ascending (database collation), then managed ID. Uses live keyset pagination, not relevance ranking or a snapshot; renames and merges can change traversal. Repeat filters and limit with nextCursor, which is bound to the caller and query and expires 24 hours after the first page. To inspect members, use GET /carriers?group={id}. Read-only and safe to retry; responses are private, no-store. operationId: listCarrierGroups parameters: - schema: type: string minLength: 1 maxLength: 200 description: Case-insensitive literal substring of the group name. required: false description: Case-insensitive literal substring of the group name. name: q in: query - schema: type: string maxLength: 220 description: >- Exact external scheme:value lookup, for example naic_group:785. Preserves code padding. Combined with q using AND; an unknown identifier returns an empty list. required: false description: >- Exact external scheme:value lookup, for example naic_group:785. Preserves code padding. Combined with q using AND; an unknown identifier returns an empty list. name: identifier in: query - schema: type: integer minimum: 1 maximum: 200 default: 50 description: Maximum number of items to return (1-200). required: false description: Maximum number of items to return (1-200). name: limit in: query - schema: type: string minLength: 1 maxLength: 128 description: >- Opaque nextCursor from this operation. Repeat the same filters and limit. Expires 24 hours after the first page. required: false description: >- Opaque nextCursor from this operation. Repeat the same filters and limit. Expires 24 hours after the first page. name: cursor in: query responses: '200': description: One page of carrier groups; nextCursor is null when exhausted. content: application/json: schema: $ref: '#/components/schemas/V2CarrierGroupList' '400': description: >- invalid_request for unknown, invalid or repeated scalar parameters; invalid_cursor for a malformed, expired or mismatched continuation. Restart without cursor. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '401': description: Missing or invalid credentials, or credential scope denied. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '403': description: The credential does not permit this operation. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '500': description: Unexpected server error. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '503': description: >- Dependency unavailable. Retry the same request after Retry-After seconds. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' security: - bearerAuth: [] components: schemas: V2CarrierGroupList: type: object properties: carrierGroups: type: array items: $ref: '#/components/schemas/V2CarrierGroup' nextCursor: type: string nullable: true description: Cursor for the next page, or null on the last page. required: - carrierGroups - nextCursor V2CodedError: allOf: - $ref: '#/components/schemas/V2Error' - type: object properties: code: type: string minLength: 1 description: Stable error code. Clients must tolerate unknown future codes. details: type: array items: type: object properties: location: type: string enum: - path - query - header - body path: type: array items: type: string maxLength: 64 maxItems: 12 code: type: string enum: - required - invalid_type - invalid_value - unknown_field message: type: string minLength: 1 maxLength: 200 required: - location - path - code - message minItems: 1 maxItems: 20 description: Bounded safe validation issues; may omit some invalid fields. requestId: type: string minLength: 1 maxLength: 128 description: >- Existing server correlation for this HTTP attempt, when available. required: - code V2CarrierGroup: type: object properties: id: type: string description: Canonical Effective-managed carrier_group_ ID. name: type: string description: Directory name of the carrier group. identifiers: type: array items: type: object properties: scheme: type: string value: type: string required: - scheme - value additionalProperties: false description: >- Registered external identifiers, such as naic_group. May be empty; these are not Effective IDs. required: - id - name - identifiers V2Error: type: object properties: error: type: string minLength: 1 description: Human-readable explanation of the failure. required: - error securitySchemes: bearerAuth: type: http scheme: bearer description: 'Effective API key. Send Authorization: Bearer sk-eai-...' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.